@theholocron/eslint-config 8.2.3 → 8.4.2

package/README.md

@@ -82,6 +82,10 @@ export default [...nodeApp()];
 // Publishable library (base + typescript + vitest)
 import { library } from "@theholocron/eslint-config/bundles/library";
 export default [...library()];
+
+// With browser-targeted packages (turns off a Node-builtins rule that
+// false-positives on navigator/sessionStorage/KeyboardEvent/…):
+export default [...library({ browserPackages: ["packages/browser-utils/src"] })];
 ```
 
 Add project-specific configs after the bundle — they are merged in order:

package/dist/bundles/library.d.ts

@@ -1,4 +1,47 @@
+import { Linter } from "eslint";
 //#region bundles/library.d.ts
-declare function library(): import("typescript-eslint").CompatibleConfig[];
+interface LibraryOptions {
+  /**
+   * Package (or path) globs whose code runs in the browser, not Node —
+   * `n/no-unsupported-features/node-builtins` false-positives on browser
+   * APIs (`navigator`, `sessionStorage`, `KeyboardEvent`, …) it doesn't
+   * recognize. Each entry gets a `<glob>/**` files match with the rule
+   * turned off. Rare — most repos need nothing here (`theholocron/utils`
+   * is the one org repo that does, for its browser-targeted packages).
+   */
+  browserPackages?: string[];
+}
+/**
+ * Every 5-of-6 org repos' `eslint.config.ts` already reduces to `...library()`
+ * with no further composition once `base()`'s gitignore/docs-src absorption
+ * (#460) is in place — the sixth (`holocron` itself) only differs by also
+ * spreading `vitest()` at its root, which is safe to bake in unconditionally
+ * here: {@link vitest}'s config is glob-scoped to test/setup files, so it's a
+ * no-op anywhere it doesn't match, same reasoning as `docsSrcConfig`. Once
+ * every repo drops its now-redundant local composition (#680, the migration
+ * pass), `library()` alone — resolved via `eslint --config`, zero committed
+ * file — covers every repo but the `browserPackages` outlier, which keeps a
+ * tiny `export default library({ browserPackages: [...] })` (config-resolution
+ * workstream, #676 in theholocron/holocron).
+ */
+declare function library(options?: LibraryOptions): Linter.Config[];
+/**
+ * Ready-to-use config for packages that need no customisation — matches
+ * `@theholocron/vitest-config`'s and `@theholocron/tsdown-config`'s existing
+ * `export default <preset>()` pattern. `eslint --config <path>` loads a
+ * file's *default* export as the flat config directly; a named-export-only
+ * file throws `ConfigError: Unexpected key "library" found` (ESLint treats
+ * the whole module namespace as the config when there's no default) —
+ * required for the resolver (config-resolution workstream, #676 in
+ * theholocron/holocron) to point `--config` straight at this file with zero
+ * committed local content.
+ *
+ * The explicit `Linter.Config[]` binding (rather than `export default
+ * library();` directly) works around TS2742 — declaration-emit can't
+ * portably name library()'s inferred return type without a reference to
+ * @eslint/core's internal types; an explicitly-typed intermediate avoids
+ * needing to re-infer it.
+ */
+declare const resolvedLibrary: Linter.Config[];
 //#endregion
-export { library };
+export { LibraryOptions, resolvedLibrary as default, library };

package/dist/bundles/library.js

@@ -2,21 +2,59 @@ import { base } from "../configs/base.js";
 import { packageJson } from "../configs/package-json.js";
 import { typescript } from "../configs/typescript.js";
 import { node } from "../configs/node.js";
+import { vitest as vitestConfig } from "../configs/vitest.js";
 //#region bundles/library.ts
-function library() {
+/**
+* Every 5-of-6 org repos' `eslint.config.ts` already reduces to `...library()`
+* with no further composition once `base()`'s gitignore/docs-src absorption
+* (#460) is in place — the sixth (`holocron` itself) only differs by also
+* spreading `vitest()` at its root, which is safe to bake in unconditionally
+* here: {@link vitest}'s config is glob-scoped to test/setup files, so it's a
+* no-op anywhere it doesn't match, same reasoning as `docsSrcConfig`. Once
+* every repo drops its now-redundant local composition (#680, the migration
+* pass), `library()` alone — resolved via `eslint --config`, zero committed
+* file — covers every repo but the `browserPackages` outlier, which keeps a
+* tiny `export default library({ browserPackages: [...] })` (config-resolution
+* workstream, #676 in theholocron/holocron).
+*/
+function library(options = {}) {
 	return [
 		...base(),
 		...node(),
 		...typescript(),
 		...packageJson(),
+		...vitestConfig(),
 		{
 			name: "@theholocron/library",
 			rules: {
 				"n/hashbang": "off",
 				"n/no-unpublished-import": "off"
 			}
-		}
+		},
+		...options.browserPackages?.length ? [{
+			name: "@theholocron/library/browser-packages",
+			files: options.browserPackages.map((pkg) => `${pkg}/**`),
+			rules: { "n/no-unsupported-features/node-builtins": "off" }
+		}] : []
 	];
 }
+/**
+* Ready-to-use config for packages that need no customisation — matches
+* `@theholocron/vitest-config`'s and `@theholocron/tsdown-config`'s existing
+* `export default <preset>()` pattern. `eslint --config <path>` loads a
+* file's *default* export as the flat config directly; a named-export-only
+* file throws `ConfigError: Unexpected key "library" found` (ESLint treats
+* the whole module namespace as the config when there's no default) —
+* required for the resolver (config-resolution workstream, #676 in
+* theholocron/holocron) to point `--config` straight at this file with zero
+* committed local content.
+*
+* The explicit `Linter.Config[]` binding (rather than `export default
+* library();` directly) works around TS2742 — declaration-emit can't
+* portably name library()'s inferred return type without a reference to
+* @eslint/core's internal types; an explicitly-typed intermediate avoids
+* needing to re-infer it.
+*/
+const resolvedLibrary = library();
 //#endregion
