1 | | /** |
2 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
3 | | * MIT Licensed |
4 | | */ |
5 | 1 | var HTMLHint = (function (undefined) { |
6 | | |
7 | 1 | var HTMLHint = {}; |
8 | | |
9 | 1 | HTMLHint.version = '@VERSION'; |
10 | | |
11 | 1 | HTMLHint.rules = {}; |
12 | | |
13 | | //默认配置 |
14 | 1 | HTMLHint.defaultRuleset = { |
15 | | 'tagname-lowercase': true, |
16 | | 'attr-lowercase': true, |
17 | | 'attr-value-double-quotes': true, |
18 | | 'doctype-first': true, |
19 | | 'tag-pair': true, |
20 | | 'spec-char-escape': true, |
21 | | 'id-unique': true, |
22 | | 'src-not-empty': true, |
23 | | 'attr-no-duplication': true |
24 | | }; |
25 | | |
26 | 1 | HTMLHint.addRule = function(rule){ |
27 | 22 | HTMLHint.rules[rule.id] = rule; |
28 | | }; |
29 | | |
30 | 1 | HTMLHint.verify = function(html, ruleset){ |
31 | | // parse inline ruleset |
32 | 98 | html = html.replace(/^\s*<!--\s*htmlhint\s+([^\r\n]+?)\s*-->/i, function(all, strRuleset){ |
33 | 2 | if(ruleset === undefined){ |
34 | 0 | ruleset = {}; |
35 | | } |
36 | 2 | strRuleset.replace(/(?:^|,)\s*([^:]+)\s*:\s*([^,\s]+)/g, function(all, key, value){ |
37 | 2 | if(value === 'false'){ |
38 | 1 | value = false; |
39 | | } |
40 | 1 | else if(value === 'true'){ |
41 | 1 | value = true; |
42 | | } |
43 | 2 | ruleset[key] = value; |
44 | | }); |
45 | 2 | return ''; |
46 | | }); |
47 | | |
48 | 98 | if(ruleset === undefined || Object.keys(ruleset).length ===0){ |
49 | 3 | ruleset = HTMLHint.defaultRuleset; |
50 | | } |
51 | | |
52 | 98 | var parser = new HTMLParser(); |
53 | 98 | var reporter = new HTMLHint.Reporter(html.split(/\r?\n/), ruleset); |
54 | | |
55 | 98 | var rules = HTMLHint.rules, |
56 | | rule; |
57 | 98 | for (var id in ruleset){ |
58 | 122 | rule = rules[id]; |
59 | 122 | if (rule !== undefined && ruleset[id] !== false){ |
60 | 119 | rule.init(parser, reporter, ruleset[id]); |
61 | | } |
62 | | } |
63 | | |
64 | 98 | parser.parse(html); |
65 | | |
66 | 98 | return reporter.messages; |
67 | | }; |
68 | | |
69 | 1 | return HTMLHint; |
70 | | |
71 | | })(); |
72 | | |
73 | 1 | if (typeof exports === 'object' && exports){ |
74 | 1 | exports.HTMLHint = HTMLHint; |
75 | | } |
76 | | /** |
77 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
78 | | * MIT Licensed |
79 | | */ |
80 | 1 | (function(HTMLHint, undefined){ |
81 | | |
82 | 1 | var Reporter = function(){ |
83 | 98 | var self = this; |
84 | 98 | self._init.apply(self,arguments); |
85 | | }; |
86 | | |
87 | 1 | Reporter.prototype = { |
88 | | _init: function(lines, ruleset){ |
89 | 98 | var self = this; |
90 | 98 | self.lines = lines; |
91 | 98 | self.ruleset = ruleset; |
92 | 98 | self.messages = []; |
93 | | }, |
94 | | //错误 |
95 | | error: function(message, line, col, rule, raw){ |
96 | 52 | this.report('error', message, line, col, rule, raw); |
97 | | }, |
98 | | //警告 |
99 | | warn: function(message, line, col, rule, raw){ |
100 | 55 | this.report('warning', message, line, col, rule, raw); |
101 | | }, |
102 | | //信息 |
103 | | info: function(message, line, col, rule, raw){ |
104 | 0 | this.report('info', message, line, col, rule, raw); |
105 | | }, |
106 | | //报告 |
107 | | report: function(type, message, line, col, rule, raw){ |
108 | 107 | var self = this; |
109 | 107 | self.messages.push({ |
110 | | type: type, |
111 | | message: message, |
112 | | raw: raw, |
113 | | evidence: self.lines[line-1], |
114 | | line: line, |
115 | | col: col, |
116 | | rule: { |
117 | | id: rule.id, |
118 | | description: rule.description, |
119 | | link: 'https://github.com/yaniswang/HTMLHint/wiki/' + rule.id |
120 | | } |
121 | | }); |
122 | | } |
123 | | }; |
124 | | |
125 | 1 | HTMLHint.Reporter = Reporter; |
126 | | |
127 | | })(HTMLHint); |
128 | | /** |
129 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
130 | | * MIT Licensed |
131 | | */ |
132 | 1 | var HTMLParser = (function(undefined){ |
133 | | |
134 | 1 | var HTMLParser = function(){ |
135 | 123 | var self = this; |
136 | 123 | self._init.apply(self,arguments); |
137 | | }; |
138 | | |
139 | 1 | HTMLParser.prototype = { |
140 | | _init: function(){ |
141 | 123 | var self = this; |
142 | 123 | self._listeners = {}; |
143 | 123 | self._mapCdataTags = self.makeMap("script,style"); |
144 | 123 | self._arrBlocks = []; |
145 | | }, |
146 | | |
147 | | makeMap: function(str){ |
148 | 131 | var obj = {}, items = str.split(","); |
149 | 131 | for ( var i = 0; i < items.length; i++ ){ |
150 | 358 | obj[ items[i] ] = true; |
151 | | } |
152 | 131 | return obj; |
153 | | }, |
154 | | |
155 | | // parse html code |
156 | | parse: function(html){ |
157 | | |
158 | 123 | var self = this, |
159 | | mapCdataTags = self._mapCdataTags; |
160 | | |
161 | 123 | var regTag=/<(?:\/([^\s>]+)\s*|!--([\s\S]*?)--|!([^>]*?)|([\w\-:]+)((?:\s+[\w\-:]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s"']+))?)*?)\s*(\/?))>/g, |
162 | | regAttr = /\s*([\w\-:]+)(?:\s*=\s*(?:(")([^"]*)"|(')([^']*)'|([^\s"']+)))?/g, |
163 | | regLine = /\r?\n/g; |
164 | | |
165 | 123 | var match, matchIndex, lastIndex = 0, tagName, arrAttrs, tagCDATA, attrsCDATA, arrCDATA, lastCDATAIndex = 0, text; |
166 | 123 | var lastLineIndex = 0, line = 1; |
167 | 123 | var arrBlocks = self._arrBlocks; |
168 | | |
169 | 123 | self.fire('start', { |
170 | | pos: 0, |
171 | | line: 1, |
172 | | col: 1 |
173 | | }); |
174 | | |
175 | 123 | while((match = regTag.exec(html))){ |
176 | 288 | matchIndex = match.index; |
177 | 288 | if(matchIndex > lastIndex){//保存前面的文本或者CDATA |
178 | 80 | text = html.substring(lastIndex, matchIndex); |
179 | 80 | if(tagCDATA){ |
180 | 12 | arrCDATA.push(text); |
181 | | } |
182 | | else{//文本 |
183 | 68 | saveBlock('text', text, lastIndex); |
184 | | } |
185 | | } |
186 | 288 | lastIndex = regTag.lastIndex; |
187 | | |
188 | 288 | if((tagName = match[1])){ |
189 | 99 | if(tagCDATA && tagName === tagCDATA){//结束标签前输出CDATA |
190 | 19 | text = arrCDATA.join(''); |
191 | 19 | saveBlock('cdata', text, lastCDATAIndex, { |
192 | | 'tagName': tagCDATA, |
193 | | 'attrs': attrsCDATA |
194 | | }); |
195 | 19 | tagCDATA = null; |
196 | 19 | attrsCDATA = null; |
197 | 19 | arrCDATA = null; |
198 | | } |
199 | 99 | if(!tagCDATA){ |
200 | | //标签结束 |
201 | 98 | saveBlock('tagend', match[0], matchIndex, { |
202 | | 'tagName': tagName |
203 | | }); |
204 | 98 | continue; |
205 | | } |
206 | | } |
207 | | |
208 | 190 | if(tagCDATA){ |
209 | 3 | arrCDATA.push(match[0]); |
210 | | } |
211 | | else{ |
212 | 187 | if((tagName = match[4])){//标签开始 |
213 | 174 | arrAttrs = []; |
214 | 174 | var attrs = match[5], |
215 | | attrMatch, |
216 | | attrMatchCount = 0; |
217 | 174 | while((attrMatch = regAttr.exec(attrs))){ |
218 | 167 | var name = attrMatch[1], |
219 | | quote = attrMatch[2] ? attrMatch[2] : |
220 | | attrMatch[4] ? attrMatch[4] : '', |
221 | | value = attrMatch[3] ? attrMatch[3] : |
222 | | attrMatch[5] ? attrMatch[5] : |
223 | | attrMatch[6] ? attrMatch[6] : ''; |
224 | 167 | arrAttrs.push({'name': name, 'value': value, 'quote': quote, 'index': attrMatch.index, 'raw': attrMatch[0]}); |
225 | 167 | attrMatchCount += attrMatch[0].length; |
226 | | } |
227 | 174 | if(attrMatchCount === attrs.length){ |
228 | 174 | saveBlock('tagstart', match[0], matchIndex, { |
229 | | 'tagName': tagName, |
230 | | 'attrs': arrAttrs, |
231 | | 'close': match[6] |
232 | | }); |
233 | 174 | if(mapCdataTags[tagName]){ |
234 | 19 | tagCDATA = tagName; |
235 | 19 | attrsCDATA = arrAttrs.concat(); |
236 | 19 | arrCDATA = []; |
237 | 19 | lastCDATAIndex = lastIndex; |
238 | | } |
239 | | } |
240 | | else{//如果出现漏匹配,则把当前内容匹配为text |
241 | 0 | saveBlock('text', match[0], matchIndex); |
242 | | } |
243 | | } |
244 | 13 | else if(match[2] || match[3]){//注释标签 |
245 | 13 | saveBlock('comment', match[0], matchIndex, { |
246 | | 'content': match[2] || match[3], |
247 | | 'long': match[2]?true:false |
248 | | }); |
249 | | } |
250 | | } |
251 | | } |
252 | | |
253 | 123 | if(html.length > lastIndex){ |
254 | | //结尾文本 |
255 | 13 | text = html.substring(lastIndex, html.length); |
256 | 13 | saveBlock('text', text, lastIndex); |
257 | | } |
258 | | |
259 | 123 | self.fire('end', { |
260 | | pos: lastIndex, |
261 | | line: line, |
262 | | col: lastIndex - lastLineIndex + 1 |
263 | | }); |
264 | | |
265 | | //存储区块 |
266 | 123 | function saveBlock(type, raw, pos, data){ |
267 | 385 | var col = pos - lastLineIndex + 1; |
268 | 385 | if(data === undefined){ |
269 | 81 | data = {}; |
270 | | } |
271 | 385 | data.raw = raw; |
272 | 385 | data.pos = pos; |
273 | 385 | data.line = line; |
274 | 385 | data.col = col; |
275 | 385 | arrBlocks.push(data); |
276 | 385 | self.fire(type, data); |
277 | 385 | var lineMatch; |
278 | 385 | while((lineMatch = regLine.exec(raw))){ |
279 | 22 | line ++; |
280 | 22 | lastLineIndex = pos + regLine.lastIndex; |
281 | | } |
282 | | } |
283 | | |
284 | | }, |
285 | | |
286 | | // add event |
287 | | addListener: function(types, listener){ |
288 | 165 | var _listeners = this._listeners; |
289 | 165 | var arrTypes = types.split(/[,\s]/), type; |
290 | 165 | for(var i=0, l = arrTypes.length;i<l;i++){ |
291 | 170 | type = arrTypes[i]; |
292 | 170 | if (_listeners[type] === undefined){ |
293 | 149 | _listeners[type] = []; |
294 | | } |
295 | 170 | _listeners[type].push(listener); |
296 | | } |
297 | | }, |
298 | | |
299 | | // fire event |
300 | | fire: function(type, data){ |
301 | 631 | if (data === undefined){ |
302 | 0 | data = {}; |
303 | | } |
304 | 631 | data.type = type; |
305 | 631 | var self = this, |
306 | | listeners = [], |
307 | | listenersType = self._listeners[type], |
308 | | listenersAll = self._listeners['all']; |
309 | 631 | if (listenersType !== undefined){ |
310 | 190 | listeners = listeners.concat(listenersType); |
311 | | } |
312 | 631 | if (listenersAll !== undefined){ |
313 | 137 | listeners = listeners.concat(listenersAll); |
314 | | } |
315 | 631 | for (var i = 0, l = listeners.length; i < l; i++){ |
316 | 354 | listeners[i].call(self, data); |
317 | | } |
318 | | }, |
319 | | |
320 | | // remove event |
321 | | removeListener: function(type, listener){ |
322 | 23 | var listenersType = this._listeners[type]; |
323 | 23 | if(listenersType !== undefined){ |
324 | 21 | for (var i = 0, l = listenersType.length; i < l; i++){ |
325 | 14 | if (listenersType[i] === listener){ |
326 | 14 | listenersType.splice(i, 1); |
327 | 14 | break; |
328 | | } |
329 | | } |
330 | | } |
331 | | }, |
332 | | |
333 | | //fix pos if event.raw have \n |
334 | | fixPos: function(event, index){ |
335 | 8 | var text = event.raw.substr(0, index); |
336 | 8 | var arrLines = text.split(/\r?\n/), |
337 | | lineCount = arrLines.length - 1, |
338 | | line = event.line, col; |
339 | 8 | if(lineCount > 0){ |
340 | 2 | line += lineCount; |
341 | 2 | col = arrLines[lineCount].length + 1; |
342 | | } |
343 | | else{ |
344 | 6 | col = event.col + index; |
345 | | } |
346 | 8 | return { |
347 | | line: line, |
348 | | col: col |
349 | | }; |
350 | | }, |
351 | | |
352 | | // covert array type of attrs to map |
353 | | getMapAttrs: function(arrAttrs){ |
354 | 33 | var mapAttrs = {}, |
355 | | attr; |
356 | 33 | for(var i=0,l=arrAttrs.length;i<l;i++){ |
357 | 31 | attr = arrAttrs[i]; |
358 | 31 | mapAttrs[attr.name] = attr.value; |
359 | | } |
360 | 33 | return mapAttrs; |
361 | | } |
362 | | }; |
363 | | |
364 | 1 | return HTMLParser; |
365 | | |
366 | | })(); |
367 | | |
368 | 1 | if (typeof exports === 'object' && exports){ |
369 | 1 | exports.HTMLParser = HTMLParser; |
370 | | } |
371 | | /** |
372 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
373 | | * Copyright (c) 2014, Takeshi Kurosawa <taken.spc@gmail.com> |
374 | | * MIT Licensed |
375 | | */ |
376 | 1 | HTMLHint.addRule({ |
377 | | id: 'alt-require', |
378 | | description: 'Alt of img must be present and alt of area[href] and input[type=image] must be set value.', |
379 | | init: function(parser, reporter){ |
380 | 14 | var self = this; |
381 | 14 | parser.addListener('tagstart', function(event){ |
382 | 14 | var tagName = event.tagName.toLowerCase(), |
383 | | mapAttrs = parser.getMapAttrs(event.attrs), |
384 | | col = event.col + tagName.length + 1, |
385 | | selector; |
386 | 14 | if(tagName === 'img' && !('alt' in mapAttrs)){ |
387 | 2 | reporter.warn('Alt of img tag must be present.', event.line, col, self, event.raw); |
388 | | } |
389 | 12 | else if((tagName === 'area' && 'href' in mapAttrs) || |
390 | | (tagName === 'input' && mapAttrs['type'] === 'image')){ |
391 | 6 | if(!('alt' in mapAttrs) || mapAttrs['alt'] === ''){ |
392 | 4 | selector = tagName === 'area' ? 'area[href]' : 'input[type=image]'; |
393 | 4 | reporter.warn('Alt of ' + selector + ' must be set value.', event.line, col, self, event.raw); |
394 | | } |
395 | | } |
396 | | }); |
397 | | } |
398 | | }); |
399 | | |
400 | | /** |
401 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
402 | | * MIT Licensed |
403 | | */ |
404 | 1 | HTMLHint.addRule({ |
405 | | id: 'attr-lowercase', |
406 | | description: 'Attribute name must be lowercase.', |
407 | | init: function(parser, reporter){ |
408 | 5 | var self = this; |
409 | 5 | parser.addListener('tagstart', function(event){ |
410 | 9 | var attrs = event.attrs, |
411 | | attr, |
412 | | col = event.col + event.tagName.length + 1; |
413 | 9 | for(var i=0, l=attrs.length;i<l;i++){ |
414 | 15 | attr = attrs[i]; |
415 | 15 | var attrName = attr.name; |
416 | 15 | if(attrName !== attrName.toLowerCase()){ |
417 | 4 | reporter.error('Attribute name [ '+attrName+' ] must be lower case.', event.line, col + attr.index, self, attr.raw); |
418 | | } |
419 | | } |
420 | | }); |
421 | | } |
422 | | }); |
423 | | /** |
424 | | * Copyright (c) 2014, Yanis Wang <yanis.wang@gmail.com> |
425 | | * MIT Licensed |
426 | | */ |
427 | 1 | HTMLHint.addRule({ |
428 | | id: 'attr-no-duplication', |
429 | | description: 'Attribute name can not been duplication.', |
430 | | init: function(parser, reporter){ |
431 | 5 | var self = this; |
432 | 5 | parser.addListener('tagstart', function(event){ |
433 | 9 | var attrs = event.attrs; |
434 | 9 | var attr; |
435 | 9 | var attrName; |
436 | 9 | var col = event.col + event.tagName.length + 1; |
437 | | |
438 | 9 | var mapAttrName = {}; |
439 | 9 | for(var i=0, l=attrs.length;i<l;i++){ |
440 | 16 | attr = attrs[i]; |
441 | 16 | attrName = attr.name; |
442 | 16 | if(mapAttrName[attrName] === true){ |
443 | 3 | reporter.error('The name of attribute [ '+attr.name+' ] been duplication.', event.line, col + attr.index, self, attr.raw); |
444 | | } |
445 | 16 | mapAttrName[attrName] = true; |
446 | | } |
447 | | }); |
448 | | } |
449 | | }); |
450 | | /** |
451 | | * Copyright (c) 2014, Yanis Wang <yanis.wang@gmail.com> |
452 | | * MIT Licensed |
453 | | */ |
454 | 1 | HTMLHint.addRule({ |
455 | | id: 'attr-unsafe-chars', |
456 | | description: 'Attribute value cant not use unsafe chars.', |
457 | | init: function(parser, reporter){ |
458 | 2 | var self = this; |
459 | 2 | parser.addListener('tagstart', function(event){ |
460 | 2 | var attrs = event.attrs, |
461 | | attr, |
462 | | col = event.col + event.tagName.length + 1; |
463 | 2 | var regUnsafe = /[\u0000-\u001f\u007f-\u009f\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/; |
464 | 2 | for(var i=0, l=attrs.length;i<l;i++){ |
465 | 2 | attr = attrs[i]; |
466 | 2 | if(regUnsafe.test(attr.value) === true){ |
467 | 1 | reporter.warn('The value of attribute [ '+attr.name+' ] cant not use unsafe chars.', event.line, col + attr.index, self, attr.raw); |
468 | | } |
469 | | } |
470 | | }); |
471 | | } |
472 | | }); |
473 | | /** |
474 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
475 | | * MIT Licensed |
476 | | */ |
477 | 1 | HTMLHint.addRule({ |
478 | | id: 'attr-value-double-quotes', |
479 | | description: 'Attribute value must closed by double quotes.', |
480 | | init: function(parser, reporter){ |
481 | 5 | var self = this; |
482 | 5 | parser.addListener('tagstart', function(event){ |
483 | 9 | var attrs = event.attrs, |
484 | | attr, |
485 | | col = event.col + event.tagName.length + 1; |
486 | 9 | for(var i=0, l=attrs.length;i<l;i++){ |
487 | 19 | attr = attrs[i]; |
488 | 19 | if((attr.value !== '' && attr.quote !== '"') || |
489 | | (attr.value === '' && attr.quote === "'")){ |
490 | 5 | reporter.error('The value of attribute [ '+attr.name+' ] must closed by double quotes.', event.line, col + attr.index, self, attr.raw); |
491 | | } |
492 | | } |
493 | | }); |
494 | | } |
495 | | }); |
496 | | /** |
497 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
498 | | * MIT Licensed |
499 | | */ |
500 | 1 | HTMLHint.addRule({ |
501 | | id: 'attr-value-not-empty', |
502 | | description: 'Attribute must set value.', |
503 | | init: function(parser, reporter){ |
504 | 3 | var self = this; |
505 | 3 | parser.addListener('tagstart', function(event){ |
506 | 3 | var attrs = event.attrs, |
507 | | attr, |
508 | | col = event.col + event.tagName.length + 1; |
509 | 3 | for(var i=0, l=attrs.length;i<l;i++){ |
510 | 3 | attr = attrs[i]; |
511 | 3 | if(attr.quote === '' && attr.value === ''){ |
512 | 1 | reporter.warn('The attribute [ '+attr.name+' ] must set value.', event.line, col + attr.index, self, attr.raw); |
513 | | } |
514 | | } |
515 | | }); |
516 | | } |
517 | | }); |
518 | | /** |
519 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
520 | | * MIT Licensed |
521 | | */ |
522 | 1 | HTMLHint.addRule({ |
523 | | id: 'csslint', |
524 | | description: 'Scan css with csslint.', |
525 | | init: function(parser, reporter, options){ |
526 | 1 | var self = this; |
527 | 1 | parser.addListener('cdata', function(event){ |
528 | 1 | if(event.tagName.toLowerCase() === 'style'){ |
529 | | |
530 | 1 | var cssVerify; |
531 | | |
532 | 1 | if(typeof exports === 'object' && require){ |
533 | 1 | cssVerify = require("csslint").CSSLint.verify; |
534 | | } |
535 | | else{ |
536 | 0 | cssVerify = CSSLint.verify; |
537 | | } |
538 | | |
539 | 1 | if(options !== undefined){ |
540 | 1 | var styleLine = event.line - 1, |
541 | | styleCol = event.col - 1; |
542 | 1 | try{ |
543 | 1 | var messages = cssVerify(event.raw, options).messages; |
544 | 1 | messages.forEach(function(error){ |
545 | 2 | var line = error.line; |
546 | 2 | reporter[error.type==='warning'?'warn':'error']('['+error.rule.id+'] '+error.message, styleLine + line, (line === 1 ? styleCol : 0) + error.col, self, error.evidence); |
547 | | }); |
548 | | } |
549 | | catch(e){} |
550 | | } |
551 | | |
552 | | } |
553 | | }); |
554 | | } |
555 | | }); |
556 | | /** |
557 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
558 | | * MIT Licensed |
559 | | */ |
560 | 1 | HTMLHint.addRule({ |
561 | | id: 'doctype-first', |
562 | | description: 'Doctype must be first.', |
563 | | init: function(parser, reporter){ |
564 | 5 | var self = this; |
565 | 5 | var allEvent = function(event){ |
566 | 10 | if(event.type === 'start' || (event.type === 'text' && /^\s*$/.test(event.raw))){ |
567 | 5 | return; |
568 | | } |
569 | 5 | if((event.type !== 'comment' && event.long === false) || /^DOCTYPE\s+/i.test(event.content) === false){ |
570 | 4 | reporter.error('Doctype must be first.', event.line, event.col, self, event.raw); |
571 | | } |
572 | 5 | parser.removeListener('all', allEvent); |
573 | | }; |
574 | 5 | parser.addListener('all', allEvent); |
575 | | } |
576 | | }); |
577 | | /** |
578 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
579 | | * MIT Licensed |
580 | | */ |
581 | 1 | HTMLHint.addRule({ |
582 | | id: 'doctype-html5', |
583 | | description: 'Doctype must be html5.', |
584 | | init: function(parser, reporter){ |
585 | 2 | var self = this; |
586 | 2 | function onComment(event){ |
587 | 9 | if(event.long === false && event.content.toLowerCase() !== 'doctype html'){ |
588 | 1 | reporter.warn('Doctype must be html5.', event.line, event.col, self, event.raw); |
589 | | } |
590 | | } |
591 | 2 | function onTagStart(){ |
592 | 2 | parser.removeListener('comment', onComment); |
593 | 2 | parser.removeListener('tagstart', onTagStart); |
594 | | } |
595 | 2 | parser.addListener('all', onComment); |
596 | 2 | parser.addListener('tagstart', onTagStart); |
597 | | } |
598 | | }); |
599 | | /** |
600 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
601 | | * MIT Licensed |
602 | | */ |
603 | 1 | HTMLHint.addRule({ |
604 | | id: 'head-script-disabled', |
605 | | description: 'The script tag can not be used in head.', |
606 | | init: function(parser, reporter){ |
607 | 7 | var self = this; |
608 | 7 | var reScript = /^(text\/javascript|application\/javascript)$/i; |
609 | 7 | function onTagStart(event){ |
610 | 13 | var mapAttrs = parser.getMapAttrs(event.attrs); |
611 | 13 | var type = mapAttrs.type; |
612 | 13 | if(event.tagName.toLowerCase() === 'script' && |
613 | | (!type || reScript.test(type) === true)){ |
614 | 4 | reporter.warn('The script tag can not be used in head.', event.line, event.col, self, event.raw); |
615 | | } |
616 | | } |
617 | 7 | function onTagEnd(event){ |
618 | 15 | if(event.tagName.toLowerCase() === 'head'){ |
619 | 7 | parser.removeListener('tagstart', onTagStart); |
620 | 7 | parser.removeListener('tagstart', onTagEnd); |
621 | | } |
622 | | } |
623 | 7 | parser.addListener('tagstart', onTagStart); |
624 | 7 | parser.addListener('tagend', onTagEnd); |
625 | | } |
626 | | }); |
627 | | /** |
628 | | * Copyright (c) 2014, Yanis Wang <yanis.wang@gmail.com> |
629 | | * MIT Licensed |
630 | | */ |
631 | 1 | HTMLHint.addRule({ |
632 | | id: 'href-abs-or-rel', |
633 | | description: 'Href must be absolute or relative.', |
634 | | init: function(parser, reporter, options){ |
635 | 4 | var self = this; |
636 | | |
637 | 4 | var hrefMode = options === 'abs' ? 'absolute' : 'relative'; |
638 | | |
639 | 4 | parser.addListener('tagstart', function(event){ |
640 | 16 | var attrs = event.attrs; |
641 | 16 | var attr; |
642 | 16 | var col = event.col + event.tagName.length + 1; |
643 | | |
644 | 16 | for(var i=0, l=attrs.length;i<l;i++){ |
645 | 16 | attr = attrs[i]; |
646 | 16 | if(attr.name === 'href'){ |
647 | 16 | if((hrefMode === 'absolute' && /^\w+?:/.test(attr.value) === false) || |
648 | | (hrefMode === 'relative' && /^https?:\/\//.test(attr.value) === true)){ |
649 | 4 | reporter.warn('The value of href [ '+attr.value+' ] must be '+hrefMode+'.', event.line, col + attr.index, self, attr.raw); |
650 | | } |
651 | 16 | break; |
652 | | } |
653 | | } |
654 | | }); |
655 | | } |
656 | | }); |
657 | | /** |
658 | | * Copyright (c) 2014, Yanis Wang <yanis.wang@gmail.com> |
659 | | * MIT Licensed |
660 | | */ |
661 | 1 | HTMLHint.addRule({ |
662 | | id: 'id-class-ad-disabled', |
663 | | description: 'Id and class can not use ad keyword, it will blocked by adblock software.', |
664 | | init: function(parser, reporter){ |
665 | 17 | var self = this; |
666 | 17 | parser.addListener('tagstart', function(event){ |
667 | 17 | var attrs = event.attrs; |
668 | 17 | var attr; |
669 | 17 | var attrName; |
670 | 17 | var col = event.col + event.tagName.length + 1; |
671 | | |
672 | 17 | for(var i=0, l=attrs.length;i<l;i++){ |
673 | 20 | attr = attrs[i]; |
674 | 20 | attrName = attr.name; |
675 | 20 | if(/^(id|class)$/i.test(attrName)){ |
676 | 20 | if(/(^|[-\_])ad([-\_]|$)/i.test(attr.value)){ |
677 | 14 | reporter.warn('The value of '+attrName+' can not use ad keyword.', event.line, col + attr.index, self, attr.raw); |
678 | | } |
679 | | } |
680 | | } |
681 | | }); |
682 | | } |
683 | | }); |
684 | | /** |
685 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
686 | | * MIT Licensed |
687 | | */ |
688 | 1 | HTMLHint.addRule({ |
689 | | id: 'id-class-value', |
690 | | description: 'Id and class value must meet some rules.', |
691 | | init: function(parser, reporter, options){ |
692 | 8 | var self = this; |
693 | 8 | var arrRules = { |
694 | | 'underline': { |
695 | | 'regId': /^[a-z\d]+(_[a-z\d]+)*$/, |
696 | | 'message': 'Id and class value must lower case and split by underline.' |
697 | | }, |
698 | | 'dash': { |
699 | | 'regId': /^[a-z\d]+(-[a-z\d]+)*$/, |
700 | | 'message': 'Id and class value must lower case and split by dash.' |
701 | | }, |
702 | | 'hump': { |
703 | | 'regId': /^[a-z][a-zA-Z\d]*([A-Z][a-zA-Z\d]*)*$/, |
704 | | 'message': 'Id and class value must meet hump style.' |
705 | | } |
706 | | }, rule; |
707 | 8 | if(typeof options === 'string'){ |
708 | 6 | rule = arrRules[options]; |
709 | | } |
710 | | else{ |
711 | 2 | rule = options; |
712 | | } |
713 | 8 | if(rule && rule.regId){ |
714 | 8 | var regId = rule.regId, |
715 | | message = rule.message; |
716 | 8 | parser.addListener('tagstart', function(event){ |
717 | 8 | var attrs = event.attrs, |
718 | | attr, |
719 | | col = event.col + event.tagName.length + 1; |
720 | 8 | for(var i=0, l1=attrs.length;i<l1;i++){ |
721 | 16 | attr = attrs[i]; |
722 | 16 | if(attr.name.toLowerCase() === 'id'){ |
723 | 8 | if(regId.test(attr.value) === false){ |
724 | 4 | reporter.warn(message, event.line, col + attr.index, self, attr.raw); |
725 | | } |
726 | | } |
727 | 16 | if(attr.name.toLowerCase() === 'class'){ |
728 | 8 | var arrClass = attr.value.split(/\s+/g), classValue; |
729 | 8 | for(var j=0, l2=arrClass.length;j<l2;j++){ |
730 | 8 | classValue = arrClass[j]; |
731 | 8 | if(classValue && regId.test(classValue) === false){ |
732 | 4 | reporter.warn(message, event.line, col + attr.index, self, classValue); |
733 | | } |
734 | | } |
735 | | } |
736 | | } |
737 | | }); |
738 | | } |
739 | | } |
740 | | }); |
741 | | /** |
742 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
743 | | * MIT Licensed |
744 | | */ |
745 | 1 | HTMLHint.addRule({ |
746 | | id: 'id-unique', |
747 | | description: 'Id must be unique.', |
748 | | init: function(parser, reporter){ |
749 | 5 | var self = this; |
750 | 5 | var mapIdCount = {}; |
751 | 5 | parser.addListener('tagstart', function(event){ |
752 | 11 | var attrs = event.attrs, |
753 | | attr, |
754 | | id, |
755 | | col = event.col + event.tagName.length + 1; |
756 | 11 | for(var i=0, l=attrs.length;i<l;i++){ |
757 | 17 | attr = attrs[i]; |
758 | 17 | if(attr.name.toLowerCase() === 'id'){ |
759 | 8 | id = attr.value; |
760 | 8 | if(id){ |
761 | 8 | if(mapIdCount[id] === undefined){ |
762 | 5 | mapIdCount[id] = 1; |
763 | | } |
764 | | else{ |
765 | 3 | mapIdCount[id] ++; |
766 | | } |
767 | 8 | if(mapIdCount[id] > 1){ |
768 | 3 | reporter.error('Id redefinition of [ '+id+' ].', event.line, col + attr.index, self, attr.raw); |
769 | | } |
770 | | } |
771 | 8 | break; |
772 | | } |
773 | | } |
774 | | }); |
775 | | } |
776 | | }); |
777 | | /** |
778 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
779 | | * MIT Licensed |
780 | | */ |
781 | 1 | HTMLHint.addRule({ |
782 | | id: 'jshint', |
783 | | description: 'Scan script with jshint.', |
784 | | init: function(parser, reporter, options){ |
785 | 4 | var self = this; |
786 | 4 | parser.addListener('cdata', function(event){ |
787 | 4 | if(event.tagName.toLowerCase() === 'script'){ |
788 | | |
789 | 4 | var mapAttrs = parser.getMapAttrs(event.attrs), |
790 | | type = mapAttrs.type; |
791 | | |
792 | | // Only scan internal javascript |
793 | 4 | if(mapAttrs.src !== undefined || (type && /^(text\/javascript)$/i.test(type) === false)){ |
794 | 2 | return; |
795 | | } |
796 | | |
797 | 2 | var jsVerify; |
798 | | |
799 | 2 | if(typeof exports === 'object' && require){ |
800 | 2 | jsVerify = require('jshint').JSHINT; |
801 | | } |
802 | | else{ |
803 | 0 | jsVerify = JSHINT; |
804 | | } |
805 | | |
806 | 2 | if(options !== undefined){ |
807 | 2 | var styleLine = event.line - 1, |
808 | | styleCol = event.col - 1; |
809 | 2 | var code = event.raw.replace(/\t/g,' '); |
810 | 2 | try{ |
811 | 2 | var status = jsVerify(code, options); |
812 | 2 | if(status === false){ |
813 | 2 | jsVerify.errors.forEach(function(error){ |
814 | 8 | var line = error.line; |
815 | 8 | reporter.warn(error.reason, styleLine + line, (line === 1 ? styleCol : 0) + error.character, self, error.evidence); |
816 | | }); |
817 | | } |
818 | | } |
819 | | catch(e){} |
820 | | } |
821 | | |
822 | | } |
823 | | }); |
824 | | } |
825 | | }); |
826 | | /** |
827 | | * Copyright (c) 2014, Yanis Wang <yanis.wang@gmail.com> |
828 | | * MIT Licensed |
829 | | */ |
830 | 1 | HTMLHint.addRule({ |
831 | | id: 'space-tab-mixed-disabled', |
832 | | description: 'Spaces and tabs can not mixed in front of line.', |
833 | | init: function(parser, reporter){ |
834 | 6 | var self = this; |
835 | 6 | parser.addListener('text', function(event){ |
836 | 12 | var raw = event.raw; |
837 | 12 | var reMixed = /(^|\r?\n)( +\t|\t+ )/g; |
838 | 12 | var match; |
839 | 12 | while((match = reMixed.exec(raw))){ |
840 | 3 | var fixedPos = parser.fixPos(event, match.index + match[1].length); |
841 | 3 | reporter.warn('Mixed spaces and tabs in front of line.', fixedPos.line, 1, self, event.raw); |
842 | | } |
843 | | }); |
844 | | } |
845 | | }); |
846 | | /** |
847 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
848 | | * MIT Licensed |
849 | | */ |
850 | 1 | HTMLHint.addRule({ |
851 | | id: 'spec-char-escape', |
852 | | description: 'Special characters must be escaped.', |
853 | | init: function(parser, reporter){ |
854 | 5 | var self = this; |
855 | 5 | parser.addListener('text', function(event){ |
856 | 5 | var raw = event.raw, |
857 | | reSpecChar = /[<>]/g, |
858 | | match; |
859 | 5 | while((match = reSpecChar.exec(raw))){ |
860 | 5 | var fixedPos = parser.fixPos(event, match.index); |
861 | 5 | reporter.error('Special characters must be escaped : [ '+match[0]+' ].', fixedPos.line, fixedPos.col, self, event.raw); |
862 | | } |
863 | | }); |
864 | | } |
865 | | }); |
866 | | /** |
867 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
868 | | * MIT Licensed |
869 | | */ |
870 | 1 | HTMLHint.addRule({ |
871 | | id: 'src-not-empty', |
872 | | description: 'Src of img(script,link) must set value.', |
873 | | init: function(parser, reporter){ |
874 | 6 | var self = this; |
875 | 6 | parser.addListener('tagstart', function(event){ |
876 | 35 | var tagName = event.tagName, |
877 | | attrs = event.attrs, |
878 | | attr, |
879 | | col = event.col + tagName.length + 1; |
880 | 35 | for(var i=0, l=attrs.length;i<l;i++){ |
881 | 42 | attr = attrs[i]; |
882 | 42 | if(((/^(img|script|embed|bgsound|iframe)$/.test(tagName) === true && attr.name === 'src') || |
883 | | (tagName === 'link' && attr.name === 'href') || |
884 | | (tagName === 'object' && attr.name === 'data')) && |
885 | | attr.value === ''){ |
886 | 16 | reporter.error('[ '+attr.name + '] of [ '+tagName+' ] must set value.', event.line, col + attr.index, self, attr.raw); |
887 | | } |
888 | | } |
889 | | }); |
890 | | } |
891 | | }); |
892 | | /** |
893 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
894 | | * MIT Licensed |
895 | | */ |
896 | 1 | HTMLHint.addRule({ |
897 | | id: 'style-disabled', |
898 | | description: 'Style tag can not be use.', |
899 | | init: function(parser, reporter){ |
900 | 2 | var self = this; |
901 | 2 | parser.addListener('tagstart', function(event){ |
902 | 4 | if(event.tagName.toLowerCase() === 'style'){ |
903 | 1 | reporter.warn('Style tag can not be use.', event.line, event.col, self, event.raw); |
904 | | } |
905 | | }); |
906 | | } |
907 | | }); |
908 | | /** |
909 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
910 | | * MIT Licensed |
911 | | */ |
912 | 1 | HTMLHint.addRule({ |
913 | | id: 'tag-pair', |
914 | | description: 'Tag must be paired.', |
915 | | init: function(parser, reporter){ |
916 | 6 | var self = this; |
917 | 6 | var stack=[], |
918 | | mapEmptyTags = parser.makeMap("area,base,basefont,br,col,frame,hr,img,input,isindex,link,meta,param,embed");//HTML 4.01 |
919 | 6 | parser.addListener('tagstart', function(event){ |
920 | 11 | var tagName = event.tagName.toLowerCase(); |
921 | 11 | if (mapEmptyTags[tagName] === undefined && !event.close){ |
922 | 9 | stack.push(tagName); |
923 | | } |
924 | | }); |
925 | 6 | parser.addListener('tagend', function(event){ |
926 | 5 | var tagName = event.tagName.toLowerCase(); |
927 | | //向上寻找匹配的开始标签 |
928 | 5 | for(var pos = stack.length-1;pos >= 0; pos--){ |
929 | 5 | if(stack[pos] === tagName){ |
930 | 4 | break; |
931 | | } |
932 | | } |
933 | 5 | if(pos >= 0){ |
934 | 4 | var arrTags = []; |
935 | 4 | for(var i=stack.length-1;i>pos;i--){ |
936 | 1 | arrTags.push('</'+stack[i]+'>'); |
937 | | } |
938 | 4 | if(arrTags.length > 0){ |
939 | 1 | reporter.error('Tag must be paired, Missing: [ '+ arrTags.join('') + ' ]', event.line, event.col, self, event.raw); |
940 | | } |
941 | 4 | stack.length=pos; |
942 | | } |
943 | | else{ |
944 | 1 | reporter.error('Tag must be paired, No start tag: [ ' + event.raw + ' ]', event.line, event.col, self, event.raw); |
945 | | } |
946 | | }); |
947 | 6 | parser.addListener('end', function(event){ |
948 | 6 | var arrTags = []; |
949 | 6 | for(var i=stack.length-1;i>=0;i--){ |
950 | 4 | arrTags.push('</'+stack[i]+'>'); |
951 | | } |
952 | 6 | if(arrTags.length > 0){ |
953 | 4 | reporter.error('Tag must be paired, Missing: [ '+ arrTags.join('') + ' ]', event.line, event.col, self, ''); |
954 | | } |
955 | | }); |
956 | | } |
957 | | }); |
958 | | /** |
959 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
960 | | * MIT Licensed |
961 | | */ |
962 | 1 | HTMLHint.addRule({ |
963 | | id: 'tag-self-close', |
964 | | description: 'The empty tag must closed by self.', |
965 | | init: function(parser, reporter){ |
966 | 2 | var self = this; |
967 | 2 | var mapEmptyTags = parser.makeMap("area,base,basefont,br,col,frame,hr,img,input,isindex,link,meta,param,embed");//HTML 4.01 |
968 | 2 | parser.addListener('tagstart', function(event){ |
969 | 4 | var tagName = event.tagName.toLowerCase(); |
970 | 4 | if(mapEmptyTags[tagName] !== undefined){ |
971 | 4 | if(!event.close){ |
972 | 2 | reporter.warn('The empty tag : [ '+tagName+' ] must closed by self.', event.line, event.col, self, event.raw); |
973 | | } |
974 | | } |
975 | | }); |
976 | | } |
977 | | }); |
978 | | /** |
979 | | * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com> |
980 | | * MIT Licensed |
981 | | */ |
982 | 1 | HTMLHint.addRule({ |
983 | | id: 'tagname-lowercase', |
984 | | description: 'Tagname must be lowercase.', |
985 | | init: function(parser, reporter){ |
986 | 5 | var self = this; |
987 | 5 | parser.addListener('tagstart,tagend', function(event){ |
988 | 17 | var tagName = event.tagName; |
989 | 17 | if(tagName !== tagName.toLowerCase()){ |
990 | 6 | reporter.error('Tagname [ '+tagName+' ] must be lower case.', event.line, event.col, self, event.raw); |
991 | | } |
992 | | }); |
993 | | } |
994 | | }); |