907ad84f46
There have been proposals to add more language aliases to markdown.kak (#4592) and allow users to add their own aliases (#4489). To recap: various markdown implementations allow specifying aliases for languages. For example, here is a code block that should be highlighted as filetype "haskell" but isn't: ```hs -- highlight as haskell ``` There are lots of aliases out in the wild - "pygmentize -L" lists some but I don't think there is a canonical list. Today we have a hardcoded list of supported filetypes. This is hard to mainta, extend, and it can impact performance. This patch simply attempts to load the module "hs" and the shared highlighter "hs". This means that users can use this (obvious?) snippet to add their own aliases: provide-module hs %{ require-module haskell add-highlighter shared/hs ref haskell } Untrusted Markdown files can load arbitrary modules, but that was already true before, and modules are assumed to be trusted anyway. Since language highlighters are now loaded *after* the generic code-block highlighter, we need to make sure the language highlighters take precedence. Do this by making them sub-regions of the generic one. Closes #4489 This improves performance on the [5MB Markdown file](https://github.com/mawww/kakoune/issues/4685#issuecomment-1208129806). $ HOME=$PWD hyperfine -w 1 'git checkout HEAD'{~,}' -- :/rc/filetype/markdown.kak && ./kak.opt big_markdown.md -e "hook global NormalIdle .* quit" -ui dummy' Benchmark 1: git checkout HEAD~ -- :/rc/filetype/markdown.kak && ./kak.opt big_markdown.md -e "hook global NormalIdle .* quit" -ui dummy Time (mean ± σ): 3.225 s ± 0.074 s [User: 3.199 s, System: 0.027 s] Range (min … max): 3.099 s … 3.362 s 10 runs Benchmark 2: git checkout HEAD -- :/rc/filetype/markdown.kak && ./kak.opt big_markdown.md -e "hook global NormalIdle .* quit" -ui dummy Time (mean ± σ): 1.181 s ± 0.030 s [User: 1.162 s, System: 0.021 s] Range (min … max): 1.149 s … 1.234 s 10 runs Summary 'git checkout HEAD -- :/rc/filetype/markdown.kak && ./kak.opt big_markdown.md -e "hook global NormalIdle .* quit" -ui dummy' ran 2.73 ± 0.09 times faster than 'git checkout HEAD~ -- :/rc/filetype/markdown.kak && ./kak.opt big_markdown.md -e "hook global NormalIdle .* quit" -ui dummy' (These numbers depend on another optimization.)
131 lines
5.6 KiB
Plaintext
131 lines
5.6 KiB
Plaintext
# http://daringfireball.net/projects/markdown
|
|
# ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
|
|
|
|
# Detection
|
|
# ‾‾‾‾‾‾‾‾‾
|
|
|
|
hook global BufCreate .*[.](markdown|md|mkd) %{
|
|
set-option buffer filetype markdown
|
|
}
|
|
|
|
# Initialization
|
|
# ‾‾‾‾‾‾‾‾‾‾‾‾‾‾
|
|
|
|
hook global WinSetOption filetype=markdown %{
|
|
require-module markdown
|
|
|
|
hook window ModeChange pop:insert:.* -group markdown-trim-indent markdown-trim-indent
|
|
hook window InsertChar \n -group markdown-insert markdown-insert-on-new-line
|
|
hook window InsertChar \n -group markdown-indent markdown-indent-on-new-line
|
|
hook -once -always window WinSetOption filetype=.* %{ remove-hooks window markdown-.+ }
|
|
}
|
|
|
|
hook -group markdown-load-languages global WinSetOption filetype=markdown %{
|
|
markdown-load-languages '%'
|
|
}
|
|
|
|
hook -group markdown-load-languages global WinSetOption filetype=markdown %{
|
|
hook -group markdown-load-languages window NormalIdle .* %{markdown-load-languages gtGbGl}
|
|
hook -group markdown-load-languages window InsertIdle .* %{markdown-load-languages gtGbGl}
|
|
}
|
|
|
|
|
|
hook -group markdown-highlight global WinSetOption filetype=markdown %{
|
|
add-highlighter window/markdown ref markdown
|
|
hook -once -always window WinSetOption filetype=.* %{ remove-highlighter window/markdown }
|
|
}
|
|
|
|
|
|
provide-module markdown %{
|
|
|
|
# Highlighters
|
|
# ‾‾‾‾‾‾‾‾‾‾‾‾
|
|
|
|
add-highlighter shared/markdown regions
|
|
add-highlighter shared/markdown/inline default-region regions
|
|
add-highlighter shared/markdown/inline/text default-region group
|
|
|
|
add-highlighter shared/markdown/listblock region ^\h*[-*]\s ^(?=\S) regions
|
|
add-highlighter shared/markdown/listblock/g default-region group
|
|
add-highlighter shared/markdown/listblock/g/ ref markdown/inline
|
|
add-highlighter shared/markdown/listblock/g/marker regex ^\h*([-*])\s 1:bullet
|
|
|
|
add-highlighter shared/markdown/codeblock region -match-capture \
|
|
^(\h*)```\h* \
|
|
^(\h*)```\h*$ \
|
|
regions
|
|
add-highlighter shared/markdown/codeblock/ default-region fill meta
|
|
add-highlighter shared/markdown/listblock/codeblock region -match-capture \
|
|
^(\h*)```\h* \
|
|
^(\h*)```\h*$ \
|
|
regions
|
|
add-highlighter shared/markdown/listblock/codeblock/ default-region fill meta
|
|
add-highlighter shared/markdown/codeline region "^( {4}|\t)" "$" fill meta
|
|
|
|
# https://spec.commonmark.org/0.29/#link-destination
|
|
add-highlighter shared/markdown/angle_bracket_url region (?<=<)([a-z]+://|(mailto|magnet|xmpp):) (?!\\).(?=>)|\n fill link
|
|
add-highlighter shared/markdown/inline/url region -recurse \( ([a-z]+://|(mailto|magnet|xmpp):) (?!\\).(?=\))|\s fill link
|
|
add-highlighter shared/markdown/listblock/angle_bracket_url region (?<=<)([a-z]+://|(mailto|magnet|xmpp):) (?!\\).(?=>)|\n fill link
|
|
|
|
try %{
|
|
require-module html
|
|
add-highlighter shared/markdown/inline/tag region (?i)</?[a-z][a-z0-9-]*\s*([a-z_:]|(?=>)) > ref html/tag
|
|
}
|
|
|
|
add-highlighter shared/markdown/inline/code region -match-capture (`+) (`+) fill mono
|
|
|
|
# Setext-style header
|
|
add-highlighter shared/markdown/inline/text/ regex (\A|^\n)[^\n]+\n={2,}\h*\n\h*$ 0:title
|
|
add-highlighter shared/markdown/inline/text/ regex (\A|^\n)[^\n]+\n-{2,}\h*\n\h*$ 0:header
|
|
|
|
# Atx-style header
|
|
add-highlighter shared/markdown/inline/text/ regex ^#[^\n]* 0:header
|
|
|
|
add-highlighter shared/markdown/inline/text/ regex (?<!\*)(\*([^\s*]|([^\s*](\n?[^\n*])*[^\s*]))\*)(?!\*) 1:+i
|
|
add-highlighter shared/markdown/inline/text/ regex (?<!_)(_([^\s_]|([^\s_](\n?[^\n_])*[^\s_]))_)(?!_) 1:+i
|
|
add-highlighter shared/markdown/inline/text/ regex (?<!\*)(\*\*([^\s*]|([^\s*](\n?[^\n*])*[^\s*]))\*\*)(?!\*) 1:+b
|
|
add-highlighter shared/markdown/inline/text/ regex (?<!_)(__([^\s_]|([^\s_](\n?[^\n_])*[^\s_]))__)(?!_) 1:+b
|
|
add-highlighter shared/markdown/inline/text/ regex ^\h*(>\h*)+ 0:comment
|
|
add-highlighter shared/markdown/inline/text/ regex "\H( {2,})$" 1:+r@meta
|
|
|
|
# Commands
|
|
# ‾‾‾‾‾‾‾‾
|
|
|
|
define-command markdown-load-languages -params 1 %{
|
|
evaluate-commands -draft %{ try %{
|
|
execute-keys "%arg{1}s```\h*\{?[.=]?\K\w+<ret>" # }
|
|
evaluate-commands -itersel %{ try %{
|
|
require-module %val{selection}
|
|
add-highlighter "shared/markdown/codeblock/%val{selection}" region -match-capture "^(\h*)```\h*(%val{selection}\b|\{[.=]?%val{selection}\})" ^(\h*)``` regions
|
|
add-highlighter "shared/markdown/codeblock/%val{selection}/" default-region fill meta
|
|
add-highlighter "shared/markdown/codeblock/%val{selection}/inner" region \A\h*```[^\n]*\K (?=```) ref %val{selection}
|
|
add-highlighter "shared/markdown/listblock/codeblock/%val{selection}" region -match-capture "^(\h*)```\h*(%val{selection}\b|\{[.=]?%val{selection}\})" ^(\h*)``` regions
|
|
add-highlighter "shared/markdown/listblock/codeblock/%val{selection}/" default-region fill meta
|
|
add-highlighter "shared/markdown/listblock/codeblock/%val{selection}/inner" region \A\h*```[^\n]*\K (?=```) ref %val{selection}
|
|
}}
|
|
}}
|
|
}
|
|
|
|
define-command -hidden markdown-trim-indent %{
|
|
evaluate-commands -no-hooks -draft -itersel %{
|
|
execute-keys x
|
|
# remove trailing white spaces
|
|
try %{ execute-keys -draft s \h + $ <ret> d }
|
|
}
|
|
}
|
|
|
|
define-command -hidden markdown-insert-on-new-line %{
|
|
try %{ execute-keys -draft -itersel k x s ^\h*\K((>\h*)+([*+-]\h)?|(>\h*)*[*+-]\h)\h* <ret> y gh j P }
|
|
}
|
|
|
|
define-command -hidden markdown-indent-on-new-line %{
|
|
evaluate-commands -draft -itersel %{
|
|
# preserve previous line indent
|
|
try %{ execute-keys -draft <semicolon> K <a-&> }
|
|
# remove trailing white spaces
|
|
try %{ execute-keys -draft k x s \h+$ <ret> d }
|
|
}
|
|
}
|
|
|
|
}
|