feat: Add types to config-array

eslint · Apr 24, 2024 · 808f96e · 808f96e
1 parent 7c431a3
commit 808f96e
Show file tree

Hide file tree

Showing 7 changed files with 340 additions and 181 deletions.
diff --git a/packages/config-array/package.json b/packages/config-array/package.json
@@ -23,8 +23,9 @@
   },
   "homepage": "https://github.com/eslint/rewrite#readme",
   "scripts": {
-    "build": "rollup -c",
-    "prepare": "npm run build",
+    "build:dedupe-types": "node ../../tools/dedupe-types.js dist/cjs/index.cjs dist/esm/index.js", 
+    "build": "rollup -c && npm run build:dedupe-types && tsc -p tsconfig.esm.json && tsc -p tsconfig.cjs.json",
+    "pretest": "npm run build",
     "test": "mocha tests/"
   },
   "keywords": [
@@ -39,10 +40,11 @@
     "minimatch": "^3.0.5"
   },
   "devDependencies": {
+    "@types/minimatch": "^3.0.5",
     "mocha": "^10.4.0",
     "rollup": "^4.16.2",
-    "typescript": "^5.4.5",
-    "rollup-plugin-copy": "^3.5.0"
+    "rollup-plugin-copy": "^3.5.0",
+    "typescript": "^5.4.5"
   },
   "engines": {
     "node": "^18.18.0 || ^20.9.0 || >=21.1.0"

diff --git a/packages/config-array/src/base-schema.js b/packages/config-array/src/base-schema.js
@@ -3,16 +3,27 @@
  * @author Nicholas C. Zakas
  */
 
+//------------------------------------------------------------------------------
+// Types
+//------------------------------------------------------------------------------
+
+/** @typedef {import("@eslint/object-schema").PropertyDefinition} PropertyDefinition */
+/** @typedef {import("@eslint/object-schema").ObjectDefinition} ObjectDefinition */
+
 //------------------------------------------------------------------------------
 // Helpers
 //------------------------------------------------------------------------------
 
+/**
+ * A strategy that does nothing.
+ * @type {PropertyDefinition}
+ */
 const NOOP_STRATEGY = {
 	required: false,
 	merge() {
 		return undefined;
 	},
-	validate() { }
+	validate() {},
 };
 
 //------------------------------------------------------------------------------
@@ -21,7 +32,7 @@ const NOOP_STRATEGY = {
 
 /**
  * The base schema that every ConfigArray uses.
- * @type Object
+ * @type {ObjectDefinition}
  */
 export const baseSchema = Object.freeze({
 	name: {
@@ -30,11 +41,11 @@ export const baseSchema = Object.freeze({
 			return undefined;
 		},
 		validate(value) {
-			if (typeof value !== 'string') {
-				throw new TypeError('Property must be a string.');
+			if (typeof value !== "string") {
+				throw new TypeError("Property must be a string.");
 			}
-		}
+		},
 	},
 	files: NOOP_STRATEGY,
-	ignores: NOOP_STRATEGY
+	ignores: NOOP_STRATEGY,
 });