summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorYining <zhang.yining@gmail.com>2023-12-08 01:55:14 +1100
committerGitHub <noreply@github.com>2023-12-07 14:55:14 +0000
commit32ee7039d0ee7afcc134756cfac78678cffc7017 (patch)
tree76dafc61a9a52788d056d4ea0e14e295bef7fb87 /doc
parentfc45a935bf25f7daa1965e3afcc8d9c6e525b078 (diff)
downloadale-32ee7039d0ee7afcc134756cfac78678cffc7017.zip
add: support for `nickel format` as `Nickel` fixer (#4665)
Nickel(https://nickel-lang.org/) is a configuration language, like Jsonnet, Cue, Dhall. `nickel`(https://github.com/tweag/nickel) is the main command to run, export and also format Nickel code. this commit adds `nickel format` as a Nickel fixer, together with some tests and documentation.
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-nickel.txt25
-rw-r--r--doc/ale-supported-languages-and-tools.txt2
-rw-r--r--doc/ale.txt2
3 files changed, 29 insertions, 0 deletions
diff --git a/doc/ale-nickel.txt b/doc/ale-nickel.txt
new file mode 100644
index 00000000..a8dd6af8
--- /dev/null
+++ b/doc/ale-nickel.txt
@@ -0,0 +1,25 @@
+===============================================================================
+ALE Nickel Integration *ale-nickel-options*
+
+
+===============================================================================
+nickel_format *ale-nickel-nickel-format*
+
+g:ale_nickel_nickel_format_executable *g:ale_nickel_nickel_format_executable*
+ *b:ale_nickel_nickel_format_executable*
+ Type: |String|
+ Default: `'nickel'`
+
+ This option can be changed to change the path for `nickel`.
+
+
+g:ale_nickel_nickel_format_options *g:ale_nickel_nickel_format_options*
+ *b:ale_nickel_nickel_format_options*
+ Type: |String|
+ Default: `''`
+
+ This option can be changed to pass extra options to `'nickel format'`
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index bfe34afc..acfdb8d4 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -382,6 +382,8 @@ Notes:
* `mmc`!!
* NASM
* `nasm`!!
+* Nickel
+ * `nickel_format`
* Nim
* `nim check`!!
* `nimlsp`
diff --git a/doc/ale.txt b/doc/ale.txt
index d11114e5..b577324e 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -3188,6 +3188,8 @@ documented in additional help files.
mmc...................................|ale-mercury-mmc|
nasm....................................|ale-nasm-options|
nasm..................................|ale-nasm-nasm|
+ nickel..................................|ale-nickel-options|
+ nickel_format.........................|ale-nickel-nickel-format|
nim.....................................|ale-nim-options|
nimcheck..............................|ale-nim-nimcheck|
nimlsp................................|ale-nim-nimlsp|