summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSheheryar Parvaz <skipper308@hotmail.ca>2020-07-10 20:14:12 -0400
committerSheheryar Parvaz <skipper308@hotmail.ca>2020-07-10 22:33:37 -0400
commit23c58e63d426770cf3233553450acfdcd3a73525 (patch)
treeeb42abc92a33a175c48dc51ea8eee7e39fbd2054 /doc
parent106c27644b4ff7543d600ae54ab9c53bec909828 (diff)
downloadale-23c58e63d426770cf3233553450acfdcd3a73525.zip
Support zls language server for zig
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-supported-languages-and-tools.txt2
-rw-r--r--doc/ale-zig.txt33
-rw-r--r--doc/ale.txt2
3 files changed, 37 insertions, 0 deletions
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index 45252294..4b4002af 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -510,3 +510,5 @@ Notes:
* `yamllint`
* YANG
* `yang-lsp`
+* Zig
+ * `zls`
diff --git a/doc/ale-zig.txt b/doc/ale-zig.txt
new file mode 100644
index 00000000..70a53bbb
--- /dev/null
+++ b/doc/ale-zig.txt
@@ -0,0 +1,33 @@
+===============================================================================
+ALE Zig Integration *ale-zig-options*
+ *ale-integration-zig*
+
+===============================================================================
+Integration Information
+
+ Currently, the only supported linter for zig is zls.
+
+===============================================================================
+zls *ale-zig-zls*
+
+g:ale_zig_zls_executable *g:ale_zig_zls_executable*
+ *b:ale_zig_zls_executable*
+ Type: |String|
+ Default: `'zls'`
+
+ This variable can be modified to change the executable path for `zls`.
+
+
+g:ale_zig_zls_config *g:ale_zig_zls_config*
+ *b:ale_zig_zls_config*
+ Type: |Dictionary|
+ Default: `{}`
+
+ WARNING: As of writing, zls does not support receiving configuration
+ from the client. This variable is a PLACEHOLDER until it does.
+
+ Dictionary with configuration settings for zls.
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale.txt b/doc/ale.txt
index 724da57e..09f29c8d 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2676,6 +2676,8 @@ documented in additional help files.
yamllint..............................|ale-yaml-yamllint|
yang....................................|ale-yang-options|
yang-lsp..............................|ale-yang-lsp|
+ zig.....................................|ale-zig-options|
+ zls...................................|ale-zig-zls|
===============================================================================