Expand markdown-ts-mode and add code block support for javascript
- Define new faces and use them in place of font-lock faces - Add more fontification, add a new feature for headings. - Remove fontification for code blocks, so embedeed parser can fontify them - Add experimental code block support for javascript by using tree-sitter setup from js-ts-mode. - Correctly setup markdown_inline with range settings. * lisp/textmodes/markdown-ts-mode.el: (markdown-ts--code-block-language-map): (markdown-ts-code-block-source-mode-map): New variables. (markdown-ts-faces): New group. (markdown-ts-delimiter): (markdown-ts-heading-1): (markdown-ts-setext-heading): (markdown-ts-heading-2): (markdown-ts-heading-3): (markdown-ts-heading-4): (markdown-ts-heading-5): (markdown-ts-heading-6): (markdown-ts-list-marker): (markdown-ts-block-quote): (markdown-ts-language-keyword): New faces. (markdown-ts--treesit-settings): (markdown-ts--configured-languages): New variables. (markdown-ts--harvest-treesit-configs): (markdown-ts--add-config-for-mode): (markdown-ts--convert-code-block-language): New functions. (markdown-ts--range-settings): New variable. (markdown-ts-setup): Setup range configuration. (markdown-ts-mode): Add heading feature.
This commit is contained in:
Yuan Fu
parent
23b957e128
commit
6f1e317764
1 changed files with 203 additions and 27 deletions
|
|
@ -34,6 +34,70 @@
|
|||
(declare-function treesit-node-type "treesit.c")
|
||||
(declare-function treesit-parser-create "treesit.c")
|
||||
|
||||
;;; Helper functions
|
||||
|
||||
(defvar markdown-ts--code-block-language-map
|
||||
'(("c++" . cpp) ("c#" . c-sharp))
|
||||
"Alist mapping code block language names to tree-sitter languages.
|
||||
|
||||
Keys should be strings, and values should be language symbols.
|
||||
|
||||
For example, \"c++\" in
|
||||
|
||||
```c++
|
||||
int main() {
|
||||
return 0;
|
||||
}
|
||||
```
|
||||
|
||||
maps to tree-sitter language `cpp'.")
|
||||
|
||||
(defvar markdown-ts-code-block-source-mode-map
|
||||
'((javascript . js-ts-mode))
|
||||
"An alist of supported code block languages and their major mode.")
|
||||
|
||||
;;; Faces
|
||||
|
||||
(defgroup markdown-ts-faces nil
|
||||
"Faces used in Markdown TS Mode."
|
||||
:group 'markdown-ts-faces
|
||||
:group 'faces)
|
||||
|
||||
(defface markdown-ts-delimiter '((t (:inherit shadow)))
|
||||
"Face for the # before headings.")
|
||||
|
||||
(defface markdown-ts-heading-1 '((t (:inherit outline-1)))
|
||||
"Face for first level headings.")
|
||||
|
||||
(defface markdown-ts-setext-heading '((t (:inherit markdown-ts-heading-1)))
|
||||
"Face for setext headings (headings underlined by === or ---).")
|
||||
|
||||
(defface markdown-ts-heading-2 '((t (:inherit outline-2)))
|
||||
"Face for second level headings.")
|
||||
|
||||
(defface markdown-ts-heading-3 '((t (:inherit outline-3)))
|
||||
"Face for third level headings.")
|
||||
|
||||
(defface markdown-ts-heading-4 '((t (:inherit outline-4)))
|
||||
"Face for fourth level headings.")
|
||||
|
||||
(defface markdown-ts-heading-5 '((t (:inherit outline-5)))
|
||||
"Face for fifth level headings.")
|
||||
|
||||
(defface markdown-ts-heading-6 '((t (:inherit outline-6)))
|
||||
"Face for sixth level headings.")
|
||||
|
||||
(defface markdown-ts-list-marker '((t (:inherit font-lock-keyword-face)))
|
||||
"Face for list markers like - and *.")
|
||||
|
||||
(defface markdown-ts-block-quote '((t (:inherit font-lock-string-face)))
|
||||
"Face for block quotes.")
|
||||
|
||||
(defface markdown-ts-language-keyword '((t (:inherit font-lock-keyword-face)))
|
||||
"Face for the language keyword for code blocks.")
|
||||
|
||||
;;; Font-lock
|
||||
|
||||
(defvar markdown-ts--treesit-settings
|
||||
(treesit-font-lock-rules
|
||||
:language 'markdown
|
||||
|
|
@ -41,35 +105,66 @@
|
|||
:feature 'delimiter
|
||||
'([ "[" "]" "(" ")" ] @shadow)
|
||||
|
||||
:language 'markdown
|
||||
:feature 'heading
|
||||
'((atx_heading (atx_h1_marker)) @markdown-ts-heading-1
|
||||
(atx_heading (atx_h2_marker)) @markdown-ts-heading-2
|
||||
(atx_heading (atx_h3_marker)) @markdown-ts-heading-3
|
||||
(atx_heading (atx_h4_marker)) @markdown-ts-heading-4
|
||||
(atx_heading (atx_h5_marker)) @markdown-ts-heading-5
|
||||
(atx_heading (atx_h6_marker)) @markdown-ts-heading-6
|
||||
(setext_heading) @markdown-ts-setext-heading)
|
||||
|
||||
:language 'markdown
|
||||
:feature 'heading
|
||||
:override 'prepend
|
||||
'((atx_h1_marker) @markdown-ts-delimiter
|
||||
(atx_h2_marker) @markdown-ts-delimiter
|
||||
(atx_h3_marker) @markdown-ts-delimiter
|
||||
(atx_h4_marker) @markdown-ts-delimiter
|
||||
(atx_h5_marker) @markdown-ts-delimiter
|
||||
(atx_h6_marker) @markdown-ts-delimiter)
|
||||
|
||||
:language 'markdown
|
||||
:feature 'paragraph
|
||||
'([((setext_heading) @font-lock-keyword-face)
|
||||
((atx_heading) @font-lock-keyword-face)
|
||||
((thematic_break) @shadow)
|
||||
((indented_code_block) @font-lock-string-face)
|
||||
(list_item (list_marker_star) @font-lock-keyword-face)
|
||||
(list_item (list_marker_plus) @font-lock-keyword-face)
|
||||
(list_item (list_marker_minus) @font-lock-keyword-face)
|
||||
(list_item (list_marker_dot) @font-lock-keyword-face)
|
||||
(fenced_code_block (fenced_code_block_delimiter) @font-lock-doc-face)
|
||||
(fenced_code_block (code_fence_content) @font-lock-string-face)
|
||||
((block_quote_marker) @font-lock-string-face)
|
||||
(block_quote (paragraph) @font-lock-string-face)
|
||||
(block_quote (block_quote_marker) @font-lock-string-face)
|
||||
])
|
||||
'(((thematic_break) @markdown-ts-delimiter)
|
||||
((indented_code_block) @font-lock-string-face)
|
||||
(list_item (list_marker_star) @markdown-ts-list-marker)
|
||||
(list_item (list_marker_plus) @markdown-ts-list-marker)
|
||||
(list_item (list_marker_minus) @markdown-ts-list-marker)
|
||||
(list_item (list_marker_dot) @markdown-ts-list-marker)
|
||||
|
||||
(block_quote) @markdown-ts-block-quote)
|
||||
|
||||
:language 'markdown
|
||||
:feature 'paragraph
|
||||
:override 'prepend
|
||||
'((block_quote_marker) @markdown-ts-delimiter
|
||||
(fenced_code_block_delimiter) @markdown-ts-delimiter
|
||||
(fenced_code_block
|
||||
(info_string (language) @markdown-ts-language-keyword))
|
||||
(block_quote
|
||||
(block_quote_marker) @markdown-ts-delimiter
|
||||
(paragraph (inline (block_continuation) @markdown-ts-delimiter))))
|
||||
|
||||
:language 'markdown-inline
|
||||
:feature 'paragraph-inline
|
||||
'([
|
||||
((image_description) @link)
|
||||
((link_destination) @font-lock-string-face)
|
||||
((code_span) @font-lock-string-face)
|
||||
((emphasis) @underline)
|
||||
((strong_emphasis) @bold)
|
||||
(inline_link (link_text) @link)
|
||||
(inline_link (link_destination) @font-lock-string-face)
|
||||
(shortcut_link (link_text) @link)])))
|
||||
'(((image_description) @link)
|
||||
((link_destination) @font-lock-string-face)
|
||||
((code_span) @font-lock-string-face)
|
||||
((emphasis) @italic)
|
||||
((strong_emphasis) @bold)
|
||||
(inline_link (link_text) @link)
|
||||
(inline_link (link_destination) @font-lock-string-face)
|
||||
(shortcut_link (link_text) @link))
|
||||
|
||||
:language 'markdown-inline
|
||||
:feature 'paragraph-inline
|
||||
:override 'append
|
||||
'((emphasis_delimiter) @markdown-ts-delimiter)
|
||||
))
|
||||
|
||||
;;; Imenu
|
||||
|
||||
(defun markdown-ts-imenu-node-p (node)
|
||||
"Check if NODE is a valid entry to imenu."
|
||||
|
|
@ -80,21 +175,102 @@
|
|||
"Return an imenu entry if NODE is a valid header."
|
||||
(let ((name (treesit-node-text node)))
|
||||
(if (markdown-ts-imenu-node-p node)
|
||||
(thread-first (treesit-node-parent node)(treesit-node-text))
|
||||
(thread-first (treesit-node-parent node) (treesit-node-text))
|
||||
name)))
|
||||
|
||||
;;; Code blocks
|
||||
|
||||
(defvar-local markdown-ts--configured-languages nil
|
||||
"A list of languages that have been setup in this buffer.
|
||||
|
||||
When a code block of a language appear, `markdown-ts-mode' loads
|
||||
language setups like font-lock and indentation for that language, and
|
||||
add that language to this list.")
|
||||
|
||||
(defun markdown-ts--harvest-treesit-configs (mode)
|
||||
"Harvest tree-sitter configs from MODE.
|
||||
Return a plist with the following keys and value:
|
||||
|
||||
:font-lock (from `treesit-font-lock-settings')
|
||||
:simple-indent (from `treesit-simple-indent-rules')
|
||||
:range (from `treesit-range-settings')"
|
||||
(with-temp-buffer
|
||||
(funcall mode)
|
||||
(list :font-lock treesit-font-lock-settings
|
||||
:simple-indent treesit-simple-indent-rules
|
||||
:range treesit-range-settings)))
|
||||
|
||||
(defun markdown-ts--add-config-for-mode (language mode)
|
||||
"Add configurations for LANGUAGE from MODE to current buffer.
|
||||
|
||||
Configuration includes font-lock and indent. For font-lock rules, use
|
||||
the same features enabled in MODE."
|
||||
(let ((configs (markdown-ts--harvest-treesit-configs mode)))
|
||||
(ignore language) ; We might make use of this later.
|
||||
(setq treesit-font-lock-settings
|
||||
(append treesit-font-lock-settings
|
||||
;; Get all the font-lock settings, including ones that
|
||||
;; don't pertain to LANGUAGE. This way we get jsdoc
|
||||
;; from js-ts-mode, for example.
|
||||
(plist-get configs :font-lock)))
|
||||
(setq treesit-simple-indent-rules
|
||||
(append treesit-simple-indent-rules
|
||||
;; Similarly, get all indent rules.
|
||||
(plist-get configs :simple-indent)))
|
||||
(setq treesit-range-settings
|
||||
(append treesit-range-settings
|
||||
(plist-get configs :range)))
|
||||
(setq-local indent-line-function #'treesit-indent)
|
||||
(setq-local indent-region-function #'treesit-indent-region)))
|
||||
|
||||
(defun markdown-ts--convert-code-block-language (node)
|
||||
"Convert NODE to a language for the code block."
|
||||
(let* ((lang-string (alist-get (treesit-node-text node)
|
||||
markdown-ts--code-block-language-map
|
||||
(treesit-node-text node) nil #'equal))
|
||||
(lang (intern (downcase lang-string))))
|
||||
;; FIXME: Kind of a hack here: we use this function as a hook for
|
||||
;; loading up configs for the language for the code block on-demand.
|
||||
(unless (memq lang markdown-ts--configured-languages)
|
||||
(let ((mode (alist-get lang markdown-ts-code-block-source-mode-map)))
|
||||
(when mode
|
||||
(markdown-ts--add-config-for-mode lang mode)
|
||||
(push lang markdown-ts--configured-languages))))
|
||||
lang))
|
||||
|
||||
(defun markdown-ts--range-settings ()
|
||||
"Return range settings for `markdown-ts-mode'."
|
||||
(treesit-range-rules
|
||||
:embed 'markdown-inline
|
||||
:host 'markdown
|
||||
:range-fn #'treesit-range-fn-exclude-children
|
||||
'((inline) @markdown-inline)
|
||||
|
||||
:embed 'html
|
||||
:host 'markdown
|
||||
'((html_block) @html)
|
||||
|
||||
:embed #'markdown-ts--convert-code-block-language
|
||||
:host 'markdown
|
||||
:local t
|
||||
'((fenced_code_block (info_string (language) @language)
|
||||
(code_fence_content) @content))))
|
||||
|
||||
;;; Major mode
|
||||
|
||||
(defun markdown-ts-setup ()
|
||||
"Setup treesit for `markdown-ts-mode'."
|
||||
(setq-local treesit-font-lock-settings markdown-ts--treesit-settings)
|
||||
(setq-local treesit-range-settings (markdown-ts--range-settings))
|
||||
(treesit-major-mode-setup))
|
||||
|
||||
;;;###autoload
|
||||
(define-derived-mode markdown-ts-mode text-mode "Markdown"
|
||||
"Major mode for editing Markdown using tree-sitter grammar."
|
||||
(setq-local font-lock-defaults nil
|
||||
treesit-font-lock-feature-list '((delimiter)
|
||||
(paragraph)
|
||||
(paragraph-inline)))
|
||||
treesit-font-lock-feature-list '((delimiter heading)
|
||||
(paragraph)
|
||||
(paragraph-inline)))
|
||||
|
||||
(setq-local treesit-simple-imenu-settings
|
||||
`(("Headings" markdown-ts-imenu-node-p nil markdown-ts-imenu-name-function)))
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue