@castiron/eslint-config 2.0.0 → 2.1.0-alpha.6

package/README.md

@@ -1,11 +1,19 @@
-# eslint-config-cic
+# @castiron/eslint-config
 
-An ESLint [Shareable Config](http://eslint.org/docs/developer-guide/shareable-configs) for CIC projects
+An ESLint [Shareable Config](http://eslint.org/docs/developer-guide/shareable-configs) for CIC projects.
+
+For React projects, use [`@castiron/eslint-config-react`](../eslint-config-react) instead.
 
 ## 💿 Installation
 
 ```bash
-yarn add @castiron/eslint-config -D
+yarn add -D @castiron/eslint-config eslint
+```
+
+The TypeScript config (and the default export, which includes it) needs TypeScript and its plugins installed alongside:
+
+```bash
+yarn add -D typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin
 ```
 
 ## 📖 Usage
@@ -21,12 +29,13 @@ import cicConfig from "@castiron/eslint-config";
 export default [...cicConfig];
 ```
 
-If you'd like to use only some of the rules, each config has a named export:
+If you'd like to use only some of the rules, import each config from its own entry point (`/base`, `/js`, `/ts`) so plugins for unused configs are never loaded:
 
 ```js
 // Example: Vanilla js project with babel parser.
 // eslint.config.js
-import { baseConfig, jsConfig } from "@castiron/eslint-config";
+import baseConfig from "@castiron/eslint-config/base";
+import jsConfig from "@castiron/eslint-config/js";
 
 export default [
   {
@@ -50,7 +59,9 @@ export default [
 ```js
 // Example: Astro project without react.
 // eslint.config.js
-import { baseConfig, jsConfig, tsConfig } from "@castiron/eslint-config";
+import baseConfig from "@castiron/eslint-config/base";
+import jsConfig from "@castiron/eslint-config/js";
+import tsConfig from "@castiron/eslint-config/ts";
 import eslintPluginAstro from "eslint-plugin-astro";
 
 export default [

package/configs/base.mjs

@@ -1,3 +1,4 @@
+import eslintPluginRegexp from "eslint-plugin-regexp";
 import unusedImports from "eslint-plugin-unused-imports";
 import globals from "globals";
 
@@ -9,6 +10,7 @@ const baseConfig = {
     }
   },
   rules: {
+    ...eslintPluginRegexp.configs["flat/recommended"].rules,
     "array-callback-return": 0,
     "arrow-body-style": 0,
     "global-require": 0,
@@ -54,6 +56,7 @@ const baseConfig = {
   },
   plugins: {
     "unused-imports": unusedImports,
+    regexp: eslintPluginRegexp,
   }
 };
 

package/index.mjs

@@ -1,15 +1,13 @@
 import baseConfig from "./configs/base.mjs";
 import jsConfig from "./configs/js.mjs";
 import tsConfig from "./configs/ts.mjs";
-import reactConfig from "./configs/react.mjs";
 
-// Export one big config (React/TS projects)
+// Export one big config (TS projects)
 export default [
   baseConfig,
   jsConfig,
-  tsConfig,
-  reactConfig
+  tsConfig
 ];
 
 // Export configs separately for finer control over linting rules
-export { baseConfig, jsConfig, tsConfig, reactConfig };
+export { baseConfig, jsConfig, tsConfig };

package/package.json

@@ -1,8 +1,15 @@
 {
   "name": "@castiron/eslint-config",
-  "version": "2.0.0",
+  "version": "2.1.0-alpha.6",
   "description": "General eslint configuration for Cast Iron Coding projects",
   "main": "index.mjs",
+  "exports": {
+    ".": "./index.mjs",
+    "./base": "./configs/base.mjs",
+    "./js": "./configs/js.mjs",
+    "./ts": "./configs/ts.mjs",
+    "./package.json": "./package.json"
+  },
   "files": [
     "index.mjs",
     "configs",
@@ -10,44 +17,48 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/castiron/eslint-config-cic.git"
+    "url": "git+https://github.com/castiron/eslint-config-cic.git",
+    "directory": "packages/eslint-config"
   },
   "author": "Cast Iron Coding",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/castiron/eslint-config-cic/issues"
   },
-  "homepage": "https://github.com/castiron/eslint-config-cic#readme",
+  "homepage": "https://github.com/castiron/eslint-config-cic/tree/main/packages/eslint-config#readme",
   "engines": {
     "node": ">=24.x"
   },
   "scripts": {
-    "npm:publish": "yarn npm publish --access public",
-    "lint": "eslint . --config index.mjs",
-    "fix": "eslint . --fix"
+    "npm:publish": "yarn npm publish --access public"
   },
-  "devDependencies": {
+  "dependencies": {
     "@eslint/js": "^10.0.1",
+    "eslint-plugin-regexp": "^3.3.1",
+    "eslint-plugin-unused-imports": "^4.4.1",
+    "globals": "^17.12.0"
+  },
+  "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^8.70.1",
     "@typescript-eslint/parser": "^8.70.1",
     "eslint": "^10.11.0",
-    "eslint-plugin-jsx-a11y": "^6.10.2",
-    "eslint-plugin-react": "^7.37.5",
-    "eslint-plugin-react-hooks": "^7.1.1",
-    "eslint-plugin-unused-imports": "^4.4.1",
-    "globals": "^17.12.0",
     "typescript": "^6.0.3"
   },
   "peerDependencies": {
-    "@eslint/js": ">= 10",
     "@typescript-eslint/eslint-plugin": ">= 8",
     "@typescript-eslint/parser": ">= 8",
     "eslint": ">= 10",
-    "eslint-plugin-jsx-a11y": ">= 6",
-    "eslint-plugin-react": ">= 7",
-    "eslint-plugin-react-hooks": ">= 7",
-    "eslint-plugin-unused-imports": ">= 4",
     "typescript": ">= 6"
   },
-  "packageManager": "yarn@4.14.1"
+  "peerDependenciesMeta": {
+    "@typescript-eslint/eslint-plugin": {
+      "optional": true
+    },
+    "@typescript-eslint/parser": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    }
+  }
 }

package/configs/react.mjs

@@ -1,25 +0,0 @@
-import reactHooks from "eslint-plugin-react-hooks";
-import jsxA11y from "eslint-plugin-jsx-a11y";
-
-const reactConfig = {
-  files: ["**/*.{jsx,tsx}"],
-  rules: {
-    ...reactHooks.configs.recommended.rules,
-    ...jsxA11y.configs.recommended.rules,
-    // React rules
-    "react-hooks/rules-of-hooks": ["warn"],
-    "react/react-in-jsx-scope": ["off"],
-    "react/display-name": ["off"],
-  },
-  plugins: {
-    "jsx-a11y": jsxA11y,
-    "react-hooks": reactHooks,
-  },
-  settings: {
-    react: {
-      version: "detect",
-    },
-  }
-};
-
-export default reactConfig;