@asd14/eslint-config 11.0.0 → 13.0.0

package/src/configs/node.js

@@ -1,11 +1,11 @@
+import jestPlugin from "eslint-plugin-jest"
 import prettierConfig from "eslint-plugin-prettier/recommended"
 import globals from "globals"
 
 import baseConfig from "../rules/base.js"
+import importConfig from "../rules/import.js"
 import jsdocConfig from "../rules/jsdoc.js"
 import unicornConfig from "../rules/unicorn.js"
-import importConfig from "../rules/import.js"
-import nxConfig from "../rules/nx.js"
 
 /** @type {import("eslint").Linter.RulesRecord} */
 const nodeSpecificRules = {
@@ -31,7 +31,7 @@ const nodeSpecificRules = {
 }
 
 /** @satisfies {import("eslint").Linter.Config} */
-export const nodeConfig = /** @type {const} */ ({
+const nodeConfig = /** @type {const} */ ({
   name: "ASD14 config for Node.js source files",
   ignores: ["node_modules", "dist", "coverage", "build"],
   languageOptions: {
@@ -48,7 +48,6 @@ export const nodeConfig = /** @type {const} */ ({
   plugins: {
     ...importConfig.plugins,
     ...jsdocConfig.plugins,
-    ...nxConfig.plugins,
     ...unicornConfig.plugins,
     ...prettierConfig.plugins,
   },
@@ -56,7 +55,6 @@ export const nodeConfig = /** @type {const} */ ({
     ...baseConfig.rules,
     ...importConfig.rules,
     ...jsdocConfig.rules,
-    ...nxConfig.rules,
     ...unicornConfig.rules,
     ...nodeSpecificRules,
     ...prettierConfig.rules,
@@ -66,3 +64,33 @@ export const nodeConfig = /** @type {const} */ ({
     ...importConfig.settings,
   },
 })
+
+const jestConfig = jestPlugin.configs["flat/recommended"]
+
+/** @satisfies {import("eslint").Linter.Config} */
+const nodeJestConfig = /** @type {const} */ ({
+  name: "ASD14's config for Node.js test files",
+  languageOptions: jestConfig.languageOptions,
+  plugins: jestConfig.plugins,
+  rules: {
+    ...jestConfig.rules,
+    "jest/require-top-level-describe": "error",
+    "jest/consistent-test-it": [
+      "error",
+      {
+        fn: "test",
+        withinDescribe: "test",
+      },
+    ],
+    "jest/valid-title": [
+      "error",
+      {
+        mustMatch: {
+          test: "^given \\[.*\\] should \\[.*\\]$",
+        },
+      },
+    ],
+  },
+})
+
+export { nodeConfig, nodeJestConfig }

package/src/{rules → configs}/nx.js

@@ -1,5 +1,8 @@
+import path from "node:path"
 import nxPlugin from "@nx/eslint-plugin"
 
+import { findUpSync } from "../utils/find-up-sync.js"
+
 const RULES = {
   // Visibility and publishing rules
   publicCanOnlyImportPublic: {
@@ -53,7 +56,8 @@ const RULES = {
 }
 
 /** @satisfies {import("eslint").Linter.Config} */
-export default /** @type {const} */ ({
+const nxConfig = /** @type {const} */ ({
+  name: "ASD14 config for source files inside an NX monorepo",
   plugins: {
     "@nx": nxPlugin,
   },
@@ -79,3 +83,39 @@ export default /** @type {const} */ ({
     ],
   },
 })
+
+const MONOREPO_ROOT = path.dirname(findUpSync("nx.json"))
+
+/** @satisfies {import("eslint").Linter.Config} */
+const nxDevConfig = /** @type {const} */ ({
+  name: "ASD14 config for dev files inside an NX monorepo",
+  plugins: {
+    "@nx": nxPlugin,
+  },
+  rules: {
+    /*
+     * Point to the monorepo root folder since ~all~ most devDependencies
+     * used in test, story and config files reside in the root package.json.
+     */
+    "import/no-extraneous-dependencies": [
+      "error",
+      {
+        packageDir: ["./", MONOREPO_ROOT],
+      },
+    ],
+    "@nx/enforce-module-boundaries": [
+      "error",
+      {
+        allow: [],
+        depConstraints: [
+          {
+            sourceTag: "*",
+            onlyDependOnLibsWithTags: ["type:lib"],
+          },
+        ],
+      },
+    ],
+  },
+})
+
+export { nxConfig, nxDevConfig }

package/src/configs/react.js

@@ -1,13 +1,14 @@
 import prettierConfig from "eslint-plugin-prettier/recommended"
 import globals from "globals"
 
+import { nodeJestConfig } from "./node.js"
 import baseConfig from "../rules/base.js"
-import jsdocConfig from "../rules/jsdoc.js"
-import unicornConfig from "../rules/unicorn.js"
 import importConfig from "../rules/import.js"
-import tsConfig from "../rules/typescript.js"
-import nxConfig from "../rules/nx.js"
+import jsdocConfig from "../rules/jsdoc.js"
 import reactHooksConfig from "../rules/react.js"
+import rtlConfig from "../rules/rtl.js"
+import tsConfig from "../rules/typescript.js"
+import unicornConfig from "../rules/unicorn.js"
 
 /** @type {import("eslint").Linter.RulesRecord} */
 const reactSpecificRules = {
@@ -37,7 +38,7 @@ const reactSpecificRules = {
 }
 
 /** @satisfies {import("eslint").Linter.Config} */
-export const reactConfig = /** @type {const} */ ({
+const reactConfig = /** @type {const} */ ({
   name: "ASD14 config for React source files",
   ignores: ["node_modules", "dist", "coverage", "build"],
   languageOptions: {
@@ -59,7 +60,6 @@ export const reactConfig = /** @type {const} */ ({
   plugins: {
     ...importConfig.plugins,
     ...jsdocConfig.plugins,
-    ...nxConfig.plugins,
     ...reactHooksConfig.plugins,
     ...tsConfig.plugins,
     ...unicornConfig.plugins,
@@ -69,7 +69,6 @@ export const reactConfig = /** @type {const} */ ({
     ...baseConfig.rules,
     ...importConfig.rules,
     ...jsdocConfig.rules,
-    ...nxConfig.rules,
     ...reactHooksConfig.rules,
     ...reactSpecificRules,
     ...tsConfig.rules,
@@ -87,3 +86,19 @@ export const reactConfig = /** @type {const} */ ({
     "import/ignore": [".(sass|scss|less|css)$"],
   },
 })
+
+/** @satisfies {import("eslint").Linter.Config} */
+const reactJestConfig = /** @type {const} */ ({
+  ...nodeJestConfig,
+  name: "ASD14 config for React test files",
+  plugins: {
+    ...nodeJestConfig.plugins,
+    ...rtlConfig.plugins,
+  },
+  rules: {
+    ...nodeJestConfig.rules,
+    ...rtlConfig.rules,
+  },
+})
+
+export { reactConfig, reactJestConfig }

package/src/rules/typescript.js

@@ -1,5 +1,5 @@
-import tsParser from "@typescript-eslint/parser"
 import tsPlugin from "@typescript-eslint/eslint-plugin"
+import tsParser from "@typescript-eslint/parser"
 
 /** @satisfies {import("eslint").Linter.Config} */
 export default /** @type {const} */ ({

package/dist/types/src/configs/dev-files.d.ts

@@ -1,14 +0,0 @@
-export namespace devFilesConfig {
-    let rules: {
-        readonly "@nx/enforce-module-boundaries": ["error", {
-            readonly allow: readonly [];
-            readonly depConstraints: readonly [{
-                readonly sourceTag: "*";
-                readonly onlyDependOnLibsWithTags: readonly ["type:lib"];
-            }];
-        }];
-        readonly "import/no-extraneous-dependencies": ["error", {
-            readonly packageDir: readonly ["./", string];
-        }];
-    };
-}

package/dist/types/src/configs/node-jest.d.ts

@@ -1,17 +0,0 @@
-export namespace nodeJestConfig {
-    let name: "ASD14's config for Node.js test files";
-    let languageOptions: import("eslint").Linter.LanguageOptions | undefined;
-    let plugins: Record<string, import("eslint").ESLint.Plugin> | undefined;
-    let rules: {
-        readonly "jest/require-top-level-describe": "error";
-        readonly "jest/consistent-test-it": ["error", {
-            readonly fn: "test";
-            readonly withinDescribe: "test";
-        }];
-        readonly "jest/valid-title": ["error", {
-            readonly mustMatch: {
-                readonly test: "^given \\[.*\\] should \\[.*\\]$";
-            };
-        }];
-    };
-}

package/dist/types/src/configs/react-jest.d.ts

@@ -1,20 +0,0 @@
-/** @satisfies {import("eslint").Linter.Config} */
-export const reactJestConfig: {
-    readonly name: "ASD14 config for React test files";
-    readonly plugins: {
-        readonly [x: string]: import("eslint").ESLint.Plugin;
-    };
-    readonly rules: {
-        readonly "jest/require-top-level-describe": "error";
-        readonly "jest/consistent-test-it": ["error", {
-            readonly fn: "test";
-            readonly withinDescribe: "test";
-        }];
-        readonly "jest/valid-title": ["error", {
-            readonly mustMatch: {
-                readonly test: "^given \\[.*\\] should \\[.*\\]$";
-            };
-        }];
-    };
-    readonly languageOptions: import("eslint").Linter.LanguageOptions | undefined;
-};

package/dist/types/src/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./configs/node.js";
-export * from "./configs/ts-node.js";
-export * from "./configs/node-jest.js";
-export * from "./configs/react.js";
-export * from "./configs/react-jest.js";
-export * from "./configs/dev-files.js";

package/dist/types/src/rules/import-dev.d.ts

@@ -1,9 +0,0 @@
-declare namespace _default {
-    let files: ["type-tests/**/*.{js,jsx,ts,tsx}", "*.tt.{js,jsx,ts,tsx}", "tests/**/*.{js,jsx,ts,tsx}", "*.test.{js,jsx,ts,tsx}", "stories/**/*.{js,jsx,ts,tsx}", "*.stories.{js,jsx,ts,tsx}", "eslint.config.js", "jest.setup.js", "jest.config.js"];
-    let rules: {
-        readonly "import/no-extraneous-dependencies": ["error", {
-            readonly packageDir: readonly ["./", string];
-        }];
-    };
-}
-export default _default;

package/dist/types/src/rules/nx-dev.d.ts

@@ -1,13 +0,0 @@
-declare namespace _default {
-    let files: ["jest.setup.{ts,js}", "jest.config.{ts,js}", "eslint.config.js"];
-    let rules: {
-        readonly "@nx/enforce-module-boundaries": ["error", {
-            readonly allow: readonly [];
-            readonly depConstraints: readonly [{
-                readonly sourceTag: "*";
-                readonly onlyDependOnLibsWithTags: readonly ["type:lib"];
-            }];
-        }];
-    };
-}
-export default _default;

package/src/configs/dev-files.js

@@ -1,17 +0,0 @@
-import nxDev from "../rules/nx-dev.js"
-import importDev from "../rules/import-dev.js"
-
-/**
- * ESLint configuration for development files (configs, tests etc)
- *
- * - Configure "import/no-extraneous-dependencies" to allow importing of
- * packages from the root monorepo "node_modules" folder.
- *
- * @satisfies {import("eslint").Linter.Config}
- */
-export const devFilesConfig = /** @type {const} */ ({
-  rules: {
-    ...importDev.rules,
-    ...nxDev.rules,
-  },
-})

package/src/configs/node-jest.js

@@ -1,29 +0,0 @@
-import jestPlugin from "eslint-plugin-jest"
-
-const jestConfig = jestPlugin.configs["flat/recommended"]
-
-/** @satisfies {import("eslint").Linter.Config} */
-export const nodeJestConfig = /** @type {const} */ ({
-  name: "ASD14's config for Node.js test files",
-  languageOptions: jestConfig.languageOptions,
-  plugins: jestConfig.plugins,
-  rules: {
-    ...jestConfig.rules,
-    "jest/require-top-level-describe": "error",
-    "jest/consistent-test-it": [
-      "error",
-      {
-        fn: "test",
-        withinDescribe: "test",
-      },
-    ],
-    "jest/valid-title": [
-      "error",
-      {
-        mustMatch: {
-          test: "^given \\[.*\\] should \\[.*\\]$",
-        },
-      },
-    ],
-  },
-})

package/src/configs/react-jest.js

@@ -1,16 +0,0 @@
-import { nodeJestConfig } from "./node-jest.js"
-import rtlConfig from "../rules/rtl.js"
-
-/** @satisfies {import("eslint").Linter.Config} */
-export const reactJestConfig = /** @type {const} */ ({
-  ...nodeJestConfig,
-  name: "ASD14 config for React test files",
-  plugins: {
-    ...nodeJestConfig.plugins,
-    ...rtlConfig.plugins,
-  },
-  rules: {
-    ...nodeJestConfig.rules,
-    ...rtlConfig.rules,
-  },
-})

package/src/index.js

@@ -1,6 +0,0 @@
-export * from "./configs/node.js"
-export * from "./configs/ts-node.js"
-export * from "./configs/node-jest.js"
-export * from "./configs/react.js"
-export * from "./configs/react-jest.js"
-export * from "./configs/dev-files.js"

package/src/rules/import-dev.js

@@ -1,31 +0,0 @@
-import path from "node:path"
-import { findUpSync } from "../utils/find-up-sync.js"
-
-const MONOREPO_ROOT = path.dirname(findUpSync("nx.json"))
-
-/** @satisfies {import("eslint").Linter.Config} */
-export default /** @type {const} */ ({
-  files: [
-    "type-tests/**/*.{js,jsx,ts,tsx}",
-    "*.tt.{js,jsx,ts,tsx}",
-    "tests/**/*.{js,jsx,ts,tsx}",
-    "*.test.{js,jsx,ts,tsx}",
-    "stories/**/*.{js,jsx,ts,tsx}",
-    "*.stories.{js,jsx,ts,tsx}",
-    "eslint.config.js",
-    "jest.setup.js",
-    "jest.config.js",
-  ],
-  rules: {
-    /*
-     * Point to the monorepo root folder since ~all~ most devDependencies
-     * used in test, story and config files reside in the root package.json.
-     */
-    "import/no-extraneous-dependencies": [
-      "error",
-      {
-        packageDir: ["./", MONOREPO_ROOT],
-      },
-    ],
-  },
-})

package/src/rules/nx-dev.js

@@ -1,23 +0,0 @@
-/** @satisfies {import("eslint").Linter.Config} */
-export default /** @type {const} */ ({
-  /*
-   * Configuration files dont need any visibility restrictions since
-   * they are only for development and build purposes and are not
-   * emited in the final bundle/public artifacts.
-   */
-  files: ["jest.setup.{ts,js}", "jest.config.{ts,js}", "eslint.config.js"],
-  rules: {
-    "@nx/enforce-module-boundaries": [
-      "error",
-      {
-        allow: [],
-        depConstraints: [
-          {
-            sourceTag: "*",
-            onlyDependOnLibsWithTags: ["type:lib"],
-          },
-        ],
-      },
-    ],
-  },
-})