fix: package.json types (#300)

yeonjuan · web-flow · commit 72480d1aa1f3 · 2025-03-07T01:27:11.000+09:00
* fix: package.json types

* fix: remove types field in package.json

* fix: types

* fix
diff --git a/.gitignore b/.gitignore
@@ -22,3 +22,7 @@ packages/**/.yarn
 .DS_Store
 
 integration-test-projects/**/*.yarn
+packages/template-syntax-parser/types
+packages/template-parser/types
+packages/parser/types
+packages/eslint-plugin/types
diff --git a/package.json b/package.json
@@ -33,6 +33,7 @@
     "jest": "^29.7.0",
     "lerna": "^8.1.9",
     "prettier": "^3.5.2",
+    "rimraf": "^6.0.1",
     "svgo": "^3",
     "turbo": "^2.0.11",
     "typescript": "^5.7.2"
diff --git a/packages/eslint-plugin/lib/exports.ts b/packages/eslint-plugin/lib/exports.ts
@@ -0,0 +1,2 @@
+import plugin = require("./index");
+export default plugin;
diff --git a/packages/eslint-plugin/lib/index.js b/packages/eslint-plugin/lib/index.js
@@ -3,7 +3,12 @@ const recommended = require("./configs/recommended");
 const parser = require("@html-eslint/parser");
 
 /**
- * @type {{configs: {recommended: typeof recommended,"flat/recommended": import("eslint").Linter.FlatConfig , rules: typeof rules}}}
+ * @typedef {import("./rules")} AllRules
+ * @typedef {import("./configs/recommended")} RecommendedConfig
+ */
+
+/**
+ * @type {{rules: AllRules, configs: {recommended: RecommendedConfig, "flat/recommended": import("eslint").Linter.FlatConfig }}}
  */
 const plugin = {
   // @ts-ignore
diff --git a/packages/eslint-plugin/lib/types/ast.ts b/packages/eslint-plugin/lib/types/ast.ts
diff --git a/packages/eslint-plugin/lib/types/index.ts b/packages/eslint-plugin/lib/types/index.ts
diff --git a/packages/eslint-plugin/lib/types/rule.ts b/packages/eslint-plugin/lib/types/rule.ts
@@ -53,7 +53,7 @@ interface RuleFix {
   text: string;
 }
 
-interface RuleFixer {
+export interface RuleFixer {
   insertTextAfter(nodeOrToken: AnyNodeAndLine, text: string): RuleFix;
 
   insertTextAfterRange(range: eslint.AST.Range, text: string): RuleFix;
diff --git a/packages/eslint-plugin/lib/types/settings.ts b/packages/eslint-plugin/lib/types/settings.ts
diff --git a/packages/eslint-plugin/package.json b/packages/eslint-plugin/package.json
@@ -6,9 +6,10 @@
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
   "license": "MIT",
   "main": "lib/index.js",
-  "types": "types/index.d.ts",
+  "types": "types/exports.d.ts",
   "files": [
-    "lib"
+    "lib",
+    "types"
   ],
   "publishConfig": {
     "access": "public"
@@ -20,7 +21,8 @@
   "scripts": {
     "test": "jest --coverage",
     "ts": "tsc --noEmit",
-    "lint": "eslint ."
+    "lint": "eslint .",
+    "build": "rimraf types && tsc  --project tsconfig.build.json"
   },
   "bugs": {
     "url": "https://github.com/yeonjuan/html-eslint/issues"
diff --git a/packages/eslint-plugin/tsconfig.build.json b/packages/eslint-plugin/tsconfig.build.json
@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "include": ["lib"],
+  "compilerOptions": {
+    "outDir": "types",
+    "emitDeclarationOnly": true,
+    "noEmit": false,
+    "rootDir": "lib"
+  }
+}
diff --git a/packages/parser/lib/exports.ts b/packages/parser/lib/exports.ts
@@ -0,0 +1,2 @@
+export * from "./index";
+export type { ParserOptions } from "./types";
diff --git a/packages/parser/lib/types.ts b/packages/parser/lib/types.ts
@@ -1,5 +1,3 @@
-export * from "./index";
-
 export type ParserOptions = {
   templateEngineSyntax?: Record<string, string>;
 };
diff --git a/packages/parser/package.json b/packages/parser/package.json
@@ -6,9 +6,10 @@
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
   "license": "MIT",
   "main": "lib/index.js",
-  "types": "lib/types.d.ts",
+  "types": "types/exports.d.ts",
   "files": [
-    "lib"
+    "lib",
+    "types"
   ],
   "publishConfig": {
     "access": "public"
@@ -19,7 +20,8 @@
   },
   "scripts": {
     "test": "jest --coverage --updateSnapshot --passWithNoTests",
-    "ts": "tsc --noEmit"
+    "ts": "tsc --noEmit",
+    "build": "rimraf types && tsc --project tsconfig.build.json"
   },
   "bugs": {
     "url": "https://github.com/yeonjuan/html-eslint/issues"
diff --git a/packages/parser/tsconfig.build.json b/packages/parser/tsconfig.build.json
@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "include": ["lib"],
+  "compilerOptions": {
+    "outDir": "types",
+    "emitDeclarationOnly": true,
+    "noEmit": false,
+    "rootDir": "lib"
+  }
+}
diff --git a/packages/template-parser/lib/exports.ts b/packages/template-parser/lib/exports.ts
@@ -0,0 +1,2 @@
+export * from "./index";
+export type { TemplateHTMLVisitor } from "./types";
diff --git a/packages/template-parser/lib/types.ts b/packages/template-parser/lib/types.ts
@@ -31,7 +31,6 @@ import type {
   StyleTagContent,
   Tag,
   Text,
-  AnyNode,
 } from "@html-eslint/types";
 import { NodeTypes } from "es-html-parser";
 
diff --git a/packages/template-parser/package.json b/packages/template-parser/package.json
@@ -6,9 +6,10 @@
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
   "license": "MIT",
   "main": "lib/index.js",
-  "types": "types/lib/index.d.ts",
+  "types": "types/exports.d.ts",
   "files": [
-    "lib"
+    "lib",
+    "types"
   ],
   "publishConfig": {
     "access": "public"
@@ -20,7 +21,8 @@
   "scripts": {
     "ts": "tsc --noEmit",
     "lint": "eslint .",
-    "test": "jest --coverage"
+    "test": "jest --coverage",
+    "build": "rimraf types && tsc --project tsconfig.build.json"
   },
   "bugs": {
     "url": "https://github.com/yeonjuan/html-eslint/issues"
diff --git a/packages/template-parser/tsconfig.build.json b/packages/template-parser/tsconfig.build.json
@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "include": ["lib"],
+  "compilerOptions": {
+    "outDir": "types",
+    "emitDeclarationOnly": true,
+    "noEmit": false,
+    "rootDir": "lib"
+  }
+}
diff --git a/packages/template-syntax-parser/lib/exports.ts b/packages/template-syntax-parser/lib/exports.ts
@@ -0,0 +1,8 @@
+export * from "./index";
+export {
+  TemplateSyntaxParserConfig,
+  TemplateSyntax,
+  OpenSyntax,
+  CloseSyntax,
+  TemplateSyntaxParserResult,
+} from "./types";
diff --git a/packages/template-syntax-parser/lib/types.ts b/packages/template-syntax-parser/lib/types.ts
@@ -1,5 +1,4 @@
-import { AST } from "eslint";
-export * from "./index";
+import type { AST } from "eslint";
 
 export type TemplateSyntaxParserConfig = {
   skipRanges?: [number, number][];
diff --git a/packages/template-syntax-parser/package.json b/packages/template-syntax-parser/package.json
@@ -6,15 +6,10 @@
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
   "license": "MIT",
   "main": "lib/index.js",
-  "types": "lib/types.d.ts",
-  "exports": {
-    ".": {
-      "types": "./lib/types.d.ts",
-      "default": "./lib/index.js"
-    }
-  },
+  "types": "types/exports.d.ts",
   "files": [
-    "lib"
+    "lib",
+    "types"
   ],
   "publishConfig": {
     "access": "public"
@@ -26,7 +21,8 @@
   "scripts": {
     "ts": "tsc --noEmit",
     "lint": "eslint .",
-    "test": "jest --coverage"
+    "test": "jest --coverage",
+    "build": "rimraf types && tsc --project tsconfig.build.json"
   },
   "bugs": {
     "url": "https://github.com/yeonjuan/html-eslint/issues"
diff --git a/packages/template-syntax-parser/tsconfig.build.json b/packages/template-syntax-parser/tsconfig.build.json
@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "include": ["lib"],
+  "compilerOptions": {
+    "outDir": "types",
+    "emitDeclarationOnly": true,
+    "noEmit": false,
+    "rootDir": "lib"
+  }
+}
diff --git a/yarn.lock b/yarn.lock
@@ -1301,6 +1301,7 @@ __metadata:
     jest: "npm:^29.7.0"
     lerna: "npm:^8.1.9"
     prettier: "npm:^3.5.2"
+    rimraf: "npm:^6.0.1"
     svgo: "npm:^3"
     turbo: "npm:^2.0.11"
     typescript: "npm:^5.7.2"
@@ -8366,6 +8367,22 @@ __metadata:
   languageName: node
   linkType: hard
 
+"glob@npm:^11.0.0":
+  version: 11.0.1
+  resolution: "glob@npm:11.0.1"
+  dependencies:
+    foreground-child: "npm:^3.1.0"
+    jackspeak: "npm:^4.0.1"
+    minimatch: "npm:^10.0.0"
+    minipass: "npm:^7.1.2"
+    package-json-from-dist: "npm:^1.0.0"
+    path-scurry: "npm:^2.0.0"
+  bin:
+    glob: dist/esm/bin.mjs
+  checksum: 2b32588be52e9e90f914c7d8dec32f3144b81b84054b0f70e9adfebf37cd7014570489f2a79d21f7801b9a4bd4cca94f426966bfd00fb64a5b705cfe10da3a03
+  languageName: node
+  linkType: hard
+
 "glob@npm:^7.1.3, glob@npm:^7.1.4":
   version: 7.2.3
   resolution: "glob@npm:7.2.3"
@@ -9597,6 +9614,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"jackspeak@npm:^4.0.1":
+  version: 4.1.0
+  resolution: "jackspeak@npm:4.1.0"
+  dependencies:
+    "@isaacs/cliui": "npm:^8.0.2"
+  checksum: 08a6a24a366c90b83aef3ad6ec41dcaaa65428ffab8d80bc7172add0fbb8b134a34f415ad288b2a6fbd406526e9a62abdb40ed4f399fbe00cb45c44056d4dce0
+  languageName: node
+  linkType: hard
+
 "jake@npm:^10.8.5":
   version: 10.9.2
   resolution: "jake@npm:10.9.2"
@@ -10992,6 +11018,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"lru-cache@npm:^11.0.0":
+  version: 11.0.2
+  resolution: "lru-cache@npm:11.0.2"
+  checksum: c993b8e06ead0b24b969c1dbb5b301716aed66e320e9014a80012f5febe280b438f28ff50046b2c55ff404e889351ccb332ff91f8dd175a21f5eae80e3fb155f
+  languageName: node
+  linkType: hard
+
 "lru-cache@npm:^5.1.1":
   version: 5.1.1
   resolution: "lru-cache@npm:5.1.1"
@@ -11346,6 +11379,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"minimatch@npm:^10.0.0":
+  version: 10.0.1
+  resolution: "minimatch@npm:10.0.1"
+  dependencies:
+    brace-expansion: "npm:^2.0.1"
+  checksum: e6c29a81fe83e1877ad51348306be2e8aeca18c88fdee7a99df44322314279e15799e41d7cb274e4e8bb0b451a3bc622d6182e157dfa1717d6cda75e9cd8cd5d
+  languageName: node
+  linkType: hard
+
 "minimatch@npm:^3.0.4, minimatch@npm:^3.0.5, minimatch@npm:^3.1.1, minimatch@npm:^3.1.2":
   version: 3.1.2
   resolution: "minimatch@npm:3.1.2"
@@ -12698,6 +12740,16 @@ __metadata:
   languageName: node
   linkType: hard
 
+"path-scurry@npm:^2.0.0":
+  version: 2.0.0
+  resolution: "path-scurry@npm:2.0.0"
+  dependencies:
+    lru-cache: "npm:^11.0.0"
+    minipass: "npm:^7.1.2"
+  checksum: 3da4adedaa8e7ef8d6dc4f35a0ff8f05a9b4d8365f2b28047752b62d4c1ad73eec21e37b1579ef2d075920157856a3b52ae8309c480a6f1a8bbe06ff8e52b33c
+  languageName: node
+  linkType: hard
+
 "path-to-regexp@npm:0.1.10":
   version: 0.1.10
   resolution: "path-to-regexp@npm:0.1.10"
@@ -13900,6 +13952,18 @@ __metadata:
   languageName: node
   linkType: hard
 
+"rimraf@npm:^6.0.1":
+  version: 6.0.1
+  resolution: "rimraf@npm:6.0.1"
+  dependencies:
+    glob: "npm:^11.0.0"
+    package-json-from-dist: "npm:^1.0.0"
+  bin:
+    rimraf: dist/esm/bin.mjs
+  checksum: b30b6b072771f0d1e73b4ca5f37bb2944ee09375be9db5f558fcd3310000d29dfcfa93cf7734d75295ad5a7486dc8e40f63089ced1722a664539ffc0c3ece8c6
+  languageName: node
+  linkType: hard
+
 "ripemd160@npm:^2.0.0, ripemd160@npm:^2.0.1":
   version: 2.0.2
   resolution: "ripemd160@npm:2.0.2"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+import plugin = require("./index");`
	`2`	`+export default plugin;`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ interface RuleFix {`
`53`	`53`	`text: string;`
`54`	`54`	`}`
`55`	`55`
`56`		`-interface RuleFixer {`
	`56`	`+export interface RuleFixer {`
`57`	`57`	`insertTextAfter(nodeOrToken: AnyNodeAndLine, text: string): RuleFix;`
`58`	`58`
`59`	`59`	`insertTextAfterRange(range: eslint.AST.Range, text: string): RuleFix;`