-export { library };
+export { resolvedLibrary as default, library };

package/dist/bundles/next-app.js

@@ -1,11 +1,11 @@
 import { base } from "../configs/base.js";
 import { packageJson } from "../configs/package-json.js";
 import { typescript } from "../configs/typescript.js";
+import { vitest as vitestConfig } from "../configs/vitest.js";
 import { cypress as cypressConfig } from "../configs/cypress.js";
 import { next as nextConfig } from "../configs/next.js";
 import { react as reactConfig } from "../configs/react.js";
 import { storybook as storybookConfig } from "../configs/storybook.js";
-import { vitest as vitestConfig } from "../configs/vitest.js";
 //#region bundles/next-app.ts
 function nextApp() {
 	return [

package/dist/bundles/react-app.js

@@ -1,9 +1,9 @@
 import { base } from "../configs/base.js";
 import { packageJson } from "../configs/package-json.js";
 import { typescript } from "../configs/typescript.js";
+import { vitest as vitestConfig } from "../configs/vitest.js";
 import { react as reactConfig } from "../configs/react.js";
 import { storybook as storybookConfig } from "../configs/storybook.js";
-import { vitest as vitestConfig } from "../configs/vitest.js";
 //#region bundles/react-app.ts
 function reactApp() {
 	return [

package/dist/configs/base.js

@@ -1,9 +1,43 @@
+import { existsSync } from "node:fs";
+import { join } from "node:path";
+import { includeIgnoreFile } from "@eslint/compat";
 import js from "@eslint/js";
 import globals from "globals";
 import simpleImportSort from "eslint-plugin-simple-import-sort";
 //#region configs/base.ts
+/**
+* Ignore whatever the consuming repo's own .gitignore already ignores
+* (dist/, coverage/, node_modules/, …) instead of every repo hand-maintaining
+* its own `ignores:` array in eslint.config.ts. Resolved against
+* process.cwd() — the repo root ESLint is actually invoked from, whether
+* that's a committed eslint.config.ts re-exporting this bundle or a future
+* `eslint --config <shared path>` invocation with no local file at all
+* (config-resolution workstream, #676 in theholocron/holocron). A repo
+* without a .gitignore (unusual, but not invalid) just gets no extra
+* ignores from this — never throws.
+*/
+function gitignoreConfig() {
+	const gitignorePath = join(process.cwd(), ".gitignore");
+	if (!existsSync(gitignorePath)) return void 0;
+	return includeIgnoreFile(gitignorePath, "@theholocron/gitignore");
+}
+/**
+* docs/src imports resolve against the repo ROOT package.json (docs sites
+* in this org are never their own workspace package — see clients/themes/
+* utils/observability), so n/no-extraneous-import flags every import in
+* that directory as a false positive. Scoped to a glob that simply matches
+* nothing in a repo without a docs/src — safe to always include rather
+* than opt into per repo.
+*/
+const docsSrcConfig = {
+	name: "@theholocron/docs-src",
+	files: ["docs/src/**"],
+	rules: { "n/no-extraneous-import": "off" }
+};
 function base() {
+	const gitignore = gitignoreConfig();
 	return [
+		...gitignore ? [gitignore] : [],
 		{
 			name: "@theholocron/base",
 			languageOptions: { globals: {
@@ -19,7 +53,8 @@ function base() {
 				"simple-import-sort/imports": "error",
 				"simple-import-sort/exports": "error"
 			}
-		}
+		},
+		docsSrcConfig
 	];
 }
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/eslint-config",
-  "version": "8.2.3",
+  "version": "8.4.2",
   "description": "A ESLint configuration for writing well-formed Javascript within the Galaxy.",
   "homepage": "https://github.com/theholocron/configs/tree/main/packages/eslint-config#readme",
   "bugs": "https://github.com/theholocron/configs/issues",
@@ -27,6 +27,7 @@
   },
   "devDependencies": {
     "@eslint/js": "^10.0.0",
+    "@theholocron/cli": "5.0.0-alpha.3",
     "@vitest/coverage-v8": "^4.1.10",
     "eslint-plugin-simple-import-sort": "^14.0.0",
     "globals": "^17.11.0",
@@ -34,8 +35,8 @@
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.67.0",
     "vitest": "^4.1.10",
-    "@theholocron/tsconfig": "8.2.3",
-    "@theholocron/vitest-config": "8.2.3"
+    "@theholocron/tsconfig": "8.4.2",
+    "@theholocron/vitest-config": "8.4.2"
   },
   "exports": {
     ".": {
@@ -164,9 +165,10 @@
   "releases": "https://github.com/theholocron/configs/releases",
   "wiki": "https://github.com/theholocron/configs/wiki",
   "scripts": {
-    "build": "tsdown",
-    "typecheck": "tsc --noEmit",
-    "test": "vitest run",
-    "test:coverage": "vitest run --coverage"
+    "delivery.build": "tsdown",
+    "sourceQuality.staticAnalysis": "holocron run sourceQuality.staticAnalysis --",
+    "test:watch": "vitest",
+    "verification.typeSafety": "holocron run verification.typeSafety --",
+    "verification.unitTests": "holocron run verification.unitTests --"
   }
 }