add spectral handler

This commit is contained in:
tatsuya 2021-01-06 13:22:08 +09:00
parent 5a47d878fb
commit 997dd7f8fe
3 changed files with 33 additions and 30 deletions

View file

@ -4,39 +4,11 @@
call ale#Set('yaml_spectral_executable', 'spectral') call ale#Set('yaml_spectral_executable', 'spectral')
call ale#Set('yaml_spectral_use_global', get(g:, 'ale_use_global_executables', 0)) call ale#Set('yaml_spectral_use_global', get(g:, 'ale_use_global_executables', 0))
function! ale_linters#yaml#spectral#Handle(buffer, lines) abort
" Matches patterns like the following:
" openapi.yml:1:1 error oas3-schema "Object should have required property `info`."
" openapi.yml:1:1 warning oas3-api-servers "OpenAPI `servers` must be present and non-empty array."
let l:pattern = '\v^.*:(\d+):(\d+) (error|warning) (.*)$'
let l:output = []
for l:match in ale#util#GetMatches(a:lines, l:pattern)
let l:obj = {
\ 'lnum': l:match[1] + 0,
\ 'col': l:match[2] + 0,
\ 'type': l:match[3] is# 'error' ? 'E' : 'W',
\ 'text': l:match[4],
\}
let l:code_match = matchlist(l:obj.text, '\v^(.+) "(.+)"$')
if !empty(l:code_match)
let l:obj.code = l:code_match[1]
let l:obj.text = l:code_match[2]
endif
call add(l:output, l:obj)
endfor
return l:output
endfunction
call ale#linter#Define('yaml', { call ale#linter#Define('yaml', {
\ 'name': 'spectral', \ 'name': 'spectral',
\ 'executable': {b -> ale#node#FindExecutable(b, 'yaml_spectral', [ \ 'executable': {b -> ale#node#FindExecutable(b, 'yaml_spectral', [
\ 'node_modules/.bin/spectral', \ 'node_modules/.bin/spectral',
\ ])}, \ ])},
\ 'command': '%e lint --ignore-unknown-format -q -f text %t', \ 'command': '%e lint --ignore-unknown-format -q -f text %t',
\ 'callback': 'ale_linters#yaml#spectral#Handle' \ 'callback': 'ale#handlers#spectral#HandleSpectralOutput'
\}) \})

View file

@ -0,0 +1,31 @@
" Author: t2h5 <https://github.com/t2h5>
" Description: Integration of Stoplight Spectral CLI with ALE.
function! ale#handlers#spectral#HandleSpectralOutput(buffer, lines) abort
" Matches patterns like the following:
" openapi.yml:1:1 error oas3-schema "Object should have required property `info`."
" openapi.yml:1:1 warning oas3-api-servers "OpenAPI `servers` must be present and non-empty array."
let l:pattern = '\v^.*:(\d+):(\d+) (error|warning) (.*)$'
let l:output = []
for l:match in ale#util#GetMatches(a:lines, l:pattern)
let l:obj = {
\ 'lnum': l:match[1] + 0,
\ 'col': l:match[2] + 0,
\ 'type': l:match[3] is# 'error' ? 'E' : 'W',
\ 'text': l:match[4],
\}
let l:code_match = matchlist(l:obj.text, '\v^(.+) "(.+)"$')
if !empty(l:code_match)
let l:obj.code = l:code_match[1]
let l:obj.text = l:code_match[2]
endif
call add(l:output, l:obj)
endfor
return l:output
endfunction

View file

@ -43,7 +43,7 @@ Execute(spectral handler should parse lines correctly):
\ 'type': 'E' \ 'type': 'E'
\ }, \ },
\ ], \ ],
\ ale_linters#yaml#spectral#Handle(bufnr(''), [ \ ale#handlers#spectral#HandleSpectralOutput(bufnr(''), [
\ 'openapi.yml:1:1 warning oas3-api-servers "OpenAPI `servers` must be present and non-empty array."', \ 'openapi.yml:1:1 warning oas3-api-servers "OpenAPI `servers` must be present and non-empty array."',
\ 'openapi.yml:1:1 error oas3-schema "Object should have required property `paths`."', \ 'openapi.yml:1:1 error oas3-schema "Object should have required property `paths`."',
\ 'openapi.yml:1:1 warning openapi-tags "OpenAPI object should have non-empty `tags` array."', \ 'openapi.yml:1:1 warning openapi-tags "OpenAPI object should have non-empty `tags` array."',