add rule: title-require, <title> must be present in <head> tag.

htmlhint · Oct 7, 2015 · 2247853 · 2247853
1 parent 96abbe2
commit 2247853
Show file tree

Hide file tree

Showing 15 changed files with 625 additions and 494 deletions.
diff --git a/CHANGE.md b/CHANGE.md
@@ -12,6 +12,7 @@ add:
 5. tag-pair(rule): Show the line of the start tag
 6. space-tab-mixed-disabled(rule): Support space and tab mode, for check only space or tab
 7. Make cli logs more clear to people
+8. add rule: title-require, `<title>` must be present in `<head>` tag.
 
 fix:
 

diff --git a/lib/htmlhint.js b/lib/htmlhint.js
diff --git a/src/core.js b/src/core.js
@@ -21,7 +21,8 @@ var HTMLHint = (function (undefined) {
         'spec-char-escape': true,
         'id-unique': true,
         'src-not-empty': true,
-        'attr-no-duplication': true
+        'attr-no-duplication': true,
+        'title-require': true
     };
 
     HTMLHint.addRule = function(rule){

diff --git a/src/rules/title-require.js b/src/rules/title-require.js
@@ -0,0 +1,28 @@
+/**
+ * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com>
+ * MIT Licensed
+ */
+HTMLHint.addRule({
+    id: 'title-require',
+    description: '<title> must be present in <head> tag.',
+    init: function(parser, reporter){
+        var self = this;
+        var hasTitle = false;
+        function onTagStart(event){
+            if(event.tagName.toLowerCase() === 'title'){
+                hasTitle = true;
+            }
+        }
+        function onTagEnd(event){
+            if(event.tagName.toLowerCase() === 'head'){
+                if(hasTitle === false){
+                    reporter.error('<title> must be present in <head> tag.', event.line, event.col, self, event.raw);
+                }
+                parser.removeListener('tagstart', onTagStart);
+                parser.removeListener('tagstart', onTagEnd);
+            }
+        }
+        parser.addListener('tagstart', onTagStart);
+        parser.addListener('tagend', onTagEnd);
+    }
+});
diff --git a/test/rules/alt-require.js → test/rules/alt-require.spec.js b/test/rules/alt-require.js → test/rules/alt-require.spec.js
@@ -1,116 +1,116 @@
-/**
- * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com>
- * Copyright (c) 2014, Takeshi Kurosawa <taken.spc@gmail.com>
- * MIT Licensed
- */
-
-var expect  = require("expect.js");
-
-var HTMLHint  = require("../../index").HTMLHint;
-
-var ruldId = 'alt-require',
-    ruleOptions = {};
-
-ruleOptions[ruldId] = true;
-
-describe('Rules: '+ruldId, function(){
-
-    it('Img tag have empty alt attribute should not result in an error', function(){
-        var code = '<img width="200" height="300" alt="">';
-        var messages = HTMLHint.verify(code, ruleOptions);
-        expect(messages.length).to.be(0);
-    });
-
-    it('Img tag have non empty alt attribute should not result in an error', function(){
-        var code = '<img width="200" height="300" alt="test">';
-        var messages = HTMLHint.verify(code, ruleOptions);
-        expect(messages.length).to.be(0);
-    });
-
-    it('Img tag have not alt attribute should result in an error', function(){
-        var code = '<img width="200" height="300">';
-        var messages = HTMLHint.verify(code, ruleOptions);
-        expect(messages.length).to.be(1);
-        expect(messages[0].rule.id).to.be(ruldId);
-        expect(messages[0].line).to.be(1);
-        expect(messages[0].col).to.be(5);
-        expect(messages[0].type).to.be('warning');
-    });
-
-    /* A tag can have shape and coords attributes and not have alt attribute */
-    it('A tag have not alt attribute should not result in an error', function(){
-        var code = '<a>';
-        var messages = HTMLHint.verify(code, ruleOptions);
-        expect(messages.length).to.be(0);
-    });
-
-    it('Area tag have not href and alt attributes should not result in an error', function(){
-        var code = '<area>';
-        var messages = HTMLHint.verify(code, ruleOptions);
-        expect(messages.length).to.be(0);
-    });
-
-    it('Area[href] tag have not alt attribute should result in an error', function(){
-        var code = '<area href="#test">';
-        var messages = HTMLHint.verify(code, ruleOptions);
-        expect(messages.length).to.be(1);
-        expect(messages[0].rule.id).to.be(ruldId);
-        expect(messages[0].line).to.be(1);
-        expect(messages[0].col).to.be(6);
-        expect(messages[0].type).to.be('warning');
-    });
-
-    it('Area[href] tag have empty alt attribute should result in an error', function(){
-        var code = '<area href="#test" alt="">';
-        var messages = HTMLHint.verify(code, ruleOptions);
-        expect(messages.length).to.be(1);
-        expect(messages[0].rule.id).to.be(ruldId);
-        expect(messages[0].line).to.be(1);
-        expect(messages[0].col).to.be(6);
-        expect(messages[0].type).to.be('warning');
-    });
-
-    it('Area[href] tag have non emtpy alt attribute should not result in an error', function(){
-        var code = '<area href="#test" alt="test">';
-        var messages = HTMLHint.verify(code, ruleOptions);
-        expect(messages.length).to.be(0);
-    });
-
-    it('Input tag have not type and alt attributes should not result in an error', function(){
-        var code = '<input>';
-        var messages = HTMLHint.verify(code, ruleOptions);
-        expect(messages.length).to.be(0);
-    });
-
-    it('Input[type="text"] tag have not alt attribute should not result in an error', function(){
-        var code = '<input type="text">';
-        var messages = HTMLHint.verify(code, ruleOptions);
-        expect(messages.length).to.be(0);
-    });
-
-    it('Input[type="image"] tag have not alt attribute should result in an error', function(){
-        var code = '<input type="image">';
-        var messages = HTMLHint.verify(code, ruleOptions);
-        expect(messages.length).to.be(1);
-        expect(messages[0].rule.id).to.be(ruldId);
-        expect(messages[0].line).to.be(1);
-        expect(messages[0].col).to.be(7);
-        expect(messages[0].type).to.be('warning');
-    });
-
-    it('Input[type="image"] tag have empty alt attribute should result in an error', function(){
-        var code = '<input type="image" alt="">';
-        var messages = HTMLHint.verify(code, ruleOptions);
-        expect(messages.length).to.be(1);
-        expect(messages[0].rule.id).to.be(ruldId);
-        expect(messages[0].line).to.be(1);
-        expect(messages[0].col).to.be(7);
-        expect(messages[0].type).to.be('warning');
-    });
-
-    it('Input[type="image"] tag have non emtpy alt attribute should not result in an error', function(){
-        var code = '<input type="image" alt="test">';
-        var messages = HTMLHint.verify(code, ruleOptions);
-        expect(messages.length).to.be(0);
-    });
-});
+/**
+ * Copyright (c) 2015, Yanis Wang <yanis.wang@gmail.com>
+ * Copyright (c) 2014, Takeshi Kurosawa <taken.spc@gmail.com>
+ * MIT Licensed
+ */
+
+var expect  = require("expect.js");
+
+var HTMLHint  = require("../../index").HTMLHint;
+
+var ruldId = 'alt-require',
+    ruleOptions = {};
+
+ruleOptions[ruldId] = true;
+
+describe('Rules: '+ruldId, function(){
+
+    it('Img tag have empty alt attribute should not result in an error', function(){
+        var code = '<img width="200" height="300" alt="">';
+        var messages = HTMLHint.verify(code, ruleOptions);
+        expect(messages.length).to.be(0);
+    });
+
+    it('Img tag have non empty alt attribute should not result in an error', function(){
+        var code = '<img width="200" height="300" alt="test">';
+        var messages = HTMLHint.verify(code, ruleOptions);
+        expect(messages.length).to.be(0);
+    });
+
+    it('Img tag have not alt attribute should result in an error', function(){
+        var code = '<img width="200" height="300">';
+        var messages = HTMLHint.verify(code, ruleOptions);
+        expect(messages.length).to.be(1);
+        expect(messages[0].rule.id).to.be(ruldId);
+        expect(messages[0].line).to.be(1);
+        expect(messages[0].col).to.be(5);
+        expect(messages[0].type).to.be('warning');
+    });
+
+    /* A tag can have shape and coords attributes and not have alt attribute */
+    it('A tag have not alt attribute should not result in an error', function(){
+        var code = '<a>';
+        var messages = HTMLHint.verify(code, ruleOptions);
+        expect(messages.length).to.be(0);
+    });
+
+    it('Area tag have not href and alt attributes should not result in an error', function(){
+        var code = '<area>';
+        var messages = HTMLHint.verify(code, ruleOptions);
+        expect(messages.length).to.be(0);
+    });
+
+    it('Area[href] tag have not alt attribute should result in an error', function(){
+        var code = '<area href="#test">';
+        var messages = HTMLHint.verify(code, ruleOptions);
+        expect(messages.length).to.be(1);
+        expect(messages[0].rule.id).to.be(ruldId);
+        expect(messages[0].line).to.be(1);
+        expect(messages[0].col).to.be(6);
+        expect(messages[0].type).to.be('warning');
+    });
+
+    it('Area[href] tag have empty alt attribute should result in an error', function(){
+        var code = '<area href="#test" alt="">';
+        var messages = HTMLHint.verify(code, ruleOptions);
+        expect(messages.length).to.be(1);
+        expect(messages[0].rule.id).to.be(ruldId);
+        expect(messages[0].line).to.be(1);
+        expect(messages[0].col).to.be(6);
+        expect(messages[0].type).to.be('warning');
+    });
+
+    it('Area[href] tag have non emtpy alt attribute should not result in an error', function(){
+        var code = '<area href="#test" alt="test">';
+        var messages = HTMLHint.verify(code, ruleOptions);
+        expect(messages.length).to.be(0);
+    });
+
+    it('Input tag have not type and alt attributes should not result in an error', function(){
+        var code = '<input>';
+        var messages = HTMLHint.verify(code, ruleOptions);
+        expect(messages.length).to.be(0);
+    });
+
+    it('Input[type="text"] tag have not alt attribute should not result in an error', function(){
+        var code = '<input type="text">';
+        var messages = HTMLHint.verify(code, ruleOptions);
+        expect(messages.length).to.be(0);
+    });
+
+    it('Input[type="image"] tag have not alt attribute should result in an error', function(){
+        var code = '<input type="image">';
+        var messages = HTMLHint.verify(code, ruleOptions);
+        expect(messages.length).to.be(1);
+        expect(messages[0].rule.id).to.be(ruldId);
+        expect(messages[0].line).to.be(1);
+        expect(messages[0].col).to.be(7);
+        expect(messages[0].type).to.be('warning');
+    });
+
+    it('Input[type="image"] tag have empty alt attribute should result in an error', function(){
+        var code = '<input type="image" alt="">';
+        var messages = HTMLHint.verify(code, ruleOptions);
+        expect(messages.length).to.be(1);
+        expect(messages[0].rule.id).to.be(ruldId);
+        expect(messages[0].line).to.be(1);
+        expect(messages[0].col).to.be(7);
+        expect(messages[0].type).to.be('warning');
+    });
+
+    it('Input[type="image"] tag have non emtpy alt attribute should not result in an error', function(){
+        var code = '<input type="image" alt="test">';
+        var messages = HTMLHint.verify(code, ruleOptions);
+        expect(messages.length).to.be(0);
+    });
+});
diff --git a/test/rules/attr-no-duplication.js → test/rules/attr-no-duplication.spec.js b/test/rules/attr-no-duplication.js → test/rules/attr-no-duplication.spec.js
@@ -1,32 +1,32 @@
-/**
- * Copyright (c) 2014, Yanis Wang <yanis.wang@gmail.com>
- * MIT Licensed
- */
-
-var expect  = require("expect.js");
-
-var HTMLHint  = require("../../index").HTMLHint;
-
-var ruldId = 'attr-no-duplication',
-    ruleOptions = {};
-
-ruleOptions[ruldId] = true;
-
-describe('Rules: '+ruldId, function(){
-
-    it('Attribute name been duplication should result in an error', function(){
-        var code = '<a href="a" href="b">bbb</a>';
-        var messages = HTMLHint.verify(code, ruleOptions);
-        expect(messages.length).to.be(1);
-        expect(messages[0].rule.id).to.be(ruldId);
-        expect(messages[0].line).to.be(1);
-        expect(messages[0].col).to.be(12);
-    });
-
-    it('Attribute name not been duplication should not result in an error', function(){
-        var code = '<a href="a">bbb</a>';
-        var messages = HTMLHint.verify(code, ruleOptions);
-        expect(messages.length).to.be(0);
-    });
-
+/**
+ * Copyright (c) 2014, Yanis Wang <yanis.wang@gmail.com>
+ * MIT Licensed
+ */
+
+var expect  = require("expect.js");
+
+var HTMLHint  = require("../../index").HTMLHint;
+
+var ruldId = 'attr-no-duplication',
+    ruleOptions = {};
+
+ruleOptions[ruldId] = true;
+
+describe('Rules: '+ruldId, function(){
+
+    it('Attribute name been duplication should result in an error', function(){
+        var code = '<a href="a" href="b">bbb</a>';
+        var messages = HTMLHint.verify(code, ruleOptions);
+        expect(messages.length).to.be(1);
+        expect(messages[0].rule.id).to.be(ruldId);
+        expect(messages[0].line).to.be(1);
+        expect(messages[0].col).to.be(12);
+    });
+
+    it('Attribute name not been duplication should not result in an error', function(){
+        var code = '<a href="a">bbb</a>';
+        var messages = HTMLHint.verify(code, ruleOptions);
+        expect(messages.length).to.be(0);
+    });
+
 });