@asd14/eslint-config 14.5.0 → 15.0.0

package/package.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@asd14/eslint-config",
-  "version": "14.5.0",
-  "description": "ASD14's reusable ESLint config",
+  "version": "15.0.0",
+  "description": "ASD14's reusable ESLint configurations",
   "sideEffects": false,
   "publishConfig": {
     "access": "public"
@@ -15,6 +15,13 @@
     "dist",
     "src"
   ],
+  "nx": {
+    "projectType": "library",
+    "tags": [
+      "type:library",
+      "target:node"
+    ]
+  },
   "type": "module",
   "exports": {
     "./node": {
@@ -25,9 +32,9 @@
       "import": "./src/configs/react.js",
       "types": "./dist/types/src/configs/react.d.ts"
     },
-    "./typescript": {
-      "import": "./src/configs/typescript.js",
-      "types": "./dist/types/src/configs/typescript.d.ts"
+    "./ts": {
+      "import": "./src/configs/ts.js",
+      "types": "./dist/types/src/configs/ts.d.ts"
     },
     "./nx": {
       "import": "./src/configs/nx.js",
@@ -49,11 +56,11 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@nx/eslint-plugin": "^22.5.1",
+    "@nx/eslint-plugin": "^22.5.3",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-jest": "^29.14.0",
-    "eslint-plugin-jsdoc": "^62.5.5",
+    "eslint-plugin-jest": "^29.15.0",
+    "eslint-plugin-jsdoc": "^62.7.1",
     "eslint-plugin-json": "^4.0.1",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-no-inferred-method-name": "^2.0.0",
@@ -61,24 +68,25 @@
     "eslint-plugin-promise": "^7.2.1",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^7.0.1",
-    "eslint-plugin-react-refresh": "^0.5.0",
-    "eslint-plugin-testing-library": "^7.15.4",
+    "eslint-plugin-react-refresh": "^0.5.2",
+    "eslint-plugin-testing-library": "^7.16.0",
     "eslint-plugin-unicorn": "^63.0.0",
-    "globals": "^17.3.0",
-    "typescript-eslint": "^8.55.0"
+    "globals": "^17.4.0",
+    "typescript-eslint": "^8.56.1"
   },
   "devDependencies": {
-    "@asd14/prettier-config": "^1.1.0",
-    "@asd14/ts-config": "^1.1.0",
-    "@commitlint/cli": "^20.4.1",
-    "@commitlint/config-conventional": "^20.4.1",
+    "@asd14/prettier-config": "^1.2.0",
+    "@asd14/ts-config": "^1.3.0",
+    "@commitlint/cli": "^20.4.2",
+    "@commitlint/config-conventional": "^20.4.2",
     "@semantic-release/git": "^10.0.1",
     "conventional-changelog-conventionalcommits": "^9.1.0",
     "semantic-release": "^25.0.3"
   },
   "peerDependencies": {
     "eslint": "^9",
-    "prettier": "^3"
+    "prettier": "^3",
+    "typescript": "^5"
   },
   "engines": {
     "node": "^22.12.0 || ^24.0.0"

package/src/configs/node.js

@@ -1,8 +1,9 @@
-import jestPlugin from "eslint-plugin-jest"
 import prettierConfig from "eslint-plugin-prettier/recommended"
 import globals from "globals"
 
 import baseConfig from "../rules/base.js"
+import devConfig from "../rules/dev.js"
+import commonIgnores from "../rules/ignores.js"
 import importConfig from "../rules/import.js"
 import jsdocConfig from "../rules/jsdoc.js"
 import unicornConfig from "../rules/unicorn.js"
@@ -13,17 +14,15 @@ const nodeSpecificRules = {
   "unicorn/prevent-abbreviations": [
     "error",
     {
+      ignore: ["utils", "db", "props"],
       replacements: {
         i: false,
-        utils: false,
         params: false,
         lib: false,
         args: {
           params: true,
         },
-        props: {
-          options: true,
-        },
+        props: false,
         fn: false,
         acc: false,
       },
@@ -34,7 +33,6 @@ const nodeSpecificRules = {
 /** @satisfies {import("eslint").Linter.Config} */
 const nodeConfig = /** @type {const} */ ({
   name: "ASD14 config for Node.js source files",
-  ignores: ["node_modules", "dist", "coverage", "build"],
   languageOptions: {
     ecmaVersion: "latest",
     sourceType: "module",
@@ -66,33 +64,4 @@ const nodeConfig = /** @type {const} */ ({
   },
 })
 
-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 { commonIgnores } from "../rules/ignores.js"
-export { nodeConfig, nodeJestConfig }
+export { commonIgnores, devConfig, nodeConfig }

package/src/configs/nx.js

@@ -1,8 +1,5 @@
-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: {
@@ -15,33 +12,33 @@ const RULES = {
   },
   // Package type rules
   libsCanOnlyImportLibs: {
-    sourceTag: "type:lib",
-    onlyDependOnLibsWithTags: ["type:lib"],
+    sourceTag: "type:library",
+    onlyDependOnLibsWithTags: ["type:library"],
   },
   hooksCanOnlyImportLibsAndHooks: {
     sourceTag: "type:hook",
-    onlyDependOnLibsWithTags: ["type:lib", "type:hook"],
+    onlyDependOnLibsWithTags: ["type:library", "type:hook"],
   },
   uiCanImportAny: {
     sourceTag: "type:ui",
-    onlyDependOnLibsWithTags: ["type:ui", "type:lib", "type:hook"],
+    onlyDependOnLibsWithTags: ["type:ui", "type:library", "type:hook"],
   },
   appsCanImportAny: {
     sourceTag: "type:app",
-    onlyDependOnLibsWithTags: ["type:ui", "type:lib", "type:hook"],
+    onlyDependOnLibsWithTags: ["type:ui", "type:library", "type:hook"],
   },
-  // Runtime rules
-  apiCanOnlyImportApiOrNode: {
-    sourceTag: "runtime:api",
-    onlyDependOnLibsWithTags: ["runtime:api", "runtime:node"],
+  // Runtime/Target rules
+  apiCanOnlyImportApiOrNodeOrAny: {
+    sourceTag: "target:api",
+    onlyDependOnLibsWithTags: ["target:api", "target:node", "target:any"],
   },
-  reactCanOnlyImportReactOrNode: {
-    sourceTag: "runtime:react",
-    onlyDependOnLibsWithTags: ["runtime:react", "runtime:node"],
+  reactCanOnlyImportReactOrAny: {
+    sourceTag: "target:react",
+    onlyDependOnLibsWithTags: ["target:react", "target:any"],
   },
-  nodeCanImportNode: {
-    sourceTag: "runtime:node",
-    onlyDependOnLibsWithTags: ["runtime:node"],
+  nodeCanImportNodeOrAny: {
+    sourceTag: "target:node",
+    onlyDependOnLibsWithTags: ["target:node", "target:any"],
   },
   // Domain rules
   domainCanOnlyImportSelf: {
@@ -55,9 +52,12 @@ const RULES = {
   },
 }
 
-/** @satisfies {import("eslint").Linter.Config} */
+/**
+ * Strict NX module boundary rules for source files.
+ *
+ * @satisfies {import("eslint").Linter.Config}
+ */
 const nxConfig = /** @type {const} */ ({
-  name: "ASD14 config for source files inside an NX monorepo",
   plugins: {
     "@nx": nxPlugin,
   },
@@ -65,7 +65,10 @@ const nxConfig = /** @type {const} */ ({
     "@nx/enforce-module-boundaries": [
       "error",
       {
-        allow: [],
+        allow: [
+          "^.*/types$", // Allow importing types across boundaries (compile-time only)
+          "^.*/const$", // Allow importing constants across boundaries (pure data)
+        ],
         depConstraints: [
           RULES.publicCanOnlyImportPublic,
           RULES.privateCanImportAny,
@@ -73,9 +76,9 @@ const nxConfig = /** @type {const} */ ({
           RULES.hooksCanOnlyImportLibsAndHooks,
           RULES.uiCanImportAny,
           RULES.appsCanImportAny,
-          RULES.apiCanOnlyImportApiOrNode,
-          RULES.reactCanOnlyImportReactOrNode,
-          RULES.nodeCanImportNode,
+          RULES.apiCanOnlyImportApiOrNodeOrAny,
+          RULES.reactCanOnlyImportReactOrAny,
+          RULES.nodeCanImportNodeOrAny,
           RULES.domainCanOnlyImportSelf,
           RULES.noTestImportsInProd,
         ],
@@ -84,25 +87,18 @@ const nxConfig = /** @type {const} */ ({
   },
 })
 
-const MONOREPO_ROOT = path.dirname(findUpSync("nx.json"))
-
-/** @satisfies {import("eslint").Linter.Config} */
+/**
+ * Relaxed NX module boundary rules for dev files (tests, configs, stories).
+ * Dev files dont need strict visibility/runtime/domain enforcement since
+ * they are not emited in the final bundle.
+ *
+ * @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",
       {
@@ -110,7 +106,7 @@ const nxDevConfig = /** @type {const} */ ({
         depConstraints: [
           {
             sourceTag: "*",
-            onlyDependOnLibsWithTags: ["type:lib"],
+            onlyDependOnLibsWithTags: ["type:library"],
           },
         ],
       },

package/src/configs/react.js

@@ -1,12 +1,12 @@
 import prettierConfig from "eslint-plugin-prettier/recommended"
 import globals from "globals"
 
-import { nodeJestConfig } from "./node.js"
 import baseConfig from "../rules/base.js"
+import devConfig from "../rules/dev.js"
+import commonIgnores from "../rules/ignores.js"
 import importConfig from "../rules/import.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"
 
@@ -16,8 +16,10 @@ const reactSpecificRules = {
   "unicorn/prevent-abbreviations": [
     "error",
     {
+      ignore: ["utils", "props"],
       replacements: {
         i: false,
+        ref: false,
         params: false,
         lib: false,
         args: {
@@ -39,8 +41,7 @@ const reactSpecificRules = {
 
 /** @satisfies {import("eslint").Linter.Config} */
 const reactConfig = /** @type {const} */ ({
-  name: "ASD14 config for React source files",
-  ignores: ["node_modules", "dist", "coverage", "build"],
+  name: "ASD14 config for Typescript + React source files",
   languageOptions: {
     ...tsConfig.languageOptions,
     ecmaVersion: "latest",
@@ -69,9 +70,9 @@ const reactConfig = /** @type {const} */ ({
     ...baseConfig.rules,
     ...importConfig.rules,
     ...jsdocConfig.rules,
+    ...tsConfig.rules,
     ...reactHooksConfig.rules,
     ...reactSpecificRules,
-    ...tsConfig.rules,
     ...unicornConfig.rules,
     ...prettierConfig.rules,
   },
@@ -87,19 +88,4 @@ const reactConfig = /** @type {const} */ ({
   },
 })
 
-/** @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 { commonIgnores } from "../rules/ignores.js"
-export { reactConfig, reactJestConfig }
+export { commonIgnores, devConfig, reactConfig }

package/src/configs/{typescript.js → ts.js}

@@ -1,19 +1,21 @@
 import { nodeConfig } from "./node.js"
-import tsConfig from "../rules/typescript.js"
+import devConfig from "../rules/dev.js"
+import commonIgnores from "../rules/ignores.js"
+import typescriptConfig from "../rules/typescript.js"
 
 /** @satisfies {import("eslint").Linter.Config} */
-const tsNodeConfig = /** @type {const} */ ({
+const tsConfig = /** @type {const} */ ({
   name: "ASD14 config for Typescript + Node.js source files",
   languageOptions: {
     ...nodeConfig.languageOptions,
-    ...tsConfig.languageOptions,
+    ...typescriptConfig.languageOptions,
   },
   plugins: {
-    ...tsConfig.plugins,
+    ...typescriptConfig.plugins,
     ...nodeConfig.plugins,
   },
   rules: {
-    ...tsConfig.rules,
+    ...typescriptConfig.rules,
     ...nodeConfig.rules,
   },
   settings: {
@@ -21,5 +23,4 @@ const tsNodeConfig = /** @type {const} */ ({
   },
 })
 
-export { commonIgnores } from "../rules/ignores.js"
-export { tsNodeConfig }
+export { commonIgnores, devConfig, tsConfig }

package/src/rules/dev.js

@@ -0,0 +1,10 @@
+/** @satisfies {import("eslint").Linter.Config} */
+export default /** @type {const} */ ({
+  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": "off",
+  },
+})

package/src/rules/ignores.js

@@ -2,7 +2,8 @@
  * Common ignore patterns for ESLint flat configs
  * These are build outputs and dependencies that should never be linted
  */
-export const commonIgnores = /** @type {const} */ ([
+export default /** @type {string[]} */ ([
+  ".local/**",
   "node_modules/**",
   "dist/**",
   "coverage/**",

package/src/rules/jsdoc.js

@@ -10,30 +10,23 @@ export default /** @type {const} */ ({
       "error",
       {
         reportIntraTagGroupSpacing: false,
-        reportTagGroupSpacing: false,
+        reportTagGroupSpacing: true,
+        tagSequence: [
+          { tags: ["typedef", "callback"] },
+          { tags: ["param", "arg", "argument", "property", "prop"] },
+          { tags: ["returns", "return"] },
+          { tags: ["throws", "exception"] },
+          { tags: ["example"] },
+        ],
       },
     ],
     "jsdoc/tag-lines": [
       "error",
-      "always",
+      "any",
       {
         startLines: 1,
         endLines: 0,
         applyToEndTag: false,
-        tags: {
-          returns: {
-            lines: "always",
-          },
-          property: {
-            lines: "any",
-          },
-          param: {
-            lines: "any",
-          },
-          example: {
-            lines: "always",
-          },
-        },
       },
     ],
     "jsdoc/check-indentation": "error",

package/src/rules/typescript.js

@@ -12,6 +12,10 @@ export default /** @type {const} */ ({
   rules: {
     ...tsPlugin.configs["strict-type-checked"]?.rules,
 
+    // Temporary: disable due to bug in ESLint 9.39.0
+    // https://github.com/eslint/eslint/issues/20272
+    "@typescript-eslint/unified-signatures": "off",
+
     "@typescript-eslint/no-unused-vars": [
       "error",
       {

package/src/utils/find-up-sync.js

@@ -12,22 +12,21 @@ import path from "node:path"
  *
  * @param {string} fileName - The name of the file to find.
  * @param {FindUpSyncOptions} [options] - Options for the function.
+ *
  * @returns {string} The absolute path to the file.
  */
 
 /**
  * Find a file up the directory tree synchronously.
  *
- * @type {FindUpSyncFn}
- *
  * @throws {Error} If the starting folder does not exist.
- *
  * @throws {Error} If the file does not exist up the tree.
  *
  * @example
  *  const filePath = findUpSync("lerna.json");
  *  //=> "/Users/johndoe/Projects/WootWoot/lerna.json"
  *
+ * @type {FindUpSyncFn}
  */
 const findUpSync = (fileName, options = {}) => {
   let { cwd } = options