aboutsummaryrefslogtreecommitdiff
path: root/vim/bundle/syntastic/syntax_checkers/html/tidy.vim
blob: 3075a7dd0e2c738e2b2b3ec9fedd3b9b060b0369 (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
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
200
201
202
203
204
205
206
207
208
209
210
211
212
"============================================================================
"File:        tidy.vim
"Description: Syntax checking plugin for syntastic.vim
"Maintainer:  Martin Grenfell <martin.grenfell at gmail dot com>
"License:     This program is free software. It comes without any warranty,
"             to the extent permitted by applicable law. You can redistribute
"             it and/or modify it under the terms of the Do What The Fuck You
"             Want To Public License, Version 2, as published by Sam Hocevar.
"             See http://sam.zoy.org/wtfpl/COPYING for more details.
"
"============================================================================

if exists('g:loaded_syntastic_html_tidy_checker')
    finish
endif
let g:loaded_syntastic_html_tidy_checker = 1

let s:save_cpo = &cpo
set cpo&vim

" Checker options {{{1

if !exists('g:syntastic_html_tidy_ignore_errors')
    let g:syntastic_html_tidy_ignore_errors = []
endif

if !exists('g:syntastic_html_tidy_blocklevel_tags')
    let g:syntastic_html_tidy_blocklevel_tags = []
endif

if !exists('g:syntastic_html_tidy_inline_tags')
    let g:syntastic_html_tidy_inline_tags = []
endif

if !exists('g:syntastic_html_tidy_empty_tags')
    let g:syntastic_html_tidy_empty_tags = []
endif

" }}}1

" Constants {{{1

let s:IGNORE_ERRORS = [
        \ "<table> lacks \"summary\" attribute",
        \ "not approved by W3C",
        \ "<input> proprietary attribute \"placeholder\"",
        \ "<meta> proprietary attribute \"charset\"",
        \ "<meta> lacks \"content\" attribute",
        \ "inserting \"type\" attribute",
        \ "proprietary attribute \"data-",
        \ "missing <!DOCTYPE> declaration",
        \ "inserting implicit <body>",
        \ "inserting missing 'title' element",
        \ "unescaped & or unknown entity",
        \ "<input> attribute \"type\" has invalid value",
        \ "proprietary attribute \"role\"",
        \ "proprietary attribute \"aria-activedescendant\"",
        \ "proprietary attribute \"aria-atomic\"",
        \ "proprietary attribute \"aria-autocomplete\"",
        \ "proprietary attribute \"aria-busy\"",
        \ "proprietary attribute \"aria-checked\"",
        \ "proprietary attribute \"aria-controls\"",
        \ "proprietary attribute \"aria-describedby\"",
        \ "proprietary attribute \"aria-disabled\"",
        \ "proprietary attribute \"aria-dropeffect\"",
        \ "proprietary attribute \"aria-expanded\"",
        \ "proprietary attribute \"aria-flowto\"",
        \ "proprietary attribute \"aria-grabbed\"",
        \ "proprietary attribute \"aria-haspopup\"",
        \ "proprietary attribute \"aria-hidden\"",
        \ "proprietary attribute \"aria-invalid\"",
        \ "proprietary attribute \"aria-label\"",
        \ "proprietary attribute \"aria-labelledby\"",
        \ "proprietary attribute \"aria-level\"",
        \ "proprietary attribute \"aria-live\"",
        \ "proprietary attribute \"aria-multiline\"",
        \ "proprietary attribute \"aria-multiselectable\"",
        \ "proprietary attribute \"aria-orientation\"",
        \ "proprietary attribute \"aria-owns\"",
        \ "proprietary attribute \"aria-posinset\"",
        \ "proprietary attribute \"aria-pressed\"",
        \ "proprietary attribute \"aria-readonly\"",
        \ "proprietary attribute \"aria-relevant\"",
        \ "proprietary attribute \"aria-relevant\"",
        \ "proprietary attribute \"aria-required\"",
        \ "proprietary attribute \"aria-selected\"",
        \ "proprietary attribute \"aria-setsize\"",
        \ "proprietary attribute \"aria-sort\"",
        \ "proprietary attribute \"aria-valuemax\"",
        \ "proprietary attribute \"aria-valuemin\"",
        \ "proprietary attribute \"aria-valuenow\"",
        \ "proprietary attribute \"aria-valuetext\""
    \ ]
lockvar! s:IGNORE_ERRORS

let s:BLOCKLEVEL_TAGS = [
        \ 'main',
        \ 'section',
        \ 'article',
        \ 'aside',
        \ 'header',
        \ 'footer',
        \ 'nav',
        \ 'figure',
        \ 'figcaption'
    \ ]
lockvar! s:BLOCKLEVEL_TAGS

let s:INLINE_TAGS = [
        \ 'video',
        \ 'audio',
        \ 'source',
        \ 'embed',
        \ 'mark',
        \ 'progress',
        \ 'meter',
        \ 'time',
        \ 'ruby',
        \ 'rt',
        \ 'rp',
        \ 'canvas',
        \ 'command',
        \ 'details',
        \ 'datalist'
    \ ]
lockvar! s:INLINE_TAGS

let s:EMPTY_TAGS = [
        \ 'wbr',
        \ 'keygen'
    \ ]
lockvar! s:EMPTY_TAGS

" }}}1

function! SyntaxCheckers_html_tidy_GetLocList() dict " {{{1
    let makeprg = self.makeprgBuild({ 'args_after': s:Args() })

    let errorformat =
        \ '%Wline %l column %v - Warning: %m,' .
        \ '%Eline %l column %v - Error: %m,' .
        \ '%-G%.%#'

    let loclist = SyntasticMake({
        \ 'makeprg': makeprg,
        \ 'errorformat': errorformat,
        \ 'defaults': {'bufnr': bufnr('')},
        \ 'returns': [0, 1, 2] })

    " filter out valid HTML5 from the errors
    for e in loclist
        if e['valid'] && s:IgnoreError(e['text']) == 1
            let e['valid'] = 0
        endif
    endfor

    return loclist
endfunction " }}}1

" Utilities {{{1

" TODO: join this with xhtml.vim for DRY's sake?
function! s:TidyEncOptByFenc() " {{{2
    let TIDY_OPTS = {
            \ 'utf-8':        '-utf8',
            \ 'ascii':        '-ascii',
            \ 'latin1':       '-latin1',
            \ 'iso-2022-jp':  '-iso-2022',
            \ 'cp1252':       '-win1252',
            \ 'macroman':     '-mac',
            \ 'utf-16le':     '-utf16le',
            \ 'utf-16':       '-utf16',
            \ 'big5':         '-big5',
            \ 'cp932':        '-shiftjis',
            \ 'sjis':         '-shiftjis',
            \ 'cp850':        '-ibm858',
        \ }
    return get(TIDY_OPTS, &fileencoding, '-utf8')
endfunction " }}}2

function! s:IgnoreError(text) " {{{2
    for item in s:IGNORE_ERRORS + g:syntastic_html_tidy_ignore_errors
        if stridx(a:text, item) != -1
            return 1
        endif
    endfor
    return 0
endfunction " }}}2

function! s:NewTags(name) " {{{2
    return syntastic#util#shescape(join( s:{toupper(a:name)} + g:syntastic_html_tidy_{a:name}, ',' ))
endfunction " }}}2

function! s:Args() " {{{2
    let args = s:TidyEncOptByFenc() .
        \ ' --new-blocklevel-tags ' . s:NewTags('blocklevel_tags') .
        \ ' --new-inline-tags ' . s:NewTags('inline_tags') .
        \ ' --new-empty-tags ' . s:NewTags('empty_tags') .
        \ ' -e'
    return args
endfunction " }}}2

" }}}1

call g:SyntasticRegistry.CreateAndRegisterChecker({
    \ 'filetype': 'html',
    \ 'name': 'tidy'})

let &cpo = s:save_cpo
unlet s:save_cpo

" vim: set sw=4 sts=4 et fdm=marker: