refactor: change ts to js (#155)

* refactor: change ts to js

* refactor: refactor to use NODE_TYPES

* refactor: remove unused code

* ci: add refactor types

.github/workflows/sementic-pr.yml

@@ -23,6 +23,7 @@ jobs:
             test
             chore
             ci
+            refactor
           requireScope: false
           subjectPattern: ^[a-z].+[^\.]$
           subjectPatternError: |

.gitignore

@@ -8,3 +8,4 @@ next-env.d.ts
 packages/web-linter/out
 packages/**/dist
 *.tsbuildinfo
+packages/parser/types

.prettierignore

@@ -9,3 +9,4 @@ packages/website2/.next
 out
 .next
 dist
+packages/parser/types

packages/eslint-plugin/lib/constants/index.js

@@ -1,10 +1,8 @@
-const NODE_TYPES = require("./node-types");
 const RULE_CATEGORY = require("./rule-category");
 const OBSOLETE_TAGS = require("./obsolete-tags");
 const VOID_ELEMENTS = require("./void-elements");
 
 module.exports = {
-  NODE_TYPES,
   RULE_CATEGORY,
   OBSOLETE_TAGS,
   VOID_ELEMENTS,

packages/eslint-plugin/lib/rules/element-newline.js

@@ -1,4 +1,5 @@
 const { RULE_CATEGORY } = require("../constants");
+const { NODE_TYPES } = require("@html-eslint/parser");
 
 const MESSAGE_IDS = {
   EXPECT_NEW_LINE_AFTER: "expectAfter",
@@ -99,7 +100,8 @@ module.exports = {
           return;
         }
 
-        const children = node.type === "Program" ? node.body : node.children;
+        const children =
+          node.type === NODE_TYPES.Program ? node.body : node.children;
         checkSiblings(children);
         if (skipTags.includes(node.name)) {
           isInSkipTags = true;

packages/eslint-plugin/lib/rules/require-attrs.js

@@ -2,6 +2,7 @@
  * @typedef {import("../types").Rule} Rule
  */
 
+const { NODE_TYPES } = require("@html-eslint/parser");
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -91,7 +92,7 @@ module.exports = {
 
     return {
       [["StyleTag", "ScriptTag"].join(",")](node) {
-        const tagName = node.type === "StyleTag" ? "style" : "script";
+        const tagName = node.type === NODE_TYPES.StyleTag ? "style" : "script";
         if (!tagOptionsMap.has(tagName)) {
           return;
         }

packages/eslint-plugin/lib/rules/require-meta-description.js

@@ -3,6 +3,7 @@
  * @typedef {import("es-html-parser").TagNode} TagNode
  */
 
+const { NODE_TYPES } = require("@html-eslint/parser");
 const { RULE_CATEGORY } = require("../constants");
 const { NodeUtils } = require("./utils");
 
@@ -16,7 +17,7 @@ const MESSAGE_IDS = {
  * @returns {boolean}
  */
 function isMetaTagNode(node) {
-  return node.type === "Tag" && node.name === "meta";
+  return node.type === NODE_TYPES.Tag && node.name === "meta";
 }
 
 /**

packages/eslint-plugin/lib/rules/require-meta-viewport.js

@@ -3,6 +3,7 @@
  * @typedef {import("es-html-parser").TagNode} TagNode
  */
 
+const { NODE_TYPES } = require("@html-eslint/parser");
 const { RULE_CATEGORY } = require("../constants");
 const { NodeUtils } = require("./utils");
 
@@ -17,7 +18,7 @@ const MESSAGE_IDS = {
  * @returns {node is TagNode} Return true if the given node is a meta tag with viewport attribute, otherwise false.
  */
 function isMetaViewport(node) {
-  if (node.type === "Tag" && node.name === "meta") {
+  if (node.type === NODE_TYPES.Tag && node.name === "meta") {
     const nameAttribute = NodeUtils.findAttr(node, "name");
     return (
       nameAttribute &&

packages/eslint-plugin/lib/rules/require-title.js

@@ -3,6 +3,7 @@
  * @typedef {import("es-html-parser").TagNode} TagNode
  * @typedef {import("es-html-parser").TextNode} TextNode
  */
+const { NODE_TYPES } = require("@html-eslint/parser");
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -16,7 +17,7 @@ const MESSAGE_IDS = {
  * @returns {node is TagNode} Returns true if the given node is a title TagNode, otherwise false
  */
 function isTitleTagNode(node) {
-  return node.type === "Tag" && node.name === "title";
+  return node.type === NODE_TYPES.Tag && node.name === "title";
 }
 
 /**
@@ -25,7 +26,7 @@ function isTitleTagNode(node) {
  * @returns {node is TextNode} Returns true if the given node is a TextNode with non-empty value, otherwise false
  */
 function isNonEmptyTextNode(node) {
-  return node.type === "Text" && node.value.trim().length > 0;
+  return node.type === NODE_TYPES.Text && node.value.trim().length > 0;
 }
 
 /**

packages/eslint-plugin/lib/rules/utils/node-utils.js

@@ -10,7 +10,7 @@
  */
 
 module.exports = {
-  /*
+  /**
    * @param {TagNode} node
    * @param {string} name
    * @returns {AttributeNode | undefined}
@@ -20,20 +20,7 @@ module.exports = {
       (attr) => attr.key && attr.key.value.toLowerCase() === name.toLowerCase()
     );
   },
-  /**
-   * Checks a node has attribute with the given name or not.
-   * @param {TagNode} node node
-   * @param {string} name attribute name
-   * @return {boolean} `true` if the node has a attribute, otherwise `false`.
-   */
-  hasAttr(node, name) {
-    return (
-      !!node &&
-      (node.attributes || []).some(
-        (attr) => attr.key && attr.key.value === name
-      )
-    );
-  },
+
   /**
    * Checks whether a node's all tokens are on the same line or not.
    * @param {AnyNode} node A node to check
@@ -43,24 +30,6 @@ module.exports = {
     return node.loc.start.line === node.loc.end.line;
   },
 
-  /**
-   * Checks whether a node is a TextNode or not.
-   * @param {Object} node A node to check
-   * @returns {node is TextNode} `true` if a node is `TextNode`, otherwise `false`.
-   */
-  isTextNode(node) {
-    return !!(node && node.type === "text" && typeof node.value === "string");
-  },
-
-  /**
-   * Checks whether a node is a CommentNode or not.
-   * @param {Object} node A node to check
-   * @returns {node is CommentNode} `true` if a node is `CommentNode`, otherwise `false`.
-   */
-  isCommentNode(node) {
-    return !!(node && node.type === "comment");
-  },
-
   /**
    *
    * @param {TextNode | CommentContentNode} node

packages/parser/.eslintrc.js

@@ -0,0 +1,24 @@
+module.exports = {
+  extends: ["eslint:recommended"],
+  plugins: ["jest", "node"],
+  parserOptions: {
+    ecmaVersion: 9,
+  },
+  env: {
+    node: true,
+    es6: true,
+  },
+  rules: {
+    "node/no-unsupported-features/es-builtins": "error",
+    "node/no-unsupported-features/es-syntax": "error",
+    "node/no-unsupported-features/node-builtins": "error",
+  },
+  overrides: [
+    {
+      files: ["*.test.js"],
+      env: {
+        "jest/globals": true,
+      },
+    },
+  ],
+};

packages/parser/lib/index.js

@@ -0,0 +1,5 @@
+const { parseForESLint } = require("./parser");
+const { NODE_TYPES } = require("./node-types");
+
+module.exports.parseForESLint = parseForESLint;
+module.exports.NODE_TYPES = NODE_TYPES;

packages/parser/lib/node-types.js

@@ -0,0 +1,13 @@
+const { NodeTypes } = require("es-html-parser");
+
+// eslint-disable-next-line no-unused-vars
+const { Document, ...restNodeTypes } = NodeTypes;
+
+const NODE_TYPES = {
+  Program: "Program",
+  ...restNodeTypes,
+};
+
+module.exports = {
+  NODE_TYPES,
+};

packages/parser/lib/parser.js

@@ -0,0 +1,46 @@
+/**
+ * @typedef {import("./types").ProgramNode} ProgramNode
+ */
+const { parse } = require("es-html-parser");
+const { visitorKeys } = require("./visitor-keys");
+const { traverse } = require("./traverse");
+const { NODE_TYPES } = require("./node-types");
+
+/**
+ * @param {string} code
+ * @returns {ProgramNode}
+ */
+module.exports.parseForESLint = function parseForESLint(code) {
+  const { ast, tokens } = parse(code);
+
+  const programNode = {
+    type: "Program",
+    body: ast.children,
+    loc: ast.loc,
+    range: ast.range,
+    tokens: tokens.filter(
+      (token) =>
+        token.type !== NODE_TYPES.CommentContent &&
+        token.type !== NODE_TYPES.CommentOpen &&
+        token.type !== NODE_TYPES.CommentClose
+    ),
+    comments: [],
+  };
+
+  traverse(programNode, (node) => {
+    if (node.type === NODE_TYPES.CommentContent) {
+      programNode.comments.push({
+        type: node.type,
+        range: node.range,
+        loc: node.loc,
+        value: node.value,
+      });
+    }
+  });
+
+  return {
+    ast: programNode,
+    visitorKeys,
+    scopeManager: null,
+  };
+};

packages/parser/lib/traverse.js

@@ -0,0 +1,39 @@
+/**
+ * @typedef {import("./types").AnyHTMLNode} AnyHTMLNode
+ */
+const { visitorKeys } = require("./visitor-keys");
+
+/**
+ *
+ * @param {AnyHTMLNode} node
+ * @param {(arg: AnyHTMLNode) => void} visitor
+ * @returns {void}
+ */
+function traverse(node, visitor) {
+  if (!node) {
+    return;
+  }
+  visitor(node);
+  const type = node.type;
+  const keys = visitorKeys[type];
+
+  if (!keys || keys.length <= 0) {
+    return;
+  }
+
+  keys.forEach((key) => {
+    // @ts-ignore
+    const value = node[key];
+    if (value) {
+      if (Array.isArray(value)) {
+        value.forEach((n) => traverse(n, visitor));
+      } else {
+        traverse(value, visitor);
+      }
+    }
+  });
+}
+
+module.exports = {
+  traverse,
+};