@exadev/eslint-config 1.1.1 → 1.2.0

package/README.md

@@ -1,5 +1,7 @@
 # @exadev/eslint-config
 
+[![GitHub](https://img.shields.io/badge/GitHub-181717?logo=github&logoColor=white)](https://github.com/ExaDev/eslint-config) [![npm](https://img.shields.io/badge/npm-CB3837?logo=npm&logoColor=white)](https://www.npmjs.com/package/@exadev/eslint-config) [![Release](https://img.shields.io/github/v/release/ExaDev/eslint-config)](https://github.com/ExaDev/eslint-config/releases/latest) [![CI](https://img.shields.io/github/actions/workflow/status/ExaDev/eslint-config/ci.yml?branch=main)](https://github.com/ExaDev/eslint-config/actions)
+
 > A real ESLint plugin (not a shareable config) exposing custom rules shared across ExaDev projects. Also published under the unscoped alias `exadev-eslint-config`.
 
 ## Why
@@ -8,7 +10,9 @@ Multiple ExaDev repos independently carried identical copies of a handful of cus
 
 Only the *rules* are centralized here, not a consumer's whole `eslint.config.ts`. A repo's own file-scoping (`files`/`ignores`), tsconfig wiring, and any runtime-isomorphism import bans are genuinely project-specific -- forcing those into one shared config would mean either losing real per-project distinctions or building a heavily-parameterised config just to route around them. Each consumer keeps its own `eslint.config.ts`, importing rule implementations from here instead of a local copy.
 
-## Usage
+## Getting started
+
+Consumers need `eslint >=10.0.0` as a peer dependency. `typescript-eslint >=8.0.0` is also a peer dependency, but an *optional* one (`peerDependenciesMeta`) -- it's only needed by the `recommended-type-checked` entry point described below, not by the package as a whole. A plain-JS project with no TypeScript at all can install and use this package with nothing else added.
 
 ```sh
 pnpm add -D @exadev/eslint-config
@@ -42,13 +46,39 @@ export default defineConfig([
   {
     files: ['**/*.ts'],
     plugins: { exadev },
-    extends: ['exadev/recommended'], // every rule this plugin defines, plus no-inline-config and no-type-assertions
+    extends: ['exadev/recommended'], // this plugin's own four rules, plus linterOptions.noInlineConfig -- no TypeScript involvement at all
     // or: extends: ['exadev/barrel'], // just the barrel-discipline trio (no-non-barrel-index, no-non-barrel-reexport, no-side-effects-in-index)
   },
 ]);
 ```
 
-`recommended` also turns on two general code-quality settings every current consumer already wires independently: `linterOptions.noInlineConfig` (no `eslint-disable` comments anywhere -- an exception belongs in the config, scoped to where it applies, not hidden inline in the source it's disabling a rule for) and `@typescript-eslint/consistent-type-assertions` set to `never` (no `as`/angle-bracket type assertions -- narrow with a guard or parse with Zod instead). The type-assertions rule is `@typescript-eslint`'s own, not one this plugin defines, so `recommended` assumes the consumer already has `typescript-eslint` registered under the `@typescript-eslint` namespace -- true for every consumer this plugin currently has. A consumer with no typescript-eslint at all should use `barrel`, or wire the four `exadev/*` rules directly, instead of taking `recommended` wholesale.
+Both `recommended` and `barrel` are usable in a plain JavaScript project with no TypeScript and no `typescript-eslint` installed: this plugin's own four rules operate on plain ESTree import/export/declaration nodes, nothing TypeScript-specific, and neither config references `typescript-eslint` at all.
+
+### The typed-linting bundle: `@exadev/eslint-config/recommended-type-checked`
+
+For a TypeScript project that wants the full typed-linting baseline bundled in, import the separate `recommended-type-checked` entry point instead of using `configs.recommended`:
+
+```ts
+// eslint.config.ts
+import exadevRecommendedTypeChecked from '@exadev/eslint-config/recommended-type-checked';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  {
+    languageOptions: {
+      parserOptions: { project: './tsconfig.json', tsconfigRootDir: import.meta.dirname },
+    },
+  },
+  ...exadevRecommendedTypeChecked,
+  // ...your own config on top...
+);
+```
+
+This bundles `typescript-eslint`'s own `recommendedTypeChecked` and `stylisticTypeChecked` presets (`recommendedTypeChecked` already subsumes plain `recommended` outright -- every one of its 46 rules is a strict subset of `recommendedTypeChecked`'s 73, confirmed by inspecting the actual rule maps) alongside this plugin's own four rules, `linterOptions.noInlineConfig`, and `@typescript-eslint/consistent-type-assertions` set to `never` (no `as`/angle-bracket type assertions -- narrow with a guard or parse with Zod instead).
+
+It's a real bundling, not a rule reference that assumes the consumer already has `typescript-eslint` set up: `recommendedTypeChecked`'s own base config registers the `@typescript-eslint` plugin and sets `languageOptions.parser` itself. **A consumer adopting this bundle must remove its own `...tseslint.configs.recommended`/`recommendedTypeChecked`/`stylisticTypeChecked` spreads** rather than keep them alongside it -- ESLint flat config rejects two different plugin object instances registered under the same namespace. What a consumer still supplies itself is `languageOptions.parserOptions.project`/`projectService` pointing at its own tsconfig(s); `recommendedTypeChecked`'s base config never sets that, since it's genuinely project-specific.
+
+This lives in its own module, separate from the main `@exadev/eslint-config` entry point, specifically so importing the main package never attempts to resolve `typescript-eslint`. A plain object property (or a lazy getter) on the base plugin's own `configs` map can't achieve that: ESLint's `extends` resolution is synchronous, so a dynamic `import()` doesn't help either -- it just hides the same requirement behind an unawaited promise. Splitting into a genuinely separate module sidesteps the problem at the right layer: Node's own module resolution only loads a module when something actually imports it.
 
 ## Rules
 
@@ -59,10 +89,10 @@ export default defineConfig([
 | `no-pointless-reassignment` | ✓ | `const foo = bar` where both sides are plain identifiers and the alias adds no transformation. |
 | `no-side-effects-in-index` | | The public barrel may contain only re-export statements -- nothing that could execute at import time. |
 
-## Development
+## Build, test, and lint
 
 ```sh
-pnpm install
+pnpm install    # requires Node >=20 and pnpm 11.6.0 (pinned via packageManager)
 pnpm lint
 pnpm typecheck
 pnpm build
@@ -70,9 +100,39 @@ pnpm build
 
 No test suite exists for these rules currently -- each is verified by real-world usage against the repos it was extracted from, the same way it was verified before being centralized here.
 
+The `lint`/`typecheck`/`build` npm scripts are thin wrappers around turbo tasks whose own names carry a leading underscore (`_lint`/`_typecheck`/`_build`, declared in `turbo.json`) -- run `pnpm build`, not `turbo run build` directly, since turbo's task names don't match the npm script names.
+
+`pnpm build` runs `tsdown`, emitting ESM and CJS output plus declaration files from `src/**/*.ts` (platform-neutral, `src/**/*.test.ts` excluded). Before any publish -- local or the CI alias job -- `prepublishOnly` re-runs lint, typecheck, `tsdown`, `publint`, and `attw --pack`, so a broken export shape fails at publish time even outside the main CI pipeline.
+
+## Architecture
+
+`src/plugin.ts` builds an `ESLint.Plugin` object (ESLint's own `ESLint.Plugin` type, not a hand-written interface) combining the four rule modules under `src/rules/` into a flat `rules` map. `configs.recommended` and `configs.barrel` are defined as getters directly in the object literal, not attached after construction: each needs to reference the fully-built `plugin` object itself (`plugins: { exadev: plugin }`), which a plain property initializer can't do for its own binding while it's still being constructed. A getter closes over the `plugin` binding rather than its value, so it resolves correctly the moment a consumer actually reads the property, by which point construction has finished -- no `Object.assign`, no post-construction mutation, no null-checked destructure needed. `src/index.ts` is the public entry point and is nothing but `export { default } from './plugin';` -- a genuine pure re-export barrel.
+
+`src/recommended-type-checked.ts` is a deliberately separate module, not a third property on the base plugin's own `configs`. It imports `typescript-eslint` to bundle `recommendedTypeChecked` + `stylisticTypeChecked` alongside this plugin's own rules -- see [The typed-linting bundle](#the-typed-linting-bundle-exadeveslint-configrecommended-type-checked) above for why that has to live in its own module rather than on the shared plugin object: importing the main entry point must never attempt to resolve `typescript-eslint`, and Node's own module resolution only loads a module when something actually imports it.
+
+`pnpm-workspace.yaml` deliberately declares an empty `packages: []`. This is not a real multi-package pnpm workspace; its only purpose is giving turbo a workspace root to anchor local task caching against, matching the same single-package-workspace pattern used across this repo family.
+
+## Conventions
+
+`eslint.config.ts` dogfoods this package's own rules on itself, importing `./src/index` by relative path rather than as an installed dependency. All four rules apply to this repo's own source: `no-non-barrel-reexport` is scoped to `src/**/*.ts` excluding `src/index.ts` (the barrel is where re-exports are meant to live), and `no-side-effects-in-index` is scoped to `src/index.ts` alone -- the plugin-construction logic lives in `src/plugin.ts` specifically so `src/index.ts` can stay a pure re-export point both rules assume.
+
+`tsconfig.json` enables `verbatimModuleSyntax` (type-only imports/exports must use `import type`/`export type` explicitly -- enforced too by the `consistent-type-imports` eslint rule) and `noUncheckedIndexedAccess` (indexed access returns `T | undefined`, narrow before use rather than asserting).
+
+Conventional commits are enforced by commitlint, restricted to the type-enum defined once in `release.config.ts`'s `commitTypes` -- both commitlint's allowed types and semantic-release's commit-analyzer release rules derive from that single list, so a commit type can't trigger a release without also being accepted by commit-msg validation, or the reverse.
+
+## Gotchas and quirks
+
+- `.attw.json` ignores the `false-export-default` rule: tsdown/rolldown's CJS output for this plugin's sole default export doesn't emit the `export =` form `arethetypeswrong`'s check wants under legacy `node10` resolution. The resolution modes an ESLint flat config actually uses (`node16`, `bundler`) are unaffected, so the rule is suppressed rather than moving the plugin away from ESLint's own documented default-export shape.
+- Husky hooks: `pre-commit` runs lint-staged (`eslint --fix` on staged `*.ts`), `commit-msg` runs commitlint against the message, `pre-push` runs `typecheck` and `build` -- pushing here rebuilds the whole package first.
+- The CI release job sets `HUSKY=0` (so the commit-msg hook never fires against the automated release commit) and blanks `NPM_TOKEN`/`NODE_AUTH_TOKEN` explicitly rather than omitting them, so an inherited token can't win over npm's OIDC trusted-publishing exchange.
+
+## Contributing
+
+Conventional commits are enforced by commitlint via a husky `commit-msg` hook, and re-checked in CI. CI runs commitlint, lint, and typecheck+build+attw on every push and pull request; the release job only runs on a push to `main`, after all three pass.
+
 ## Release
 
-Conventional commits (enforced by commitlint) drive [semantic-release](https://semantic-release.gitbook.io/semantic-release) on every push to `main`: version bump, `CHANGELOG.md`, GitHub Release, and an npm publish via OIDC trusted publishing (no stored token). A second CI job republishes the identical build under the unscoped alias `exadev-eslint-config`.
+Conventional commits drive [semantic-release](https://semantic-release.gitbook.io/semantic-release) on every push to `main`: version bump, `CHANGELOG.md`, GitHub Release, and an npm publish via OIDC trusted publishing (no stored token). A second CI job then republishes the identical build under the unscoped alias `exadev-eslint-config`.
 
 ## License
 

package/dist/index.cjs

@@ -1,2 +1,2 @@
-const require_plugin = require("./plugin-jELHVCCw.cjs");
+const require_plugin = require("./plugin-Dixk0WAc.cjs");
 module.exports = require_plugin.plugin;

package/dist/index.js

@@ -1,2 +1,2 @@
-import { t as plugin } from "./plugin-BBix8yMe.js";
+import { t as plugin } from "./plugin-Cq16p_yl.js";
 export { plugin as default };

package/dist/plugin-Cq16p_yl.js

@@ -0,0 +1,45 @@
+import noNonBarrelIndex from "./rules/no-non-barrel-index.js";
+import noNonBarrelReexport from "./rules/no-non-barrel-reexport.js";
+import noPointlessReassignment from "./rules/no-pointless-reassignment.js";
+import noSideEffectsInIndex from "./rules/no-side-effects-in-index.js";
+//#endregion
+//#region src/plugin.ts
+const plugin = {
+	meta: {
+		name: "@exadev/eslint-config",
+		version: "1.2.0",
+		namespace: "exadev"
+	},
+	rules: {
+		"no-non-barrel-index": noNonBarrelIndex,
+		"no-non-barrel-reexport": noNonBarrelReexport,
+		"no-pointless-reassignment": noPointlessReassignment,
+		"no-side-effects-in-index": noSideEffectsInIndex
+	},
+	configs: {
+		get recommended() {
+			return {
+				plugins: { exadev: plugin },
+				linterOptions: { noInlineConfig: true },
+				rules: {
+					"exadev/no-non-barrel-index": "error",
+					"exadev/no-non-barrel-reexport": "error",
+					"exadev/no-pointless-reassignment": "error",
+					"exadev/no-side-effects-in-index": "error"
+				}
+			};
+		},
+		get barrel() {
+			return {
+				plugins: { exadev: plugin },
+				rules: {
+					"exadev/no-non-barrel-index": "error",
+					"exadev/no-non-barrel-reexport": "error",
+					"exadev/no-side-effects-in-index": "error"
+				}
+			};
+		}
+	}
+};
+//#endregion
+export { plugin as t };

package/dist/plugin-Dixk0WAc.cjs

@@ -0,0 +1,46 @@
+//#endregion
+//#region src/plugin.ts
+const plugin = {
+	meta: {
+		name: "@exadev/eslint-config",
+		version: "1.2.0",
+		namespace: "exadev"
+	},
+	rules: {
+		"no-non-barrel-index": require("./rules/no-non-barrel-index.cjs"),
+		"no-non-barrel-reexport": require("./rules/no-non-barrel-reexport.cjs"),
+		"no-pointless-reassignment": require("./rules/no-pointless-reassignment.cjs"),
+		"no-side-effects-in-index": require("./rules/no-side-effects-in-index.cjs")
+	},
+	configs: {
+		get recommended() {
+			return {
+				plugins: { exadev: plugin },
+				linterOptions: { noInlineConfig: true },
+				rules: {
+					"exadev/no-non-barrel-index": "error",
+					"exadev/no-non-barrel-reexport": "error",
+					"exadev/no-pointless-reassignment": "error",
+					"exadev/no-side-effects-in-index": "error"
+				}
+			};
+		},
+		get barrel() {
+			return {
+				plugins: { exadev: plugin },
+				rules: {
+					"exadev/no-non-barrel-index": "error",
+					"exadev/no-non-barrel-reexport": "error",
+					"exadev/no-side-effects-in-index": "error"
+				}
+			};
+		}
+	}
+};
+//#endregion
+Object.defineProperty(exports, "plugin", {
+	enumerable: true,
+	get: function() {
+		return plugin;
+	}
+});

package/dist/plugin.cjs

@@ -1,2 +1,2 @@
-const require_plugin = require("./plugin-jELHVCCw.cjs");
+const require_plugin = require("./plugin-Dixk0WAc.cjs");
 module.exports = require_plugin.plugin;

package/dist/plugin.js

@@ -1,2 +1,2 @@
-import { t as plugin } from "./plugin-BBix8yMe.js";
+import { t as plugin } from "./plugin-Cq16p_yl.js";
 export { plugin as default };

package/dist/recommended-type-checked.cjs

@@ -0,0 +1,43 @@
+//#region \0rolldown/runtime.js
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule || !__hasOwnProp.call(mod, "default") ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+//#endregion
+const require_plugin = require("./plugin-Dixk0WAc.cjs");
+let typescript_eslint = require("typescript-eslint");
+typescript_eslint = __toESM(typescript_eslint, 1);
+//#region src/recommended-type-checked.ts
+const recommendedTypeChecked = [
+	...typescript_eslint.default.configs.recommendedTypeChecked,
+	...typescript_eslint.default.configs.stylisticTypeChecked,
+	{
+		plugins: { exadev: require_plugin.plugin },
+		linterOptions: { noInlineConfig: true },
+		rules: {
+			"exadev/no-non-barrel-index": "error",
+			"exadev/no-non-barrel-reexport": "error",
+			"exadev/no-pointless-reassignment": "error",
+			"exadev/no-side-effects-in-index": "error",
+			"@typescript-eslint/consistent-type-assertions": ["error", { assertionStyle: "never" }]
+		}
+	}
+];
+//#endregion
+module.exports = recommendedTypeChecked;

package/dist/recommended-type-checked.d.cts

@@ -0,0 +1,5 @@
+import { ESLint } from "eslint";
+//#region src/recommended-type-checked.d.ts
+type ConfigValue = NonNullable<ESLint.Plugin['configs']>[string];
+declare const recommendedTypeChecked: ConfigValue;
+export = recommendedTypeChecked;

package/dist/recommended-type-checked.d.ts

@@ -0,0 +1,6 @@
+import { ESLint } from "eslint";
+//#region src/recommended-type-checked.d.ts
+type ConfigValue = NonNullable<ESLint.Plugin['configs']>[string];
+declare const recommendedTypeChecked: ConfigValue;
+//#endregion
+export { recommendedTypeChecked as default };

package/dist/recommended-type-checked.js

@@ -0,0 +1,20 @@
+import { t as plugin } from "./plugin-Cq16p_yl.js";
+import tseslint from "typescript-eslint";
+//#region src/recommended-type-checked.ts
+const recommendedTypeChecked = [
+	...tseslint.configs.recommendedTypeChecked,
+	...tseslint.configs.stylisticTypeChecked,
+	{
+		plugins: { exadev: plugin },
+		linterOptions: { noInlineConfig: true },
+		rules: {
+			"exadev/no-non-barrel-index": "error",
+			"exadev/no-non-barrel-reexport": "error",
+			"exadev/no-pointless-reassignment": "error",
+			"exadev/no-side-effects-in-index": "error",
+			"@typescript-eslint/consistent-type-assertions": ["error", { assertionStyle: "never" }]
+		}
+	}
+];
+//#endregion
+export { recommendedTypeChecked as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exadev/eslint-config",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Shared custom ESLint rules and plugin for ExaDev projects",
   "type": "module",
   "sideEffects": false,
@@ -46,7 +46,13 @@
     "url": "git+https://github.com/ExaDev/eslint-config.git"
   },
   "peerDependencies": {
-    "eslint": ">=10.0.0"
+    "eslint": ">=10.0.0",
+    "typescript-eslint": ">=8.0.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript-eslint": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.5",

package/dist/plugin-BBix8yMe.js

@@ -1,45 +0,0 @@
-import noNonBarrelIndex from "./rules/no-non-barrel-index.js";
-import noNonBarrelReexport from "./rules/no-non-barrel-reexport.js";
-import noPointlessReassignment from "./rules/no-pointless-reassignment.js";
-import noSideEffectsInIndex from "./rules/no-side-effects-in-index.js";
-//#endregion
-//#region src/plugin.ts
-const plugin = {
-	meta: {
-		name: "@exadev/eslint-config",
-		version: "1.1.1",
-		namespace: "exadev"
-	},
-	rules: {
-		"no-non-barrel-index": noNonBarrelIndex,
-		"no-non-barrel-reexport": noNonBarrelReexport,
-		"no-pointless-reassignment": noPointlessReassignment,
-		"no-side-effects-in-index": noSideEffectsInIndex
-	},
-	configs: {}
-};
-const { configs } = plugin;
-if (configs === void 0) throw new Error("Unreachable: configs was just initialized to {} in the object literal above.");
-Object.assign(configs, {
-	recommended: {
-		plugins: { exadev: plugin },
-		linterOptions: { noInlineConfig: true },
-		rules: {
-			"exadev/no-non-barrel-index": "error",
-			"exadev/no-non-barrel-reexport": "error",
-			"exadev/no-pointless-reassignment": "error",
-			"exadev/no-side-effects-in-index": "error",
-			"@typescript-eslint/consistent-type-assertions": ["error", { assertionStyle: "never" }]
-		}
-	},
-	barrel: {
-		plugins: { exadev: plugin },
-		rules: {
-			"exadev/no-non-barrel-index": "error",
-			"exadev/no-non-barrel-reexport": "error",
-			"exadev/no-side-effects-in-index": "error"
-		}
-	}
-});
-//#endregion
-export { plugin as t };

package/dist/plugin-jELHVCCw.cjs

@@ -1,46 +0,0 @@
-//#endregion
-//#region src/plugin.ts
-const plugin = {
-	meta: {
-		name: "@exadev/eslint-config",
-		version: "1.1.1",
-		namespace: "exadev"
-	},
-	rules: {
-		"no-non-barrel-index": require("./rules/no-non-barrel-index.cjs"),
-		"no-non-barrel-reexport": require("./rules/no-non-barrel-reexport.cjs"),
-		"no-pointless-reassignment": require("./rules/no-pointless-reassignment.cjs"),
-		"no-side-effects-in-index": require("./rules/no-side-effects-in-index.cjs")
-	},
-	configs: {}
-};
-const { configs } = plugin;
-if (configs === void 0) throw new Error("Unreachable: configs was just initialized to {} in the object literal above.");
-Object.assign(configs, {
-	recommended: {
-		plugins: { exadev: plugin },
-		linterOptions: { noInlineConfig: true },
-		rules: {
-			"exadev/no-non-barrel-index": "error",
-			"exadev/no-non-barrel-reexport": "error",
-			"exadev/no-pointless-reassignment": "error",
-			"exadev/no-side-effects-in-index": "error",
-			"@typescript-eslint/consistent-type-assertions": ["error", { assertionStyle: "never" }]
-		}
-	},
-	barrel: {
-		plugins: { exadev: plugin },
-		rules: {
-			"exadev/no-non-barrel-index": "error",
-			"exadev/no-non-barrel-reexport": "error",
-			"exadev/no-side-effects-in-index": "error"
-		}
-	}
-});
-//#endregion
-Object.defineProperty(exports, "plugin", {
-	enumerable: true,
-	get: function() {
-		return plugin;
-	}
-});