feat: node18 module stuff (#345)

* feat!: node18 module stuff

* fix: more type errors

* fix: use range for eslint packages

ESLint obeys npm-flavored semver, so it's safe to use ranges for 0ver packages.

* chore: yarn dedupe

* fix: type inference

* chore: yarn dedupe

Missed some last time.

* flake

Author: lishaduck

package.json

@@ -11,7 +11,7 @@
     "lint": "turbo run lint",
     "format": "prettier --write .",
     "dev": "turbo run dev",
-    "build": "turbo run build --no-cache --force",
+    "build": "turbo run build",
     "publish": "lerna publish",
     "publish:alpha": "lerna publish --dist-tag alpha",
     "check:ts": "turbo run ts",
@@ -31,7 +31,7 @@
     "@types/jest": "^29.5.14",
     "compute-baseline": "^0.3.1",
     "cspell": "^8.0.0",
-    "eslint": "^9.19.0",
+    "eslint": "^9.27.0",
     "eslint-plugin-jest": "^28.11.0",
     "eslint-plugin-n": "^17.15.1",
     "husky": "^9.1.4",
@@ -41,11 +41,10 @@
     "rimraf": "^6.0.1",
     "svgo": "^3",
     "turbo": "^2.0.11",
-    "typescript": "^5.7.2"
+    "typescript": "^5.8.3"
   },
   "engines": {
-    "node": "^12.22.0 || ^14.17.0 || >=16.0.0",
-    "npm": ">=7"
+    "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
   },
   "packageManager": "[email protected]",
   "workspaces": [

packages/eslint-plugin/lib/configs/recommended.js

@@ -1,4 +1,5 @@
-module.exports = {
+/** @satisfies {import('eslint').Linter.FlatConfig} */
+const recommended = {
   rules: {
     "@html-eslint/require-lang": "error",
     "@html-eslint/require-img-alt": "error",
@@ -23,3 +24,5 @@ module.exports = {
     "@html-eslint/use-baseline": "error",
   },
 };
+
+module.exports = recommended;

packages/eslint-plugin/lib/exports.ts

@@ -1,2 +1,2 @@
 import plugin = require("./index");
-export default plugin;
+export = plugin;

packages/eslint-plugin/lib/index.js

@@ -3,43 +3,40 @@ const recommended = require("./configs/recommended");
 const parser = require("@html-eslint/parser");
 const { HTMLLanguage } = require("./languages/html-language");
 const { name, version } = require("../package.json");
+
 /**
- * @typedef {import("./rules")} AllRules
- * @typedef {import("./configs/recommended")} RecommendedConfig
- * @typedef {{name: string, version: string}} PluginMeta
- * @typedef {{recommended: RecommendedConfig, "flat/recommended": import("eslint").Linter.FlatConfig }} HtmlESLintConfigs
- * @typedef {{html: HTMLLanguage}} Languages
+ * @import { ESLint } from "eslint";
  */
 
 /**
- * @type {{meta: PluginMeta, rules: AllRules, configs: HtmlESLintConfigs, languages: Languages}}
+ * @satisfies {ESLint.Plugin}
  */
 const plugin = {
   meta: {
     name,
     version,
   },
-  // @ts-ignore
   configs: {
     recommended,
+
+    "flat/recommended": {
+      plugins: {
+        /** @type {ESLint.Plugin} */
+        get "@html-eslint"() {
+          return plugin;
+        },
+      },
+
+      languageOptions: {
+        parser,
+      },
+      rules: recommended.rules,
+    },
   },
   languages: {
     html: new HTMLLanguage(),
   },
   rules,
 };
 
-Object.assign(plugin.configs, {
-  "flat/recommended": {
-    plugins: {
-      "@html-eslint": plugin,
-    },
-
-    languageOptions: {
-      parser,
-    },
-    rules: recommended.rules,
-  },
-});
-
 module.exports = plugin;

packages/eslint-plugin/lib/languages/html-language.js

@@ -2,8 +2,13 @@ const { visitorKeys, parseForESLint } = require("@html-eslint/parser");
 const { HTMLSourceCode } = require("./html-source-code");
 
 /**
- * @typedef {import('@eslint/core').File} File
- * @typedef {import('@html-eslint/parser').ParserOptions} LanguageOptions
+ * @import { Language, ParseResult, File, FileError, OkParseResult } from "@eslint/core";
+ * @import { ParserOptions } from "@html-eslint/parser";
+ * @import { AST } from "eslint";
+ */
+
+/**
+ * @implements {Language<{ LangOptions: ParserOptions; Code: HTMLSourceCode; RootNode: AST.Program; Node: {}}>}
  */
 class HTMLLanguage {
   constructor() {
@@ -31,14 +36,14 @@ class HTMLLanguage {
     this.nodeTypeKey = "type";
 
     /**
-     * The visitor keys for the CSSTree AST.
+     * The visitor keys for the es-html-parser AST.
      * @type {Record<string, string[]>}
      */
     this.visitorKeys = visitorKeys;
   }
 
   /**
-   * @param {LanguageOptions} languageOptions
+   * @param {ParserOptions} languageOptions
    */
   validateLanguageOptions(languageOptions) {
     if (!languageOptions) {
@@ -64,8 +69,8 @@ class HTMLLanguage {
   /**
    * @param {File} file
    * @param {Object} [context]
-   * @param {LanguageOptions} context.languageOptions
-   * @returns {{ok: true; ast: any; comments: any[]} | {ok: false, errors: unknown[]}}
+   * @param {ParserOptions} context.languageOptions
+   * @returns {ParseResult<AST.Program>}
    */
   parse(file, context) {
     const code = /**  @type {string} */ (file.body);
@@ -80,14 +85,14 @@ class HTMLLanguage {
     } catch (e) {
       return {
         ok: false,
-        errors: [e],
+        errors: [/** @type {FileError} */ (e)],
       };
     }
   }
 
   /**
    * @param {File} file
-   * @param {any} parseResult
+   * @param {OkParseResult<AST.Program>} parseResult
    */
   createSourceCode(file, parseResult) {
     return new HTMLSourceCode({

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

@@ -50,7 +50,7 @@ const noDuplicateClass = require("./no-duplicate-class");
 // import new rule here ↑
 // DO NOT REMOVE THIS COMMENT
 
-module.exports = {
+const rules = {
   "require-lang": requireLang,
   "require-img-alt": requireImgAlt,
   "require-doctype": requireDoctype,
@@ -103,3 +103,8 @@ module.exports = {
   // export new rule here ↑
   // DO NOT REMOVE THIS COMMENT
 };
+
+module.exports =
+  /** @type {Record<string, import('@eslint/core').RuleDefinition>} */ (
+    /** @type {unknown} */ (rules)
+  );

packages/eslint-plugin/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@html-eslint/eslint-plugin",
   "version": "0.40.3",
-  "description": "ESLint plugin for html",
+  "type": "commonjs",
+  "description": "ESLint plugin for HTML",
   "author": "yeonjuan",
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
   "license": "MIT",
@@ -23,7 +24,7 @@
     "test:legacy": "TEST_ESLINT_LEGACY_CONFIG=true && jest",
     "ts": "tsc --noEmit",
     "lint": "eslint .",
-    "build": "rimraf types && tsc  --project tsconfig.build.json"
+    "build": "rimraf types && tsc --project tsconfig.build.json"
   },
   "bugs": {
     "url": "https://github.com/yeonjuan/html-eslint/issues"
@@ -38,19 +39,24 @@
     "accessibility"
   ],
   "dependencies": {
-    "@eslint/plugin-kit": "0.2.8",
+    "@eslint/plugin-kit": "^0.3.1",
     "@html-eslint/parser": "^0.40.0",
     "@html-eslint/template-parser": "^0.40.0",
     "@html-eslint/template-syntax-parser": "^0.40.0"
   },
+  "peerDependencies": {
+    "eslint": "^8.0.0 || ^9.0.0"
+  },
   "devDependencies": {
-    "@eslint/core": "0.13.0",
+    "@eslint/core": "^0.14.0",
     "@html-eslint/types": "^0.40.0",
-    "@types/eslint": "^9.6.1",
     "@types/estree": "^0.0.47",
     "es-html-parser": "0.2.0",
-    "eslint": "^9.21.0",
+    "eslint": "^9.27.0",
     "espree": "^10.3.0",
-    "typescript": "^5.7.2"
+    "typescript": "^5.8.3"
+  },
+  "engines": {
+    "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
   }
 }

packages/eslint-plugin/tests/languages/html-language.test.js

@@ -1,5 +1,6 @@
 /**
- * @typedef {import('@eslint/core').File} File
+ * @import { File, OkParseResult } from "@eslint/core";
+ * @import { AST } from "eslint";
  */
 
 const { HTMLLanguage } = require("../../lib/languages/html-language");
@@ -118,7 +119,10 @@ name: value
       const file = createFile("<div></div>");
       const language = new HTMLLanguage();
       const parsed = language.parse(file);
-      const sourceCode = language.createSourceCode(file, parsed);
+      const sourceCode = language.createSourceCode(
+        file,
+        /** @type {OkParseResult<AST.Program>} */ (parsed)
+      );
       expect(sourceCode.constructor.name).toBe("HTMLSourceCode");
       expect(sourceCode.ast.type).toBe("Program");
     });

packages/integration-test/tests/integration.test.js

@@ -2,7 +2,7 @@ const { runESLint } = require("../lib/test-utils");
 
 describe("integration tests", () => {
   describe("eslint-v8-legacy-config", () => {
-    it("should throw a lint error for invalid files ", async () => {
+    it("should throw a lint error for invalid files", async () => {
       const htmlResult = await runESLint({
         fixtureName: "eslint-v8-legacy-config",
         glob: "html/invalid.html",

packages/parser/lib/parser.js

@@ -11,7 +11,7 @@ const { getOptions } = require("./options");
 /**
  * @param {string} code
  * @param {ParserOptions | undefined} parserOptions
- * @returns {any}
+ * @returns {import('eslint').Linter.ESLintParseResult}
  */
 module.exports.parseForESLint = function parseForESLint(code, parserOptions) {
   const { options, html } = getOptions(code, parserOptions);
@@ -54,6 +54,6 @@ module.exports.parseForESLint = function parseForESLint(code, parserOptions) {
   return {
     ast: programNode,
     visitorKeys,
-    scopeManager: null,
+    scopeManager: undefined,
   };
 };