summaryrefslogtreecommitdiff
path: root/ale_linters/php/phpstan.vim
blob: 1c831e1bade4d03ddfbe063f393a6db6aa62911b (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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
" Author: medains <https://github.com/medains>, ardis <https://github.com/ardisdreelath>
" Description: phpstan for PHP files

" Set to change the ruleset
let g:ale_php_phpstan_executable = get(g:, 'ale_php_phpstan_executable', 'phpstan')
let g:ale_php_phpstan_level = get(g:, 'ale_php_phpstan_level', '4')
let g:ale_php_phpstan_configuration = get(g:, 'ale_php_phpstan_configuration', '')

function! ale_linters#php#phpstan#GetExecutable(buffer) abort
    return ale#Var(a:buffer, 'php_phpstan_executable')
endfunction

function! ale_linters#php#phpstan#VersionCheck(buffer) abort
    let l:executable = ale_linters#php#phpstan#GetExecutable(a:buffer)

    " If we have previously stored the version number in a cache, then
    " don't look it up again.
    if ale#semver#HasVersion(l:executable)
        " Returning an empty string skips this command.
        return ''
    endif

    let l:executable = ale#Escape(l:executable)

    return l:executable . ' --version'
endfunction

function! ale_linters#php#phpstan#GetCommand(buffer, version_output) abort
    let l:configuration = ale#Var(a:buffer, 'php_phpstan_configuration')
    let l:configuration_option = !empty(l:configuration)
    \   ? ' -c ' . l:configuration
    \   : ''

    let l:executable = ale_linters#php#phpstan#GetExecutable(a:buffer)
    let l:version = ale#semver#GetVersion(l:executable, a:version_output)
    let l:error_format = ale#semver#GTE(l:version, [0, 10, 3])
    \   ? ' --error-format raw'
    \   : ' --errorFormat raw'

    return '%e analyze -l'
    \   . ale#Var(a:buffer, 'php_phpstan_level')
    \   . l:error_format
    \   . l:configuration_option
    \   . ' %s'
endfunction

function! ale_linters#php#phpstan#Handle(buffer, lines) abort
    " Matches against lines like the following:
    "
    " filename.php:15:message
    " C:\folder\filename.php:15:message
    let l:pattern = '^\([a-zA-Z]:\)\?[^:]\+:\(\d\+\):\(.*\)$'
    let l:output = []

    for l:match in ale#util#GetMatches(a:lines, l:pattern)
        call add(l:output, {
        \   'lnum': l:match[2] + 0,
        \   'text': l:match[3],
        \   'type': 'W',
        \})
    endfor

    return l:output
endfunction

call ale#linter#Define('php', {
\   'name': 'phpstan',
\   'executable_callback': 'ale_linters#php#phpstan#GetExecutable',
\   'command_chain': [
\       {'callback': 'ale_linters#php#phpstan#VersionCheck'},
\       {'callback': 'ale_linters#php#phpstan#GetCommand'},
\   ],
\   'callback': 'ale_linters#php#phpstan#Handle',
\})