fix: add type declarations for eslint-config

Financial-Times · Feb 21, 2024 · dc7bedc · dc7bedc
1 parent 8909075
commit dc7bedc
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,6 @@
 .husky/_
 packages/crash-handler/**/*.d.*
 packages/errors/**/*.d.*
-packages/eslint-config/**/*.d.*
 packages/fetch-error-handler/**/*.d.*
 packages/log-error/**/*.d.*
 packages/logger/**/*.d.*

diff --git a/jsconfig.build.json b/jsconfig.build.json
@@ -10,7 +10,6 @@
 	"include": [
 		"packages/crash-handler/**/*.js",
 		"packages/errors/**/*.js",
-		"packages/eslint-config/**/*.js",
 		"packages/fetch-error-handler/**/*.js",
 		"packages/log-error/**/*.js",
 		"packages/logger/**/*.js",

diff --git a/packages/eslint-config/lib/index.js b/packages/eslint-config/lib/index.js
@@ -1,5 +1,5 @@
 /**
- * @type {import('eslint').ESLint.ConfigData}
+ * @type {import('@dotcom-reliability-kit/eslint-config')}
  */
 const config = {
 	env: {

diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -14,7 +14,8 @@
     "node": "18.x || 20.x",
     "npm": "8.x || 9.x || 10.x"
   },
-  "main": "lib",
+  "main": "lib/index.js",
+  "types": "types/index.d.ts",
   "peerDependencies": {
     "eslint": ">=8.27.0"
   },

diff --git a/packages/eslint-config/types/index.d.ts b/packages/eslint-config/types/index.d.ts
@@ -0,0 +1,4 @@
+declare module '@dotcom-reliability-kit/eslint-config' {
+	type config = import('eslint').ESLint.ConfigData;
+	export = config;
+}
diff --git a/scripts/clean-generated-types.sh b/scripts/clean-generated-types.sh
@@ -2,7 +2,6 @@
 
 find ./packages/crash-handler -name "*.d.ts*" | xargs -r rm
 find ./packages/errors -name "*.d.ts*" | xargs -r rm
-find ./packages/eslint-config -name "*.d.ts*" | xargs -r rm
 find ./packages/fetch-error-handler -name "*.d.ts*" | xargs -r rm
 find ./packages/log-error -name "*.d.ts*" | xargs -r rm
 find ./packages/logger -name "*.d.ts*" | xargs -r rm