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