summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorP M <10617122+pylipp@users.noreply.github.com>2018-04-05 21:09:41 +0200
committerw0rp <w0rp@users.noreply.github.com>2018-04-05 21:09:41 +0200
commit85a2a008266f69847a3c7a9d38c16b779636ab30 (patch)
tree19504abe11cf715dadef67e613cbcb00ad604919 /doc
parent912f632bf591377a69bf688f6a85668d93be8841 (diff)
downloadale-85a2a008266f69847a3c7a9d38c16b779636ab30.zip
Integration of qmlfmt linting tool (#1462)
* Add first qmlfmt support * Add GetCommand() function - pass --error/-e option * Add handle unittest - fix pattern regex - store col as integer * Update docs * Add command callback unit test
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-qml.txt18
-rw-r--r--doc/ale.txt4
2 files changed, 21 insertions, 1 deletions
diff --git a/doc/ale-qml.txt b/doc/ale-qml.txt
new file mode 100644
index 00000000..f6d715a1
--- /dev/null
+++ b/doc/ale-qml.txt
@@ -0,0 +1,18 @@
+===============================================================================
+ALE QML Integration *ale-qml-options*
+
+
+===============================================================================
+qmlfmt *ale-qml-qmlfmt*
+
+g:ale_qml_qmlfmt_executable *g:ale_qml_qmlfmt_executable*
+ *b:ale_qml_qmlfmt_executable*
+ Type: |String|
+ Default: `'qmlfmt'`
+
+ This variable can be set to change the path to qmlfmt.
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+
diff --git a/doc/ale.txt b/doc/ale.txt
index 7ad46297..4ba8e649 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -187,6 +187,8 @@ CONTENTS *ale-contents*
pylint..............................|ale-python-pylint|
pyls................................|ale-python-pyls|
yapf................................|ale-python-yapf|
+ qml...................................|ale-qml-options|
+ qmlfmt..............................|ale-qml-qmlfmt|
r.....................................|ale-r-options|
lintr...............................|ale-r-lintr|
reasonml..............................|ale-reasonml-options|
@@ -368,7 +370,7 @@ Notes:
* Pug: `pug-lint`
* Puppet: `puppet`, `puppet-lint`
* Python: `autopep8`, `flake8`, `isort`, `mypy`, `prospector`, `pycodestyle`, `pyls`, `pylint`!!, `yapf`
-* QML: `qmllint`
+* QML: `qmlfmt`, `qmllint`
* R: `lintr`
* ReasonML: `merlin`, `ols`, `refmt`
* reStructuredText: `alex`!!, `proselint`, `redpen`, `rstcheck`, `vale`, `write-good`