summaryrefslogtreecommitdiff
path: root/autoload/ale/debugging.vim
blob: f42c9e82e7a76679abd114352d1ad484ead32edd (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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
" Author: w0rp <devw0rp@gmail.com>
" Description: This file implements debugging information for ALE

let s:global_variable_list = [
\    'ale_echo_cursor',
\    'ale_echo_msg_error_str',
\    'ale_echo_msg_format',
\    'ale_echo_msg_warning_str',
\    'ale_enabled',
\    'ale_keep_list_window_open',
\    'ale_lint_delay',
\    'ale_lint_on_enter',
\    'ale_lint_on_save',
\    'ale_lint_on_text_changed',
\    'ale_linter_aliases',
\    'ale_linters',
\    'ale_open_list',
\    'ale_set_highlights',
\    'ale_set_loclist',
\    'ale_set_quickfix',
\    'ale_set_signs',
\    'ale_sign_column_always',
\    'ale_sign_error',
\    'ale_sign_offset',
\    'ale_sign_warning',
\    'ale_statusline_format',
\    'ale_warn_about_trailing_whitespace',
\]

function! s:GetLinterVariables(filetype, linter_names) abort
    let l:variable_list = []
    let l:filetype_parts = split(a:filetype, '\.')

    for l:key in keys(g:)
        " Extract variable names like: 'ale_python_flake8_executable'
        let l:match = matchlist(l:key, '\v^ale_([^_]+)_([^_]+)_.+$')

        " Include matching variables.
        if !empty(l:match)
        \&& index(l:filetype_parts, l:match[1]) >= 0
        \&& index(a:linter_names, l:match[2]) >= 0
            call add(l:variable_list, l:key)
        endif
    endfor

    call sort(l:variable_list)

    return l:variable_list
endfunction

function! s:EchoLinterVariables(variable_list) abort
    for l:key in a:variable_list
        echom 'let g:' . l:key . ' = ' . string(g:[l:key])

        if has_key(b:, l:key)
            echom 'let b:' . l:key . ' = ' . string(b:[l:key])
        endif
    endfor
endfunction

function! s:EchoGlobalVariables() abort
    for l:key in s:global_variable_list
        echom 'let g:' . l:key . ' = ' . string(get(g:, l:key, v:null))

        if has_key(b:, l:key)
            echom 'let b:' . l:key . ' = ' . string(b:[l:key])
        endif
    endfor
endfunction

function! s:EchoCommandHistory() abort
    let l:buffer = bufnr('%')

    if !has_key(g:ale_buffer_info, l:buffer)
        return
    endif

    for l:item in g:ale_buffer_info[l:buffer].history
        let l:status_message = l:item.status

        " Include the exit code in output if we have it.
        if l:item.status ==# 'finished'
            let l:status_message .= ' - exit code ' . l:item.exit_code
        endif

        echom '(' . l:status_message . ') ' . string(l:item.command)

        if g:ale_history_log_output && has_key(l:item, 'output')
            if empty(l:item.output)
                echom ''
                echom '<<<NO OUTPUT RETURNED>>>'
                echom ''
            else
                echom ''
                echom '<<<OUTPUT STARTS>>>'

                for l:line in l:item.output
                    echom l:line
                endfor

                echom '<<<OUTPUT ENDS>>>'
                echom ''
            endif
        endif
    endfor
endfunction

function! ale#debugging#Info() abort
    let l:filetype = &filetype

    " We get the list of enabled linters for free by the above function.
    let l:enabled_linters = deepcopy(ale#linter#Get(l:filetype))

    " But have to build the list of available linters ourselves.
    let l:all_linters = []
    let l:linter_variable_list = []

    for l:part in split(l:filetype, '\.')
        let l:aliased_filetype = ale#linter#ResolveFiletype(l:part)
        call extend(l:all_linters, ale#linter#GetAll(l:aliased_filetype))
    endfor

    let l:all_names = map(l:all_linters, 'v:val[''name'']')
    let l:enabled_names = map(l:enabled_linters, 'v:val[''name'']')

    " Load linter variables to display
    " This must be done after linters are loaded.
    let l:variable_list = s:GetLinterVariables(l:filetype, l:enabled_names)

    echom ' Current Filetype: ' . l:filetype
    echom 'Available Linters: ' . string(l:all_names)
    echom '  Enabled Linters: ' . string(l:enabled_names)
    echom ' Linter Variables:'
    echom ''
    call s:EchoLinterVariables(l:variable_list)
    echom ' Global Variables:'
    echom ''
    call s:EchoGlobalVariables()
    echom '  Command History:'
    echom ''
    call s:EchoCommandHistory()
endfunction

function! ale#debugging#InfoToClipboard() abort
    redir @+>
        silent call ale#debugging#Info()
    redir END

    echom 'ALEInfo copied to your clipboard'
endfunction