kakoune/rc/core/commenting.kak

## Characters that will be inserted at the beginning of a line to comment
decl str comment_line_chars "#"

## Characters that will be used to surround a selection with
decl str-list comment_selection_chars ""

## Default characters for all languages
hook global BufSetOption filetype=asciidoc %{
    set buffer comment_selection_chars '///:///'
}

hook global BufSetOption filetype=(c|cpp|go|java|javascript|objc|sass|scala|scss|swift) %{
    set buffer comment_line_chars '//'
    set buffer comment_selection_chars '/*:*/'
}

hook global BufSetOption filetype=(cabal|haskell|moon) %{
    set buffer comment_line_chars '--'
}

hook global BufSetOption filetype=clojure %{
    set buffer comment_line_chars '#_ '
    set buffer comment_selection_chars '(comment :)'
}

hook global BufSetOption filetype=coffee %{
    set buffer comment_selection_chars '###:###'
}

hook global BufSetOption filetype=css %{
    set buffer comment_line_chars ''
    set buffer comment_selection_chars '/*:*/'
}

hook global BufSetOption filetype=d %{
    set buffer comment_line_chars '//'
    set buffer comment_selection_chars '/+:+/'
}

hook global BufSetOption filetype=(gas|ini) %{
    set buffer comment_line_chars ';'
}

hook global BufSetOption filetype=haml %{
    set buffer comment_line_chars '-#'
}

hook global BufSetOption filetype=html %{
    set buffer comment_line_chars ''
    set buffer comment_selection_chars '<!--:-->'
}

hook global BufSetOption filetype=latex %{
    set buffer comment_line_chars '%'
}

hook global BufSetOption filetype=lisp %{
    set buffer comment_line_chars ';'
    set buffer comment_selection_chars '#|:|#'
}

hook global BufSetOption filetype=lua %{
    set buffer comment_line_chars '--'
    set buffer comment_selection_chars '--[[:]]'
}

hook global BufSetOption filetype=markdown %{
    set buffer comment_line_chars ''
    set buffer comment_selection_chars '[//]: # (:)'
}

hook global BufSetOption filetype=perl %{
    set buffer comment_selection_chars '#[:]'
}

hook global BufSetOption filetype=(pug|rust) %{
    set buffer comment_line_chars '//'
}

hook global BufSetOption filetype=python %{
    set buffer comment_selection_chars '\'\'\':\'\'\''
}

hook global BufSetOption filetype=ragel %{
    set buffer comment_line_chars '%%'
    set buffer comment_selection_chars '%%{:}%%'
}

hook global BufSetOption filetype=ruby %{
    set buffer comment_selection_chars '^begin=:^=end'
}

def comment-selection -docstring "Comment/uncomment the current selection" %{
    %sh{
        exec_proof() {
            ## Replace the '<' sign that is interpreted differently in `exec`
            printf %s\\n "$@" | sed 's,<,<lt>,g'
        }

        readonly opening=$(exec_proof "${kak_opt_comment_selection_chars%:*}")
        readonly closing=$(exec_proof "${kak_opt_comment_selection_chars##*:}")

        if [ -z "${opening}" ] || [ -z "${closing}" ]; then
            echo "echo -debug 'The \`comment_selection_chars\` variable is empty, could not comment the selection'"
            exit
        fi

        printf %s\\n "eval -draft %{ try %{
            ## The selection is empty
            exec <a-K>\\A[\\h\\v\\n]*\\z<ret>

            try %{
                ## The selection has already been commented
                exec %{<a-K>\\A\\Q${opening}\\E.*\\Q${closing}\\E\\n*\\z<ret>}

                ## Comment the selection
                exec -draft %{a${closing}<esc>i${opening}}
            } catch %{
                ## Uncomment the commented selection
                exec -draft %{s(\\A\\Q${opening}\\E)|(\\Q${closing}\\E\\n*\\z)<ret>d}
            }
        } }"
    }
}

def comment-line -docstring "Comment/uncomment the current line" %{
    %sh{
        readonly opening="${kak_opt_comment_line_chars}"
        readonly opening_escaped="\\Q${opening}\\E"

        if [ -z "${opening}" ]; then
            echo "echo -debug 'The \`comment_line_chars\` variable is empty, could not comment the line'"
            exit
        fi

        printf %s\\n "eval -draft %{
            ## Select the content of the line, without indentation
            exec I<esc><a-l>

            try %{
                ## There's no text on the line
                exec <a-K>\\A[\\h\\v\\n]*\\z<ret>

                try %{
                    ## The line has already been commented
                    exec %{<a-K>\\A${opening_escaped}<ret>}

                    ## Comment the line
                    exec -draft %{i${opening}}
                } catch %{
                    ## Uncomment the line
                    exec -draft %{s\\A${opening_escaped}\\h*<ret>d}
                }
            }
        }"
    }
}