summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorArnold Chand <creativenull@outlook.com>2021-11-21 07:02:09 -0400
committerGitHub <noreply@github.com>2021-11-21 20:02:09 +0900
commitde67f4743d9ffd1694d15b1b91fedfaa0a5cda70 (patch)
tree462600fd76a8cc608a519ef40dd6b4c27f53097a /doc
parent072750137f752c0a09fd1ff493da2bea6519b7ef (diff)
downloadale-de67f4743d9ffd1694d15b1b91fedfaa0a5cda70.zip
Add volar support for vue (#3992)
* feat-draft: inital volar setup * feat(volar): add documentation * feat(volar): include default init opts * feat(volar): add initial tests * fix(volar): add possible project roots * fix(volar): tests - use empty files
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-supported-languages-and-tools.txt1
-rw-r--r--doc/ale-vue.txt31
-rw-r--r--doc/ale.txt1
3 files changed, 33 insertions, 0 deletions
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index 3324903f..df9b5dd6 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -620,6 +620,7 @@ Notes:
* `cspell`
* `prettier`
* `vls`
+ * `volar`
* XHTML
* `alex`
* `cspell`
diff --git a/doc/ale-vue.txt b/doc/ale-vue.txt
index 5bf1e28d..98ac5808 100644
--- a/doc/ale-vue.txt
+++ b/doc/ale-vue.txt
@@ -34,4 +34,35 @@ g:ale_vue_vls_use_global *g:ale_vue_vls_use_global*
===============================================================================
+volar *ale-vue-volar*
+
+ It is required to have typescript installed in your project as your dev
+ dependency: `npm i -D typescript`
+
+g:ale_vue_volar_executable *g:ale_vue_volar_executable*
+ *b:ale_vue_volar_executable*
+ Type: |String|
+ Default: `'volar-server'`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_vue_volar_use_global *g:ale_vue_volar_use_global*
+ *b:ale_vue_volar_use_global*
+ Type: |Number|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ See |ale-integrations-local-executables|
+
+
+g:vue_volar_init_options *g:ale_vue_volar_init_options*
+ *b:ale_vue_volar_init_options*
+ Type: |Dictionary|
+ Default: `{ ... }`
+
+ Default is too long to show here, take a look at it over
+ `ale_linters/vue/volar.vim`
+
+
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale.txt b/doc/ale.txt
index 178ce314..0ac01305 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -3168,6 +3168,7 @@ documented in additional help files.
cspell................................|ale-vue-cspell|
prettier..............................|ale-vue-prettier|
vls...................................|ale-vue-vls|
+ volar.................................|ale-vue-volar|
xhtml...................................|ale-xhtml-options|
cspell................................|ale-xhtml-cspell|
write-good............................|ale-xhtml-write-good|