fix: make types usable in CommonJS (eslint#44)

fasttime · web-flow · commit 05400062cb59 · 2025-01-24T12:34:08.000-05:00
* fix: make types usable in CommonJS

* use local `@types/css-tree` package

* don't use `node_modules/@types/css-tree` in development

* use `node_modules` types instead of local typings

* remove outdated `@types/eslint`
diff --git a/.npmrc b/.npmrc
@@ -1 +1,2 @@
 package-lock = false
+install-links = false
diff --git a/jsr.json b/jsr.json
@@ -8,7 +8,9 @@
       "dist/esm/index.d.ts",
       "README.md",
       "jsr.json",
-      "LICENSE"
+      "LICENSE",
+      "typings/css-tree/index.d.ts",
+      "typings/css-tree/LICENSE"
     ]
   }
 }
diff --git a/package.json b/package.json
@@ -17,7 +17,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "typings"
   ],
   "publishConfig": {
     "access": "public"
@@ -69,13 +70,13 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
-    "@eslint/plugin-kit": "^0.2.3",
+    "@eslint/core": "^0.10.0",
+    "@eslint/plugin-kit": "^0.2.5",
+    "@types/css-tree": "file:./typings/css-tree",
     "css-tree": "^3.1.0"
   },
   "devDependencies": {
-    "@eslint/core": "^0.7.0",
     "@eslint/json": "^0.5.0",
-    "@types/eslint": "^8.56.10",
     "c8": "^9.1.0",
     "dedent": "^1.5.3",
     "eslint": "^9.11.1",
diff --git a/tests/types/cjs-import.test.cts b/tests/types/cjs-import.test.cts
@@ -0,0 +1,10 @@
+/**
+ * @fileoverview CommonJS type import test for ESLint CSS Language Plugin.
+ * @author Francesco Trotta
+ */
+
+//-----------------------------------------------------------------------------
+// Imports
+//-----------------------------------------------------------------------------
+
+import "@eslint/css";
diff --git a/tests/types/tsconfig.json b/tests/types/tsconfig.json
@@ -5,5 +5,6 @@
     "rootDir": "../..",
     "strict": true
   },
-  "files": ["../../dist/esm/index.d.ts", "types.test.ts"]
+  "files": [],
+  "include": [".", "../../dist"]
 }
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,6 +1,5 @@
 {
   "files": ["src/index.js"],
-  "include": ["typings"],
   "compilerOptions": {
     "declaration": true,
     "emitDeclarationOnly": true,
diff --git a/typings/css-tree/LICENSE b/typings/css-tree/LICENSE
diff --git a/typings/css-tree/index.d.ts b/typings/css-tree/index.d.ts
diff --git a/typings/css-tree/package.json b/typings/css-tree/package.json
@@ -0,0 +1,4 @@
+{
+  "private": true,
+  "name": "@types/css-tree"
+}

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`package-lock = false`
	`2`	`+install-links = false`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,9 @@`
`8`	`8`	`"dist/esm/index.d.ts",`
`9`	`9`	`"README.md",`
`10`	`10`	`"jsr.json",`
`11`		`- "LICENSE"`
	`11`	`+ "LICENSE",`
	`12`	`+ "typings/css-tree/index.d.ts",`
	`13`	`+ "typings/css-tree/LICENSE"`
`12`	`14`	`]`
`13`	`15`	`}`
`14`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,5 +5,6 @@`
`5`	`5`	`"rootDir": "../..",`
`6`	`6`	`"strict": true`
`7`	`7`	`},`
`8`		`- "files": ["../../dist/esm/index.d.ts", "types.test.ts"]`
	`8`	`+ "files": [],`
	`9`	`+ "include": [".", "../../dist"]`
`9`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"files": ["src/index.js"],`
`3`		`- "include": ["typings"],`
`4`	`3`	`"compilerOptions": {`
`5`	`4`	`"declaration": true,`
`6`	`5`	`"emitDeclarationOnly": true,`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "private": true,
 +  "name": "@types/css-tree"
 +}