refactor: fix types (#295)

* feat: improve types

* refactor: fix types

* fix format

* Update types.d.ts

* fix types

* fix types

* Update html-ast.d.ts

* fix prettier

* add tests

* Update parser.js

Author: yeonjuan

.gitignore

@@ -21,8 +21,4 @@ packages/**/.yarn
 !.yarn/versions
 .DS_Store
 
-# generated types
-packages/**/types
-!packages/**/lib/types
-
 integration-test-projects/**/*.yarn

.prettierignore

@@ -4,16 +4,11 @@
 lerna.json
 packages/website/
 packages/web-linter/out
-.next
 dist
 **/dist
 .yarn/releases
 yarn.lock
 .turbo
 
-# generated types
-packages/**/types
-!packages/**/lib/types
-
 packages/eslint-plugin/tests/e2e/**/*.html
 integration-test-projects

package.json

@@ -24,14 +24,15 @@
   "author": "yeonjuan",
   "license": "MIT",
   "devDependencies": {
+    "@types/jest": "^29.5.14",
     "cspell": "^8.0.0",
     "eslint": "^9.19.0",
     "eslint-plugin-jest": "^28.11.0",
     "eslint-plugin-n": "^17.15.1",
     "husky": "^9.1.4",
     "jest": "^29.7.0",
     "lerna": "^8.1.9",
-    "prettier": "^2.4.1",
+    "prettier": "^3.5.2",
     "svgo": "^3",
     "turbo": "^2.0.11",
     "typescript": "^5.7.2"

packages/cli/package.json

@@ -6,10 +6,6 @@
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
   "license": "ISC",
   "main": "lib/cli.js",
-  "directories": {
-    "lib": "lib",
-    "test": "__tests__"
-  },
   "bin": {
     "html-eslint": "./lib/cli.js"
   },

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

@@ -1,14 +1,16 @@
 /**
  * @typedef { import("../types").RuleModule } RuleModule
- * @typedef { import("../types").Tag } Tag
- * @typedef { import("../types").Comment } Comment
- * @typedef { import("../types").Doctype } Doctype
- * @typedef { import("../types").ScriptTag } ScriptTag
- * @typedef { import("../types").StyleTag } StyleTag
- * @typedef { import("../types").Text } Text
- * @typedef { import("../types").AnyNode } AnyNode
- * @typedef { import("../types").OpenTagEnd } OpenTagEnd
- * @typedef { import("../types").CloseTag } CloseTag
+ * @typedef { import("@html-eslint/types").Tag } Tag
+ * @typedef { import("@html-eslint/types").Comment } Comment
+ * @typedef { import("@html-eslint/types").Doctype } Doctype
+ * @typedef { import("@html-eslint/types").ScriptTag } ScriptTag
+ * @typedef { import("@html-eslint/types").StyleTag } StyleTag
+ * @typedef { import("@html-eslint/types").Text } Text
+ * @typedef { import("@html-eslint/types").AnyNode } AnyNode
+ * @typedef { import("@html-eslint/types").OpenTagEnd } OpenTagEnd
+ * @typedef { import("@html-eslint/types").CloseTag } CloseTag
+ * @typedef { import("../types").Line } Line
+ * @typedef { AnyNode | Line } AnyNodeOrLine
  */
 
 const { RULE_CATEGORY } = require("../constants");
@@ -115,12 +117,12 @@ module.exports = {
     const inlineTags = optionsOrPresets(option.inline || []);
 
     /**
-     * @param {AnyNode[]} children
-     * @returns {Exclude<AnyNode, Text>[]}
+     * @param {AnyNodeOrLine[]} children
+     * @returns {Exclude<AnyNodeOrLine, Text>[]}
      */
     function getChildrenToCheck(children) {
       /**
-       * @type {Exclude<AnyNode, Text>[]}
+       * @type {Exclude<AnyNodeOrLine, Text>[]}
        */
       const childrenToCheck = [];
 
@@ -136,8 +138,8 @@ module.exports = {
     }
 
     /**
-     * @param {AnyNode} before
-     * @param {AnyNode} after
+     * @param {AnyNodeOrLine} before
+     * @param {AnyNodeOrLine} after
      * @returns {boolean}
      */
     function isOnTheSameLine(before, after) {
@@ -156,7 +158,7 @@ module.exports = {
     }
 
     /**
-     * @param {AnyNode} node
+     * @param {AnyNodeOrLine} node
      * @returns {boolean}
      */
     function isInline(node) {
@@ -250,7 +252,7 @@ module.exports = {
     }
 
     /**
-     * @param {AnyNode} node
+     * @param {AnyNodeOrLine} node
      * @returns {boolean}
      */
     function isEmptyText(node) {
@@ -261,7 +263,7 @@ module.exports = {
     }
 
     /**
-     * @param {AnyNode} node
+     * @param {AnyNodeOrLine} node
      * @param {{ isClose?: boolean }} options
      */
     function getName(node, options = {}) {

packages/eslint-plugin/lib/rules/id-naming-convention.js

@@ -1,8 +1,8 @@
 /**
  * @typedef { import("../types").RuleModule } RuleModule
- * @typedef { import("../types").Tag } Tag
- * @typedef { import("../types").ScriptTag } ScriptTag
- * @typedef { import("../types").StyleTag } StyleTag
+ * @typedef { import("@html-eslint/types").Tag } Tag
+ * @typedef { import("@html-eslint/types").ScriptTag } ScriptTag
+ * @typedef { import("@html-eslint/types").StyleTag } StyleTag
  */
 
 const { RULE_CATEGORY } = require("../constants");

packages/eslint-plugin/lib/rules/indent/indent-level.js

@@ -1,5 +1,5 @@
 /**
- * @typedef {import("../../types").AnyNode} AnyNode
+ * @typedef {import("@html-eslint/types").AnyNode} AnyNode
  * @typedef {{ [key in AnyNode['type']]?: number}} IncLevelOptions
  * @typedef {(node: AnyNode) => number} GetIncreasingLevel
  */

packages/eslint-plugin/lib/rules/indent/indent.js

@@ -1,20 +1,20 @@
 /**
  * @typedef { import("../../types").RuleModule } RuleModule
- * @typedef { import("../../types").AnyNode } AnyNode
+ * @typedef { import("@html-eslint/types").AnyNode } AnyNode
  * @typedef { import("../../types").Line } Line
- * @typedef { import("../../types").Tag } Tag
+ * @typedef { import("@html-eslint/types").Tag } Tag
  * @typedef { import("../../types").RuleListener } RuleListener
  * @typedef { import("../../types").Context } Context
- * @typedef { import("../../types").TemplateText } TemplateText
+ * @typedef { import("@html-eslint/types").TemplateText } TemplateText
  * @typedef { import("eslint").AST.Token } Token
  * @typedef { import("eslint").SourceCode } SourceCode
  * @typedef { import("eslint").AST.Range } Range
  * @typedef { import("eslint").AST.SourceLocation } SourceLocation
- * @typedef { import("../../types").TemplateLiteral } TemplateLiteral
- * @typedef { import("../../types").OpenTemplate } OpenTemplate
- * @typedef { import("../../types").CloseTemplate } CloseTemplate
- *
+ * @typedef { import("@html-eslint/types").TemplateLiteral } TemplateLiteral
+ * @typedef { import("@html-eslint/types").OpenTemplate } OpenTemplate
+ * @typedef { import("@html-eslint/types").CloseTemplate } CloseTemplate
  *
+ * @typedef {AnyNode | Line} AnyNodeOrLine
  * @typedef {Object} IndentType
  * @property {"tab"} TAB
  * @property {"space"} SPACE
@@ -398,7 +398,7 @@ module.exports = {
 };
 
 /**
- * @param {AnyNode | Line | TemplateText | OpenTemplate | CloseTemplate} node
+ * @param {AnyNodeOrLine | TemplateText | OpenTemplate | CloseTemplate} node
  * @param {string} actualIndent
  * @return {{range: Range; loc: SourceLocation}}
  */

packages/eslint-plugin/lib/rules/lowercase.js

@@ -1,8 +1,8 @@
 /**
  * @typedef { import("../types").RuleModule } RuleModule
- * @typedef { import("../types").Tag } Tag
- * @typedef { import("../types").StyleTag } StyleTag
- * @typedef { import("../types").ScriptTag } ScriptTag
+ * @typedef { import("@html-eslint/types").Tag } Tag
+ * @typedef { import("@html-eslint/types").StyleTag } StyleTag
+ * @typedef { import("@html-eslint/types").ScriptTag } ScriptTag
  */
 
 const { NODE_TYPES } = require("@html-eslint/parser");

packages/eslint-plugin/lib/rules/max-element-depth.js

@@ -1,8 +1,8 @@
 /**
  * @typedef { import("../types").RuleModule } RuleModule
- * @typedef { import("../types").Tag } Tag
- * @typedef { import("../types").StyleTag } StyleTag
- * @typedef { import("../types").ScriptTag } ScriptTag
+ * @typedef { import("@html-eslint/types").Tag } Tag
+ * @typedef { import("@html-eslint/types").StyleTag } StyleTag
+ * @typedef { import("@html-eslint/types").ScriptTag } ScriptTag
  */
 
 const { RULE_CATEGORY } = require("../constants");