summaryrefslogtreecommitdiff
path: root/ale_linters/yaml/spectral.vim
blob: c1644f3ea5b31475332b0ad4eb372fdaeb006dbe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
" Author: t2h5 <https://github.com/t2h5>
" Description: Integration of Stoplight Spectral CLI with ALE.

call ale#Set('yaml_spectral_executable', 'spectral')
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', {
\   'name': 'spectral',
\   'executable': {b -> ale#node#FindExecutable(b, 'yaml_spectral', [
\       'node_modules/.bin/spectral',
\   ])},
\   'command': '%e lint --ignore-unknown-format -q -f text %t',
\   'callback': 'ale_linters#yaml#spectral#Handle'
\})