@theholocron/eslint-config 8.9.0-alpha.1 → 8.9.0-alpha.15

package/README.md

@@ -85,7 +85,7 @@ 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"] })];
+export default [...library({ browserPackages: ["utils/browser-utils/src"] })];
 ```
 
 Add project-specific configs after the bundle — they are merged in order:

package/dist/bundles/library.d.ts

@@ -1,12 +1,14 @@
 import { Linter } from "eslint";
+/** Options for the `library()` ESLint bundle. */
 export 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).
+   * turned off. Rare — most repos need nothing here (`utils/` in
+   * `theholocron/holocron` is the one place that does, for its
+   * browser-targeted packages).
    */
   browserPackages?: string[];
 }
@@ -27,9 +29,9 @@ export interface LibraryOptions {
  * `recommended-module` preset sets `n/no-extraneous-import: "error"` with no
  * `files` restriction, which otherwise clobbers `base()`'s earlier, more
  * specific `docs/src/**` exemption (flat config merges in array order, later
- * entries win per rule per matching file). Found live: `theholocron/clients`
- * still needed its own local override for this despite `base()` already
- * covering it in isolation.
+ * entries win per rule per matching file). Found live: the former
+ * `theholocron/clients` repo still needed its own local override for this
+ * despite `base()` already covering it in isolation.
  */
 export declare function library(options?: LibraryOptions): Linter.Config[];
 /**

package/dist/bundles/library.js

@@ -1,7 +1,7 @@
 import { base, docsSrcConfig } from "../configs/base.js";
+import { node } from "../configs/node.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";
 // bundles/library.ts
 /**
@@ -21,9 +21,9 @@ import { vitest as vitestConfig } from "../configs/vitest.js";
 * `recommended-module` preset sets `n/no-extraneous-import: "error"` with no
 * `files` restriction, which otherwise clobbers `base()`'s earlier, more
 * specific `docs/src/**` exemption (flat config merges in array order, later
-* entries win per rule per matching file). Found live: `theholocron/clients`
-* still needed its own local override for this despite `base()` already
-* covering it in isolation.
+* entries win per rule per matching file). Found live: the former
+* `theholocron/clients` repo still needed its own local override for this
+* despite `base()` already covering it in isolation.
 */
 function library(options = {}) {
 	return [

package/dist/bundles/next-app.d.ts

@@ -1,2 +1,6 @@
 import { Linter } from "eslint";
+/**
+ * The ESLint bundle for a Next.js application: the base, TypeScript, React, Storybook, Cypress, Next.js and Vitest
+ * rules, plus the `package.json` rules.
+ */
 export declare function nextApp(): Linter.FlatConfig[];

package/dist/bundles/next-app.js

@@ -1,12 +1,16 @@
 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 { packageJson } from "../configs/package-json.js";
 import { react as reactConfig } from "../configs/react.js";
 import { storybook as storybookConfig } from "../configs/storybook.js";
+import { typescript } from "../configs/typescript.js";
+import { vitest as vitestConfig } from "../configs/vitest.js";
 // bundles/next-app.ts
+/**
+* The ESLint bundle for a Next.js application: the base, TypeScript, React, Storybook, Cypress, Next.js and Vitest
+* rules, plus the `package.json` rules.
+*/
 function nextApp() {
 	return [
 		...base(),

package/dist/bundles/node-app.d.ts

@@ -1,2 +1,6 @@
 import { Linter } from "eslint";
+/**
+ * The ESLint bundle for a Node application: the base, Node, TypeScript and Vitest rules, plus the `package.json`
+ * rules.
+ */
 export declare function nodeApp(): Linter.Config[];

package/dist/bundles/node-app.js

@@ -1,9 +1,13 @@
 import { base, docsSrcConfig } from "../configs/base.js";
+import { node } from "../configs/node.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";
 // bundles/node-app.ts
+/**
+* The ESLint bundle for a Node application: the base, Node, TypeScript and Vitest rules, plus the `package.json`
+* rules.
+*/
 function nodeApp() {
 	return [
 		...base(),

package/dist/bundles/react-app.d.ts

@@ -1,2 +1,6 @@
 import { Linter } from "eslint";
+/**
+ * The ESLint bundle for a React application: the base, TypeScript, React, Storybook and Vitest rules, plus the
+ * `package.json` rules.
+ */
 export declare function reactApp(): Linter.Config[];

package/dist/bundles/react-app.js

@@ -1,10 +1,14 @@
 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 { typescript } from "../configs/typescript.js";
+import { vitest as vitestConfig } from "../configs/vitest.js";
 // bundles/react-app.ts
+/**
+* The ESLint bundle for a React application: the base, TypeScript, React, Storybook and Vitest rules, plus the
+* `package.json` rules.
+*/
 function reactApp() {
 	return [
 		...base(),

package/dist/configs/base.d.ts

@@ -8,4 +8,5 @@ import { Linter } from "eslint";
  * than opt into per repo.
  */
 export declare const docsSrcConfig: Linter.Config;
+/** The base ESLint flat config: the repo's `.gitignore` as ignores, browser and Node globals, `@eslint/js` recommended rules, import and export sorting, and a relaxed `n/no-extraneous-import` for `docs/src`. */
 export declare function base(): Linter.Config[];

package/dist/configs/base.js

@@ -51,6 +51,7 @@ const docsSrcConfig = {
 	files: ["docs/src/**"],
 	rules: { "n/no-extraneous-import": "off" }
 };
+/** The base ESLint flat config: the repo's `.gitignore` as ignores, browser and Node globals, `@eslint/js` recommended rules, import and export sorting, and a relaxed `n/no-extraneous-import` for `docs/src`. */
 function base() {
 	const gitignore = gitignoreConfig();
 	return [

package/dist/configs/cypress.d.ts

@@ -1,3 +1,4 @@
 import { Linter } from "eslint";
+/** ESLint rules for Cypress tests (`cypress/**`). */
 export declare function cypressConfig(): Linter.FlatConfig[];
 export { cypressConfig as cypress };

package/dist/configs/cypress.js

@@ -1,5 +1,6 @@
 import cypress from "eslint-plugin-cypress";
 // configs/cypress.ts
+/** ESLint rules for Cypress tests (`cypress/**`). */
 function cypressConfig() {
 	return [{
 		name: "@theholocron/cypress",

package/dist/configs/jsdoc.d.ts

@@ -1,3 +1,4 @@
 import { Linter } from "eslint";
+/** ESLint rules for JSDoc comments: the plugin's recommended TypeScript set, plus this repo's own rules. */
 export declare function jsdocConfig(): Linter.Config[];
 export { jsdocConfig as jsdoc };

package/dist/configs/jsdoc.js

@@ -1,5 +1,6 @@
 import jsdoc from "eslint-plugin-jsdoc";
 // configs/jsdoc.ts
+/** ESLint rules for JSDoc comments: the plugin's recommended TypeScript set, plus this repo's own rules. */
 function jsdocConfig() {
 	return [{
 		...jsdoc.configs["flat/recommended-typescript"],

package/dist/configs/next.d.ts

@@ -1,3 +1,4 @@
 import { Linter } from "eslint";
+/** ESLint rules for a Next.js app: the plugin's recommended and Core Web Vitals sets. */
 export declare function nextConfig(): Linter.FlatConfig[];
 export { nextConfig as next };

package/dist/configs/next.js

@@ -1,5 +1,6 @@
 import next from "@next/eslint-plugin-next";
 // configs/next.ts
+/** ESLint rules for a Next.js app: the plugin's recommended and Core Web Vitals sets. */
 function nextConfig() {
 	return [{
 		name: "@theholocron/next",

package/dist/configs/node.d.ts

@@ -1,2 +1,6 @@
 import { Linter } from "eslint";
+/**
+ * ESLint rules for Node code: the `n` plugin's recommended ES module set, with the checks TypeScript already makes
+ * turned off.
+ */
 export declare function node(): Linter.FlatConfig[];

package/dist/configs/node.js

@@ -1,5 +1,9 @@
 import n from "eslint-plugin-n";
 // configs/node.ts
+/**
+* ESLint rules for Node code: the `n` plugin's recommended ES module set, with the checks TypeScript already makes
+* turned off.
+*/
 function node() {
 	return [n.configs["flat/recommended-module"], {
 		name: "@theholocron/node",

package/dist/configs/package-json.d.ts

@@ -1,2 +1,3 @@
 import { Linter } from "eslint";
+/** ESLint flat config for `package.json` files: the `eslint-package-json` recommended rules, with the rules that misfire on pnpm catalogs and workspaces turned off. */
 export declare function packageJson(): Linter.Config[];

package/dist/configs/package-json.js

@@ -1,5 +1,6 @@
 import eslintPackageJson from "eslint-package-json";
 // configs/package-json.ts
+/** ESLint flat config for `package.json` files: the `eslint-package-json` recommended rules, with the rules that misfire on pnpm catalogs and workspaces turned off. */
 function packageJson() {
 	return [{
 		name: "@theholocron/package-json",

package/dist/configs/react.d.ts

@@ -1,3 +1,4 @@
 import { Linter } from "eslint";
+/** ESLint rules for React: the recommended and JSX-runtime sets, applied to every script file. */
 export declare function reactConfig(): Linter.FlatConfig[];
 export { reactConfig as react };

package/dist/configs/react.js

@@ -1,6 +1,7 @@
 import { fixupConfigRules } from "@eslint/compat";
 import react from "eslint-plugin-react";
 // configs/react.ts
+/** ESLint rules for React: the recommended and JSX-runtime sets, applied to every script file. */
 function reactConfig() {
 	return fixupConfigRules([react.configs.flat.recommended, react.configs.flat["jsx-runtime"]]).map((config) => ({
 		...config,

package/dist/configs/storybook.d.ts

@@ -1,3 +1,7 @@
 import { Linter } from "eslint";
+/**
+ * ESLint rules for Storybook: the plugin's recommended set, with this repo's overrides for `.storybook/` and
+ * stories.
+ */
 export declare function storybookConfig(): Linter.FlatConfig[];
 export { storybookConfig as storybook };

package/dist/configs/storybook.js

@@ -1,5 +1,9 @@
 import storybook from "eslint-plugin-storybook";
 // configs/storybook.ts
+/**
+* ESLint rules for Storybook: the plugin's recommended set, with this repo's overrides for `.storybook/` and
+* stories.
+*/
 function storybookConfig() {
 	return [...storybook.configs["flat/recommended"], {
 		name: "@theholocron/storybook-overrides",

package/dist/configs/typescript.d.ts

@@ -1,2 +1,3 @@
 import { Linter } from "eslint";
+/** ESLint flat config for TypeScript: the `typescript-eslint` recommended rules, with `no-unused-vars` ignoring names that start with an underscore. */
 export declare function typescript(): Linter.Config[];

package/dist/configs/typescript.js

@@ -1,5 +1,6 @@
 import tseslint from "typescript-eslint";
 // configs/typescript.ts
+/** ESLint flat config for TypeScript: the `typescript-eslint` recommended rules, with `no-unused-vars` ignoring names that start with an underscore. */
 function typescript() {
 	return [...tseslint.configs.recommended, {
 		name: "@theholocron/typescript",

package/dist/configs/vitest.d.ts

@@ -1,3 +1,4 @@
 import { Linter } from "eslint";
+/** ESLint rules for Vitest test and setup files. */
 export declare function vitestConfig(): Linter.Config[];
 export { vitestConfig as vitest };

package/dist/configs/vitest.js

@@ -1,5 +1,6 @@
 import vitest from "@vitest/eslint-plugin";
 // configs/vitest.ts
+/** ESLint rules for Vitest test and setup files. */
 function vitestConfig() {
 	return [{
 		name: "@theholocron/vitest",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/eslint-config",
-  "version": "8.9.0-alpha.1",
+  "version": "8.9.0-alpha.15",
   "description": "A ESLint configuration for writing well-formed Javascript within the Galaxy.",
   "keywords": [
     "eslint",
@@ -105,22 +105,22 @@
     "dist/"
   ],
   "dependencies": {
-    "@eslint/compat": "^2.1.0",
-    "eslint-package-json": "^0.3.0"
+    "@eslint/compat": "^2.1.1",
+    "eslint-package-json": "^3.0.0"
   },
   "devDependencies": {
     "@eslint/js": "^10.0.0",
-    "@vitest/coverage-v8": "^5.0.5",
-    "@vitest/eslint-plugin": "^1.6.23",
-    "eslint-plugin-n": "^18.3.0",
+    "@vitest/coverage-v8": "^5.1.0",
+    "@vitest/eslint-plugin": "^1.6.28",
+    "eslint-plugin-n": "^18.5.0",
     "eslint-plugin-simple-import-sort": "^14.0.0",
-    "globals": "^17.11.0",
-    "tsdown": "^0.23.3",
+    "globals": "^17.14.0",
+    "tsdown": "^0.23.5",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.67.0",
-    "vitest": "^5.0.5",
-    "@theholocron/tsconfig": "8.9.0-alpha.1",
-    "@theholocron/vitest-config": "8.9.0-alpha.1"
+    "typescript-eslint": "^8.72.1",
+    "vitest": "^5.1.0",
+    "@theholocron/tsconfig": "8.9.0-alpha.15",
+    "@theholocron/vitest-config": "8.9.0-alpha.15"
   },
   "peerDependencies": {
     "@eslint/js": "^10",
@@ -160,10 +160,10 @@
     "access": "public"
   },
   "scripts": {
-    "delivery.build": "tsdown",
-    "sourceQuality.staticAnalysis": "eslint .",
+    "build": "tsdown",
+    "lint:code": "eslint .",
+    "test:unit": "vitest run --coverage",
     "test:watch": "vitest",
-    "verification.typeSafety": "tsc --noEmit",
-    "verification.unitTests": "vitest run"
+    "typecheck": "tsc --noEmit"
   }
 }