exadev-eslint-config 1.2.0 → 1.2.2

package/README.md

@@ -52,6 +52,25 @@ export default defineConfig([
 ]);
 ```
 
+`typescript-eslint`'s own `tseslint.config()` helper (rather than ESLint's `defineConfig()`) does **not** accept the string form of `extends` at all -- it throws `has an 'extends' array that contains a string ... This is a feature of eslint's defineConfig() helper and is not supported by typescript-eslint`. A `tseslint.config()`-based project passes the config value directly instead:
+
+```ts
+import exadev from '@exadev/eslint-config';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  // ...your own config...
+  {
+    files: ['**/*.ts'],
+    plugins: { exadev },
+    extends: [exadev.configs.recommended], // or exadev.configs.barrel
+  },
+);
+```
+
+**`recommended`/`barrel` carry no `files`/`ignores` of their own, and applying either unscoped will misfire.** `no-side-effects-in-index` flags any top-level statement that isn't a bare re-export -- applied to an ordinary file with real `export function`/`export const`/`export interface` declarations, every one of them trips it (confirmed directly: 88 false-positive errors on a single real source file in a repo that tried this). Scope the `extends` block itself to just `src/index.ts` if you want `no-side-effects-in-index`'s coverage from `recommended`/`barrel`, or -- what every current consumer of this plugin actually does -- skip `recommended`/`barrel` and wire the four `exadev/*` rules individually, each with your own project's real `files`/`ignores`, exactly as shown in the first example above. That's not a workaround; it's the intended shape once a project's re-export-ban exceptions and barrel location are genuinely project-specific.
+```
+
 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`
@@ -95,14 +114,17 @@ This lives in its own module, separate from the main `@exadev/eslint-config` ent
 pnpm install    # requires Node >=20 and pnpm 11.6.0 (pinned via packageManager)
 pnpm lint
 pnpm typecheck
+pnpm test
 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.
+Each rule has a co-located `*.test.ts` file (`src/rules/no-non-barrel-index.test.ts` etc.) exercising it with ESLint's own `RuleTester`, run under Vitest. `vitest.setup.ts` wires `RuleTester.describe`/`RuleTester.it`/`RuleTester.itOnly` to Vitest's own `describe`/`it` explicitly, rather than turning on Vitest's `test.globals` project-wide, since `RuleTester.run()` only calls `describe`/`it` if something has supplied them. Each test file constructs its own `RuleTester` with `languageOptions.parser` set to `typescript-eslint`'s parser, since these rules' realistic test fixtures use TypeScript-only syntax (e.g. `export type { X } from './y'`) that the default `espree` parser can't read; none of the four rules need type information, so no `project`/`tsconfigRootDir` is configured.
+
+`pnpm test` always measures coverage (`coverage.enabled: true` in `vitest.config.ts`, via `@vitest/coverage-v8`) rather than needing a separate `--coverage` flag -- scoped to `src/**/*.ts` excluding the `*.test.ts` files themselves. The text reporter summarises in the terminal; the `html`/`lcov` reporters land in `coverage/`, already gitignored alongside `.eslintcache` and `dist/`.
 
-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.
+The `lint`/`typecheck`/`test`/`build` npm scripts are thin wrappers around turbo tasks whose own names carry a leading underscore (`_lint`/`_typecheck`/`_test`/`_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.
+`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, `test`, `tsdown`, `publint`, and `attw --pack`, so a broken export shape fails at publish time even outside the main CI pipeline.
 
 ## Architecture
 
@@ -123,12 +145,12 @@ Conventional commits are enforced by commitlint, restricted to the type-enum def
 ## 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.
+- Husky hooks: `pre-commit` runs lint-staged (`eslint --fix` on staged `*.ts`), `commit-msg` runs commitlint against the message, `pre-push` runs `typecheck`, `test`, and `build` -- pushing here re-runs the whole test suite and rebuilds the 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.
+Conventional commits are enforced by commitlint via a husky `commit-msg` hook, and re-checked in CI. CI runs commitlint, lint, and typecheck+test+build+attw on every push and pull request; the release job only runs on a push to `main`, after all three pass.
 
 ## Release
 

package/dist/index.cjs

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

package/dist/index.js

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

package/dist/{plugin-Dixk0WAc.cjs → plugin-DZKXx2me.cjs}

@@ -3,7 +3,7 @@
 const plugin = {
 	meta: {
 		name: "@exadev/eslint-config",
-		version: "1.2.0",
+		version: "1.2.2",
 		namespace: "exadev"
 	},
 	rules: {

package/dist/{plugin-Cq16p_yl.js → plugin-PQMeiTvg.js}

@@ -7,7 +7,7 @@ import noSideEffectsInIndex from "./rules/no-side-effects-in-index.js";
 const plugin = {
 	meta: {
 		name: "@exadev/eslint-config",
-		version: "1.2.0",
+		version: "1.2.2",
 		namespace: "exadev"
 	},
 	rules: {

package/dist/plugin.cjs

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

package/dist/plugin.js

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

package/dist/recommended-type-checked.cjs

@@ -20,7 +20,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 	enumerable: true
 }) : target, mod));
 //#endregion
-const require_plugin = require("./plugin-Dixk0WAc.cjs");
+const require_plugin = require("./plugin-DZKXx2me.cjs");
 let typescript_eslint = require("typescript-eslint");
 typescript_eslint = __toESM(typescript_eslint, 1);
 //#region src/recommended-type-checked.ts

package/dist/recommended-type-checked.js

@@ -1,4 +1,4 @@
-import { t as plugin } from "./plugin-Cq16p_yl.js";
+import { t as plugin } from "./plugin-PQMeiTvg.js";
 import tseslint from "typescript-eslint";
 //#region src/recommended-type-checked.ts
 const recommendedTypeChecked = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "exadev-eslint-config",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Shared custom ESLint rules and plugin for ExaDev projects",
   "type": "module",
   "sideEffects": false,
@@ -61,6 +61,7 @@
     "@semantic-release/changelog": "^7.0.0",
     "@semantic-release/git": "^11.0.1",
     "@types/node": "^24.9.2",
+    "@vitest/coverage-v8": "^4.1.10",
     "eslint": "^10.8.0",
     "husky": "^9.1.7",
     "lint-staged": "^17.2.0",
@@ -69,7 +70,8 @@
     "tsdown": "^0.22.13",
     "turbo": "^2.10.8",
     "typescript": "^6.0.3",
-    "typescript-eslint": "^8.65.0"
+    "typescript-eslint": "^8.65.0",
+    "vitest": "^4.1.10"
   },
   "scripts": {
     "build": "turbo run _build",
@@ -78,6 +80,8 @@
     "_lint": "eslint . --fix --cache --max-warnings 0",
     "typecheck": "turbo run _typecheck",
     "_typecheck": "tsc -p tsconfig.json",
+    "test": "turbo run _test",
+    "_test": "vitest run",
     "release": "semantic-release"
   }
 }