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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
" Dictionary where we keep all of the healtch check functions we've found.
" They will only be run if the value is true
let g:health_checkers = get(g:, 'health_checkers', {})
let s:current_checker = get(s:, 'current_checker', '')
""
" Function to run the health checkers
" It manages the output and any file local settings
function! health#check(bang) abort
let l:report = '# Checking health'
if g:health_checkers == {}
call health#add_checker(s:_default_checkers())
endif
for l:checker in items(g:health_checkers)
" Disabled checkers will not run their registered check functions
if l:checker[1]
let s:current_checker = l:checker[0]
let l:report .= "\n\n--------------------------------------------------------------------------------\n"
let l:report .= printf("\n## Checker %s says:\n", s:current_checker)
let l:report .= capture('call ' . l:checker[0] . '()')
endif
endfor
let l:report .= "\n--------------------------------------------------------------------------------\n"
if a:bang
new
setlocal bufhidden=wipe
set syntax=health
set filetype=health
call setline(1, split(report, "\n"))
setlocal nomodified
else
echo report
echo "\nTip: Use "
echohl Identifier
echon ':CheckHealth!'
echohl None
echon ' to open this in a new buffer.'
endif
endfunction
" Report functions {{{
""
" Start a report section.
" It should represent a general area of tests that can be understood
" from the argument {name}
" To start a new report section, use this function again
function! health#report_start(name) abort " {{{
echo ' - Checking: ' . a:name
endfunction " }}}
""
" Format a message for a specific report item
function! s:format_report_message(status, msg, ...) abort " {{{
let l:output = ' - ' . a:status . ': ' . a:msg
" Check optional parameters
if a:0 > 0
" Suggestions go in the first optional parameter can be a string or list
if type(a:1) == type("")
let l:output .= "\n - SUGGESTIONS:"
let l:output .= "\n - " . a:1
elseif type(a:1) == type([])
" Report each suggestion
let l:output .= "\n - SUGGESTIONS:"
for l:suggestion in a:1
let l:output .= "\n - " . l:suggestion
endfor
else
echoerr "A string or list is required as the optional argument for suggestions"
endif
endif
return output
endfunction " }}}
""
" Use {msg} to report information in the current section
function! health#report_info(msg) abort " {{{
echo s:format_report_message('INFO', a:msg)
endfunction " }}}
""
" Use {msg} to represent the check that has passed
function! health#report_ok(msg) abort " {{{
echo s:format_report_message('SUCCESS', a:msg)
endfunction " }}}
""
" Use {msg} to represent a failed health check and optionally a list of suggestions on how to fix it.
function! health#report_warn(msg, ...) abort " {{{
if a:0 > 0 && type(a:1) == type([])
echo s:format_report_message('WARNING', a:msg, a:1)
else
echo s:format_report_message('WARNING', a:msg)
endif
endfunction " }}}
""
" Use {msg} to represent a critically failed health check and optionally a list of suggestions on how to fix it.
function! health#report_error(msg, ...) abort " {{{
if a:0 > 0 && type(a:1) == type([])
echo s:format_report_message('ERROR', a:msg, a:1)
else
echo s:format_report_message('ERROR', a:msg)
endif
endfunction " }}}
" }}}
" Health checker management {{{
""
" Add a single health checker
" It does not modify any values if the checker already exists
function! s:add_single_checker(checker_name) abort " {{{
if has_key(g:health_checkers, a:checker_name)
return
else
let g:health_checkers[a:checker_name] = v:true
endif
endfunction " }}}
""
" Enable a single health checker
" It will modify the values if the checker already exists
function! s:enable_single_checker(checker_name) abort " {{{
let g:health_checkers[a:checker_name] = v:true
endfunction " }}}
""
" Disable a single health checker
" It will modify the values if the checker already exists
function! s:disable_single_checker(checker_name) abort " {{{
let g:health_checkers[a:checker_name] = v:false
endfunction " }}}
""
" Add at least one health checker
" {checker_name} can be specified by either a list of strings or a single string.
" It does not modify any values if the checker already exists
function! health#add_checker(checker_name) abort " {{{
if type(a:checker_name) == type('')
call s:add_single_checker(a:checker_name)
elseif type(a:checker_name) == type([])
for checker in a:checker_name
call s:add_single_checker(checker)
endfor
endif
endfunction " }}}
""
" Enable at least one health checker
" {checker_name} can be specified by either a list of strings or a single string.
function! health#enable_checker(checker_name) abort " {{{
if type(a:checker_name) == type('')
call s:enable_single_checker(a:checker_name)
elseif type(a:checker_name) == type([])
for checker in a:checker_name
call s:enable_single_checker(checker)
endfor
endif
endfunction " }}}
""
" Disable at least one health checker
" {checker_name} can be specified by either a list of strings or a single string.
function! health#disable_checker(checker_name) abort " {{{
if type(a:checker_name) == type('')
call s:disable_single_checker(a:checker_name)
elseif type(a:checker_name) == type([])
for checker in a:checker_name
call s:disable_single_checker(checker)
endfor
endif
endfunction " }}}
function! s:change_file_name_to_health_checker(name) abort " {{{
return substitute(substitute(substitute(a:name, ".*autoload/", "", ""), "\\.vim", "#check", ""), "/", "#", "g")
endfunction " }}}
function! s:_default_checkers() abort " {{{
" Get all of the files that are in autoload/health/ folders with a vim
" suffix
let checker_files = globpath(&runtimepath, 'autoload/health/*.vim', 1, 1)
let temp = checker_files[0]
let checkers_to_source = []
for file_name in checker_files
call add(checkers_to_source, s:change_file_name_to_health_checker(file_name))
endfor
return checkers_to_source
endfunction " }}}
" }}}
|
