feat(ast): add "Comment" type support

textlint/textlint#204
https://github.com/textlint/textlint/releases/tag/6.7.0

Author: azu

src/mapping.js

@@ -24,6 +24,7 @@ export const nodeTypes = {
     "Bullet": "Bullet", // no need?
     "heading": "Header",
     "code": "CodeBlock",
+    "comment": "Comment",
     "HtmlBlock": "Html",
     "ReferenceDef": "ReferenceDef",
     "horizontalRule": "HorizontalRule",

test/HTMLProcessor-test.js

@@ -9,32 +9,38 @@ import path from "path";
 describe("HTMLProcessor-test", function () {
     describe("#parse", function () {
         it("should return AST", function () {
-            var result = parse(`<div><p><span>aaaa</span></p></div>`);
+            const result = parse(`<div><p><span>aaaa</span></p></div>`);
             assert(result.type === "Document");
         });
         it("script should CodeBlock", function () {
-            var result = parse(`<script> var a = 1; </script>`);
-            let script = result.children[0];
+            const result = parse(`<script> const a = 1; </script>`);
+            const script = result.children[0];
             script.children.forEach(code => {
                 assert.equal(code.type, "CodeBlock");
             });
         });
         it("<p> should Paragraph", function () {
-            var result = parse(`<p>test</p>`);
-            let pTag = result.children[0];
+            const result = parse(`<p>test</p>`);
+            const pTag = result.children[0];
             assert.equal(pTag.type, "Paragraph");
         });
+        it("<!-- comment --> should be Comment", function () {
+            const result = parse(`<!-- comment -->`);
+            const commentNode = result.children[0];
+            assert.equal(commentNode.type, "Comment");
+        });
+
         it("should map type to TxtNode's type", function () {
             function createTag(tagName) {
                 return `<${tagName}></${tagName}>`;
             }
 
             function testMap(typeMap) {
                 Object.keys(typeMap).forEach(tagName => {
-                    let result = parse(createTag(tagName));
+                    const result = parse(createTag(tagName));
                     assert(result.type === "Document");
-                    let firstChild = result.children[0];
-                    let expectedType = typeMap[tagName];
+                    const firstChild = result.children[0];
+                    const expectedType = typeMap[tagName];
                     assert.equal(firstChild.type, expectedType);
                 });
             }
@@ -47,16 +53,19 @@ describe("HTMLProcessor-test", function () {
         context("when target file is a HTML", function () {
             beforeEach(function () {
                 textlint = new TextLintCore();
-                textlint.addProcessor(HTMLProcessor);
+                textlint.setupProcessors({
+                    HTMLProcessor: HTMLProcessor
+                });
                 textlint.setupRules({
                     "no-todo": require("textlint-rule-no-todo")
                 });
             });
             it("should report error", function () {
-                var fixturePath = path.join(__dirname, "/fixtures/test.html");
-                let results = textlint.lintFile(fixturePath);
-                assert(results.messages.length > 0);
-                assert(results.filePath === fixturePath);
+                const fixturePath = path.join(__dirname, "/fixtures/test.html");
+                return textlint.lintFile(fixturePath).then(results => {
+                    assert(results.messages.length > 0);
+                    assert(results.filePath === fixturePath);
+                });
             });
         });
     });