xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8b2906a14d
kakoune/rc/tools/formatter.kak

32 lines
1.4 KiB
Plaintext
Raw Normal View History

rc: Don't use command aliases to highlight keywords properly
2017-11-03 08:34:41 +01:00
declare-option -docstring "shell command to which the contents of the current buffer is piped" \
rc: Document non-hidden options with `-docstring`
2017-05-16 13:35:43 +02:00
str formatcmd
Prevent the :format command from triggering hooks. The :format command is often called from a BufWritePre hook to format the current buffer, however the :format command itself calls `:write` to store the buffer in a temporary location, potentially causing an infinite recursion. If we disable hooks while running :format, there's no danger of that occurring.
2018-06-01 12:22:08 +02:00
define-command format -docstring "Format the contents of the current buffer" %{ evaluate-commands -draft -no-hooks %{
Do not reparse %sh{...} strings Automatic reparsing of %sh{...}, while convenient in many cases, can be surprising as well, and can lead to security problems: 'echo %sh{ printf "foo\necho bar" }' runs 'echo foo', then 'echo bar'. we make this danger explicit, and we fix the 'nop %sh{...}' pattern. To reparse %sh{...} strings, they can be passed to evaluate-commands, which has been fixed to work in every cases where %sh{...} reparsing was used..
2018-05-06 23:29:52 +02:00
evaluate-commands %sh{
rc formatter: Make sure the formatter returned successfully The previous implementation used to replace the contents of the buffer with whatever the `formatcmd` was returning, regardless of the exit code of the command, which led to the buffer being wiped out on error. This commit does the formatting in a temporary file, and only replaces the current buffer with the contents of the -formatted- temporary file if the `formatcmd` returned successfully. Fixes #1357
2017-06-23 14:09:18 +02:00
if [ -n "${kak_opt_formatcmd}" ]; then
path_file_tmp=$(mktemp "${TMPDIR:-/tmp}"/kak-formatter-XXXXXX)
printf %s\\n "
rc: Synchronize important file writes Fixes #2178
2018-07-04 08:55:05 +02:00
write -sync \"${path_file_tmp}\"
rc formatter: Make sure the formatter returned successfully The previous implementation used to replace the contents of the buffer with whatever the `formatcmd` was returning, regardless of the exit code of the command, which led to the buffer being wiped out on error. This commit does the formatting in a temporary file, and only replaces the current buffer with the contents of the -formatted- temporary file if the `formatcmd` returned successfully. Fixes #1357
2017-06-23 14:09:18 +02:00
Do not reparse %sh{...} strings Automatic reparsing of %sh{...}, while convenient in many cases, can be surprising as well, and can lead to security problems: 'echo %sh{ printf "foo\necho bar" }' runs 'echo foo', then 'echo bar'. we make this danger explicit, and we fix the 'nop %sh{...}' pattern. To reparse %sh{...} strings, they can be passed to evaluate-commands, which has been fixed to work in every cases where %sh{...} reparsing was used..
2018-05-06 23:29:52 +02:00
evaluate-commands %sh{
rc formatter: Make sure the formatter returned successfully The previous implementation used to replace the contents of the buffer with whatever the `formatcmd` was returning, regardless of the exit code of the command, which led to the buffer being wiped out on error. This commit does the formatting in a temporary file, and only replaces the current buffer with the contents of the -formatted- temporary file if the `formatcmd` returned successfully. Fixes #1357
2017-06-23 14:09:18 +02:00
readonly path_file_out=\$(mktemp \"${TMPDIR:-/tmp}\"/kak-formatter-XXXXXX)
if cat \"${path_file_tmp}\" | eval \"${kak_opt_formatcmd}\" > \"\${path_file_out}\"; then
src rc: Rename `exec`/`eval` into `execute-keys`/`evaluate-commands`
2017-11-03 09:09:45 +01:00
printf '%s\\n' \"execute-keys \\%|cat<space>'\${path_file_out}'<ret>\"
Do not reparse %sh{...} strings Automatic reparsing of %sh{...}, while convenient in many cases, can be surprising as well, and can lead to security problems: 'echo %sh{ printf "foo\necho bar" }' runs 'echo foo', then 'echo bar'. we make this danger explicit, and we fix the 'nop %sh{...}' pattern. To reparse %sh{...} strings, they can be passed to evaluate-commands, which has been fixed to work in every cases where %sh{...} reparsing was used..
2018-05-06 23:29:52 +02:00
printf '%s\\n' \"nop %sh{ rm -f '\${path_file_out}' }\"
rc formatter: Make sure the formatter returned successfully The previous implementation used to replace the contents of the buffer with whatever the `formatcmd` was returning, regardless of the exit code of the command, which led to the buffer being wiped out on error. This commit does the formatting in a temporary file, and only replaces the current buffer with the contents of the -formatted- temporary file if the `formatcmd` returned successfully. Fixes #1357
2017-06-23 14:09:18 +02:00
else
printf '%s\\n' \"
src rc: Rename `exec`/`eval` into `execute-keys`/`evaluate-commands`
2017-11-03 09:09:45 +01:00
evaluate-commands -client '${kak_client}' echo -markup '{Error}formatter returned an error (\$?)'
rc formatter: Make sure the formatter returned successfully The previous implementation used to replace the contents of the buffer with whatever the `formatcmd` was returning, regardless of the exit code of the command, which led to the buffer being wiped out on error. This commit does the formatting in a temporary file, and only replaces the current buffer with the contents of the -formatted- temporary file if the `formatcmd` returned successfully. Fixes #1357
2017-06-23 14:09:18 +02:00
\"
rm -f \"\${path_file_out}\"
fi
rm -f \"${path_file_tmp}\"
}
"
Add error message when using format command with no formatcmd specified
2017-06-26 22:10:04 +02:00
else
src rc: Rename `exec`/`eval` into `execute-keys`/`evaluate-commands`
2017-11-03 09:09:45 +01:00
printf '%s\n' "evaluate-commands -client '${kak_client}' echo -markup '{Error}formatcmd option not specified'"
Introduce `formatter.kak` to handle formatting. The modified files used to handle formatting code with the same code, and a different command, the process is now centralized into a single file. Language support files should set the `formatcmd` string to whatever formatter is the most popular in their respective community, eventually with default options.
2015-10-22 15:41:19 +02:00
fi
}
rc formatter: Make sure the formatter returned successfully The previous implementation used to replace the contents of the buffer with whatever the `formatcmd` was returning, regardless of the exit code of the command, which led to the buffer being wiped out on error. This commit does the formatting in a temporary file, and only replaces the current buffer with the contents of the -formatted- temporary file if the `formatcmd` returned successfully. Fixes #1357
2017-06-23 14:09:18 +02:00
} }
Reference in New Issue Copy Permalink