From 85a2a008266f69847a3c7a9d38c16b779636ab30 Mon Sep 17 00:00:00 2001 From: P M <10617122+pylipp@users.noreply.github.com> Date: Thu, 5 Apr 2018 21:09:41 +0200 Subject: [PATCH] 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 --- README.md | 2 +- ale_linters/qml/qmlfmt.vim | 40 +++++++++++++++++++ doc/ale-qml.txt | 18 +++++++++ doc/ale.txt | 4 +- .../test_qmlfmt_command_callback.vader | 18 +++++++++ test/handler/test_qmlfmt_handler.vader | 19 +++++++++ 6 files changed, 99 insertions(+), 2 deletions(-) create mode 100644 ale_linters/qml/qmlfmt.vim create mode 100644 doc/ale-qml.txt create mode 100644 test/command_callback/test_qmlfmt_command_callback.vader create mode 100644 test/handler/test_qmlfmt_handler.vader diff --git a/README.md b/README.md index b5dd0e9d..26699126 100644 --- a/README.md +++ b/README.md @@ -140,7 +140,7 @@ formatting. | Pug | [pug-lint](https://github.com/pugjs/pug-lint) | | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | | Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [prospector](http://github.com/landscapeio/prospector), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pyls](https://github.com/palantir/python-language-server), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | -| QML | [qmllint](https://github.com/qt/qtdeclarative/tree/5.11/tools/qmllint) | +| QML | [qmlfmt](https://github.com/jesperhh/qmlfmt), [qmllint](https://github.com/qt/qtdeclarative/tree/5.11/tools/qmllint) | | R | [lintr](https://github.com/jimhester/lintr) | | ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-reasonml-ols` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server), [refmt](https://github.com/reasonml/reason-cli) | | reStructuredText | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [rstcheck](https://github.com/myint/rstcheck), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | diff --git a/ale_linters/qml/qmlfmt.vim b/ale_linters/qml/qmlfmt.vim new file mode 100644 index 00000000..85b131fd --- /dev/null +++ b/ale_linters/qml/qmlfmt.vim @@ -0,0 +1,40 @@ +" Author: pylipp (www.github.com/pylipp) +" Description: qmlfmt for QML files + +let g:ale_qml_qmlfmt_executable = get(g:, 'ale_qml_qmlfmt_executable', 'qmlfmt') + +function! ale_linters#qml#qmlfmt#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'qml_qmlfmt_executable') +endfunction + +function! ale_linters#qml#qmlfmt#GetCommand(buffer) abort + return ale#Escape(ale_linters#qml#qmlfmt#GetExecutable(a:buffer)) + \ . ' -e' +endfunction + +" Find lines like +" Error:11:1: Expected token `}' +function! ale_linters#qml#qmlfmt#Handle(buffer, lines) abort + let l:pattern = '\v^(Error|Warning):(\d+):(\d+): (.+)$' + let l:output = [] + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + let l:item = { + \ 'lnum': l:match[2] + 0, + \ 'col': l:match[3] + 0, + \ 'text': l:match[4], + \ 'type': l:match[1] is# 'Warning' ? 'W' : 'E', + \} + call add(l:output, l:item) + endfor + + return l:output +endfunction + +call ale#linter#Define('qml', { +\ 'name': 'qmlfmt', +\ 'output_stream': 'stderr', +\ 'executable_callback': 'ale_linters#qml#qmlfmt#GetExecutable', +\ 'command_callback': 'ale_linters#qml#qmlfmt#GetCommand', +\ 'callback': 'ale_linters#qml#qmlfmt#Handle', +\}) 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` diff --git a/test/command_callback/test_qmlfmt_command_callback.vader b/test/command_callback/test_qmlfmt_command_callback.vader new file mode 100644 index 00000000..263caea7 --- /dev/null +++ b/test/command_callback/test_qmlfmt_command_callback.vader @@ -0,0 +1,18 @@ +Before: + runtime ale_linters/qml/qmlfmt.vim + +After: + let g:ale_qml_qmlfmt_executable = 'qmlfmt' + + call ale#linter#Reset() + +Execute(The qml qmlfmt command callback should return the correct default string): + AssertEqual ale#Escape('qmlfmt') . ' -e', + \ join(split(ale_linters#qml#qmlfmt#GetCommand(1))) + +Execute(The qmlfmt executable should be configurable): + let g:ale_qml_qmlfmt_executable = '~/.local/bin/qmlfmt' + + AssertEqual '~/.local/bin/qmlfmt', ale_linters#qml#qmlfmt#GetExecutable(1) + AssertEqual ale#Escape('~/.local/bin/qmlfmt') . ' -e', + \ join(split(ale_linters#qml#qmlfmt#GetCommand(1))) diff --git a/test/handler/test_qmlfmt_handler.vader b/test/handler/test_qmlfmt_handler.vader new file mode 100644 index 00000000..fc8ef355 --- /dev/null +++ b/test/handler/test_qmlfmt_handler.vader @@ -0,0 +1,19 @@ +Before: + runtime ale_linters/qml/qmlfmt.vim + +After: + call ale#linter#Reset() + +Execute(The qmlfmt handler should parse error messages correctly): + AssertEqual + \ [ + \ { + \ 'lnum': 22, + \ 'col': 1, + \ 'type': 'E', + \ 'text': 'Expected token ''}''.' + \ } + \ ], + \ ale_linters#qml#qmlfmt#Handle(1, [ + \ 'Error:22:1: Expected token ''}''.' + \ ])