mirror of
https://github.com/mawww/kakoune.git
synced 2024-11-30 03:34:20 +03:00
6b6577d8b9
OCaml does not have line comments, and as far as I can tell neither does Coq. Setting it to '' (like markdown and html do) throws an error that can be handled or displayed instead of inserting the default '#'.
209 lines
6.6 KiB
Plaintext
209 lines
6.6 KiB
Plaintext
# Line comments
|
|
# If the language has no line comments, set to ''
|
|
declare-option -docstring "characters inserted at the beginning of a commented line" \
|
|
str comment_line '#'
|
|
|
|
# Block comments
|
|
declare-option -docstring "characters inserted before a commented block" \
|
|
str comment_block_begin
|
|
declare-option -docstring "characters inserted after a commented block" \
|
|
str comment_block_end
|
|
|
|
# Default comments for all languages
|
|
hook global BufSetOption filetype=asciidoc %{
|
|
set-option buffer comment_line '//'
|
|
set-option buffer comment_block_begin '////'
|
|
set-option buffer comment_block_end '////'
|
|
}
|
|
|
|
hook global BufSetOption filetype=(c|cpp|dart|gluon|go|java|javascript|objc|php|rust|sass|scala|scss|swift|typescript) %{
|
|
set-option buffer comment_line '//'
|
|
set-option buffer comment_block_begin '/*'
|
|
set-option buffer comment_block_end '*/'
|
|
}
|
|
|
|
hook global BufSetOption filetype=(cabal|haskell|moon|idris|elm|dhall|purescript) %{
|
|
set-option buffer comment_line '--'
|
|
set-option buffer comment_block_begin '{-'
|
|
set-option buffer comment_block_end '-}'
|
|
}
|
|
|
|
hook global BufSetOption filetype=clojure %{
|
|
set-option buffer comment_line '#_'
|
|
set-option buffer comment_block_begin '(comment '
|
|
set-option buffer comment_block_end ')'
|
|
}
|
|
|
|
hook global BufSetOption filetype=janet %{
|
|
set-option buffer comment_line '#'
|
|
set-option buffer comment_block_begin '(comment '
|
|
set-option buffer comment_block_end ')'
|
|
}
|
|
|
|
hook global BufSetOption filetype=coffee %{
|
|
set-option buffer comment_block_begin '###'
|
|
set-option buffer comment_block_end '###'
|
|
}
|
|
|
|
hook global BufSetOption filetype=css %{
|
|
set-option buffer comment_line ''
|
|
set-option buffer comment_block_begin '/*'
|
|
set-option buffer comment_block_end '*/'
|
|
}
|
|
|
|
hook global BufSetOption filetype=d %{
|
|
set-option buffer comment_line '//'
|
|
set-option buffer comment_block_begin '/+'
|
|
set-option buffer comment_block_end '+/'
|
|
}
|
|
|
|
hook global BufSetOption filetype=(fennel|gas|ini) %{
|
|
set-option buffer comment_line ';'
|
|
}
|
|
|
|
hook global BufSetOption filetype=haml %{
|
|
set-option buffer comment_line '-#'
|
|
}
|
|
|
|
hook global BufSetOption filetype=(html|xml) %{
|
|
set-option buffer comment_line ''
|
|
set-option buffer comment_block_begin '<!--'
|
|
set-option buffer comment_block_end '-->'
|
|
}
|
|
|
|
hook global BufSetOption filetype=(latex|mercury) %{
|
|
set-option buffer comment_line '%'
|
|
}
|
|
|
|
hook global BufSetOption filetype=ledger %{
|
|
set-option buffer comment_line ';'
|
|
}
|
|
|
|
hook global BufSetOption filetype=(lisp|scheme) %{
|
|
set-option buffer comment_line ';'
|
|
set-option buffer comment_block_begin '#|'
|
|
set-option buffer comment_block_end '|#'
|
|
}
|
|
|
|
hook global BufSetOption filetype=lua %{
|
|
set-option buffer comment_line '--'
|
|
set-option buffer comment_block_begin '--[['
|
|
set-option buffer comment_block_end ']]'
|
|
}
|
|
|
|
hook global BufSetOption filetype=markdown %{
|
|
set-option buffer comment_line ''
|
|
set-option buffer comment_block_begin '[//]: # "'
|
|
set-option buffer comment_block_end '"'
|
|
}
|
|
|
|
hook global BufSetOption filetype=(ocaml|coq) %{
|
|
set-option buffer comment_line ''
|
|
set-option buffer comment_block_begin '(* '
|
|
set-option buffer comment_block_end ' *)'
|
|
}
|
|
|
|
hook global BufSetOption filetype=((free|object)?pascal|delphi) %{
|
|
set-option buffer comment_line '//'
|
|
set-option buffer comment_block_begin '{'
|
|
set-option buffer comment_block_end '}'
|
|
}
|
|
|
|
hook global BufSetOption filetype=perl %{
|
|
set-option buffer comment_block_begin '#['
|
|
set-option buffer comment_block_end ']'
|
|
}
|
|
|
|
hook global BufSetOption filetype=(pug|zig|cue) %{
|
|
set-option buffer comment_line '//'
|
|
}
|
|
|
|
hook global BufSetOption filetype=python %{
|
|
set-option buffer comment_block_begin "'''"
|
|
set-option buffer comment_block_end "'''"
|
|
}
|
|
|
|
hook global BufSetOption filetype=r %{
|
|
set-option buffer comment_line '#'
|
|
}
|
|
|
|
hook global BufSetOption filetype=ragel %{
|
|
set-option buffer comment_line '%%'
|
|
set-option buffer comment_block_begin '%%{'
|
|
set-option buffer comment_block_end '}%%'
|
|
}
|
|
|
|
hook global BufSetOption filetype=ruby %{
|
|
set-option buffer comment_block_begin '^begin='
|
|
set-option buffer comment_block_end '^=end'
|
|
}
|
|
|
|
define-command comment-block -docstring '(un)comment selections using block comments' %{
|
|
evaluate-commands %sh{
|
|
if [ -z "${kak_opt_comment_block_begin}" ] || [ -z "${kak_opt_comment_block_end}" ]; then
|
|
echo "fail \"The 'comment_block' options are empty, could not comment the selection\""
|
|
fi
|
|
}
|
|
evaluate-commands -save-regs '"/' -draft %{
|
|
# Keep non-empty selections
|
|
execute-keys <a-K>\A\s*\z<ret>
|
|
|
|
try %{
|
|
# Assert that the selection has been commented
|
|
set-register / "\A\Q%opt{comment_block_begin}\E.*\Q%opt{comment_block_end}\E\n*\z"
|
|
execute-keys "s<ret>"
|
|
# Uncomment it
|
|
set-register / "\A\Q%opt{comment_block_begin}\E|\Q%opt{comment_block_end}\E\n*\z"
|
|
execute-keys s<ret>d
|
|
} catch %{
|
|
# Comment the selection
|
|
set-register '"' "%opt{comment_block_begin}"
|
|
execute-keys P
|
|
set-register '"' "%opt{comment_block_end}"
|
|
execute-keys p
|
|
}
|
|
}
|
|
}
|
|
|
|
define-command comment-line -docstring '(un)comment selected lines using line comments' %{
|
|
evaluate-commands %sh{
|
|
if [ -z "${kak_opt_comment_line}" ]; then
|
|
echo "fail \"The 'comment_line' option is empty, could not comment the line\""
|
|
fi
|
|
}
|
|
evaluate-commands -save-regs '"/' -draft %{
|
|
# Select the content of the lines, without indentation
|
|
execute-keys <a-s>gi<a-l>
|
|
|
|
try %{
|
|
# Keep non-empty lines
|
|
execute-keys <a-K>\A\s*\z<ret>
|
|
}
|
|
|
|
try %{
|
|
set-register / "\A\Q%opt{comment_line}\E\h?"
|
|
|
|
try %{
|
|
# See if there are any uncommented lines in the selection
|
|
execute-keys -draft <a-K><ret>
|
|
|
|
# There are uncommented lines, so comment everything
|
|
set-register '"' "%opt{comment_line} "
|
|
align-selections-left
|
|
execute-keys P
|
|
} catch %{
|
|
# All lines were commented, so uncomment everything
|
|
execute-keys s<ret>d
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
define-command align-selections-left -docstring 'extend selections to the left to align with the leftmost selected column' %{
|
|
evaluate-commands %sh{
|
|
leftmost_column=$(echo "$kak_selections_desc" | tr ' ' '\n' | cut -d',' -f1 | cut -d'.' -f2 | sort -n | head -n1)
|
|
aligned_selections=$(echo "$kak_selections_desc" | sed -E "s/\.[0-9]+,/.$leftmost_column,/g")
|
|
echo "select $aligned_selections"
|
|
}
|
|
}
|