Add xmllint linter (#559)

* Add xmllint linter for xml
This commit is contained in:
q12321q 2017-05-18 10:31:12 +02:00 committed by w0rp
parent 3ca70cb841
commit cdf0fb39e5
6 changed files with 154 additions and 0 deletions

View File

@ -115,6 +115,7 @@ name. That seems to be the fairest way to arrange this table.
| Vim | [vint](https://github.com/Kuniwak/vint) | | Vim | [vint](https://github.com/Kuniwak/vint) |
| Vim help^ | [proselint](http://proselint.com/)| | Vim help^ | [proselint](http://proselint.com/)|
| XHTML | [proselint](http://proselint.com/)| | XHTML | [proselint](http://proselint.com/)|
| XML | [xmllint](http://xmlsoft.org/xmllint.html/)|
| YAML | [yamllint](https://yamllint.readthedocs.io/) | | YAML | [yamllint](https://yamllint.readthedocs.io/) |
* *^ No linters for text or Vim help filetypes are enabled by default.* * *^ No linters for text or Vim help filetypes are enabled by default.*

View File

@ -0,0 +1,69 @@
" Author: q12321q <q12321q@gmail.com>
" Description: This file adds support for checking XML code with xmllint.
" CLI options
let g:ale_xml_xmllint_executable = get(g:, 'ale_xml_xmllint_executable', 'xmllint')
let g:ale_xml_xmllint_options = get(g:, 'ale_xml_xmllint_options', '')
function! ale_linters#xml#xmllint#GetExecutable(buffer) abort
return ale#Var(a:buffer, 'xml_xmllint_executable')
endfunction
function! ale_linters#xml#xmllint#GetCommand(buffer) abort
return ale#Escape(ale_linters#xml#xmllint#GetExecutable(a:buffer))
\ . ' ' . ale#Var(a:buffer, 'xml_xmllint_options')
\ . ' --noout -'
endfunction
function! ale_linters#xml#xmllint#Handle(buffer, lines) abort
" Matches patterns lines like the following:
" file/path:123: error level : error message
let l:pattern_message = '\v^([^:]+):(\d+):\s*(([^:]+)\s*:\s+.*)$'
" parse column token line like that:
" file/path:123: parser error : Opening and ending tag mismatch: foo line 1 and bar
" </bar>
" ^
let l:pattern_column_token = '\v^\s*\^$'
let l:output = []
for l:line in a:lines
" Parse error/warning lines
let l:match_message = matchlist(l:line, l:pattern_message)
if !empty(l:match_message)
let l:line = l:match_message[2] + 0
let l:type = l:match_message[4] =~? 'warning' ? 'W' : 'E'
let l:text = l:match_message[3]
call add(l:output, {
\ 'lnum': l:line,
\ 'text': l:text,
\ 'type': l:type,
\})
continue
endif
" Parse column position
let l:match_column_token = matchlist(l:line, l:pattern_column_token)
if !empty(l:output) && !empty(l:match_column_token)
let l:previous = l:output[len(l:output) - 1]
let l:previous['col'] = len(l:match_column_token[0])
continue
endif
endfor
return l:output
endfunction
call ale#linter#Define('xml', {
\ 'name': 'xmllint',
\ 'output_stream': 'stderr',
\ 'executable_callback': 'ale_linters#xml#xmllint#GetExecutable',
\ 'command_callback': 'ale_linters#xml#xmllint#GetCommand',
\ 'callback': 'ale_linters#xml#xmllint#Handle',
\ })

26
doc/ale-xml.txt Normal file
View File

@ -0,0 +1,26 @@
===============================================================================
ALE XML Integration *ale-xml-options*
-------------------------------------------------------------------------------
xmllint *ale-xml-xmllint*
g:ale_xml_xmllint_executable *g:ale_xml_xmllint_executable*
*b:ale_xml_xmllint_executable*
Type: |String|
Default: `'xmllint'`
This variable can be set to change the path to xmllint.
g:ale_xml_xmllint_options *g:ale_xml_xmllint_options*
*b:ale_xml_xmllint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to xmllint.
-------------------------------------------------------------------------------
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@ -85,6 +85,8 @@ CONTENTS *ale-contents*
tslint..............................|ale-typescript-tslint| tslint..............................|ale-typescript-tslint|
vim...................................|ale-vim-options| vim...................................|ale-vim-options|
vint................................|ale-vim-vint| vint................................|ale-vim-vint|
xml...................................|ale-xml-options|
xmllint.............................|ale-xml-xmllint|
yaml..................................|ale-yaml-options| yaml..................................|ale-yaml-options|
yamllint............................|ale-yaml-yamllint| yamllint............................|ale-yaml-yamllint|
5. Commands/Keybinds....................|ale-commands| 5. Commands/Keybinds....................|ale-commands|
@ -177,6 +179,7 @@ The following languages and tools are supported.
* Vim: 'vint' * Vim: 'vint'
* Vim help: 'proselint' * Vim help: 'proselint'
* XHTML: 'proselint' * XHTML: 'proselint'
* XML: 'xmllint'
* YAML: 'yamllint' * YAML: 'yamllint'
=============================================================================== ===============================================================================

View File

@ -0,0 +1,25 @@
Before:
runtime ale_linters/xml/xmllint.vim
After:
call ale#linter#Reset()
let g:ale_xml_xmllint_options = ''
let g:ale_xml_xmllint_executable = 'xmllint'
Execute(The xml xmllint command callback should return the correct default string):
AssertEqual '''xmllint'' --noout -',
\ join(split(ale_linters#xml#xmllint#GetCommand(1)))
Execute(The xml xmllint command callback should let you set options):
let g:ale_xml_xmllint_options = '--xinclude --postvalid'
AssertEqual '''xmllint'' --xinclude --postvalid --noout -',
\ join(split(ale_linters#xml#xmllint#GetCommand(1)))
Execute(The xmllint executable should be configurable):
let g:ale_xml_xmllint_executable = '~/.local/bin/xmllint'
AssertEqual '~/.local/bin/xmllint', ale_linters#xml#xmllint#GetExecutable(1)
AssertEqual '''~/.local/bin/xmllint'' --noout -',
\ join(split(ale_linters#xml#xmllint#GetCommand(1)))

View File

@ -0,0 +1,30 @@
Before:
runtime ale_linters/xml/xmllint.vim
Execute(The xmllint handler should parse error messages correctly):
AssertEqual
\ [
\ {
\ 'lnum': 1,
\ 'col': 22,
\ 'type': 'W',
\ 'text': 'warning: Unsupported version ''dummy'''
\ },
\ {
\ 'lnum': 34,
\ 'col': 1,
\ 'type': 'E',
\ 'text': 'parser error : Start tag expected, ''<'' not found'
\ }
\ ],
\ ale_linters#xml#xmllint#Handle(1, [
\ 'path/to/file.xml:1: warning: Unsupported version ''dummy''',
\ '<?xml version="dummy"?>',
\ ' ^',
\ '-:34: parser error : Start tag expected, ''<'' not found',
\ 'blahblah>',
\ '^'
\ ])
After:
call ale#linter#Reset()