eslint-config-nick2bad4u 1.2.7 → 1.2.9

package/README.md

@@ -3,20 +3,20 @@
 [![npm license.](https://flat.badgen.net/npm/license/eslint-config-nick2bad4u?color=purple)](https://github.com/Nick2bad4u/eslint-config-nick2bad4u/blob/main/LICENSE) [![npm total downloads.](https://flat.badgen.net/npm/dt/eslint-config-nick2bad4u?color=pink)](https://www.npmjs.com/package/eslint-config-nick2bad4u) [![latest GitHub release.](https://flat.badgen.net/github/release/Nick2bad4u/eslint-config-nick2bad4u?color=cyan)](https://github.com/Nick2bad4u/eslint-config-nick2bad4u/releases) [![GitHub stars.](https://flat.badgen.net/github/stars/Nick2bad4u/eslint-config-nick2bad4u?color=yellow)](https://github.com/Nick2bad4u/eslint-config-nick2bad4u/stargazers) [![GitHub forks.](https://flat.badgen.net/github/forks/Nick2bad4u/eslint-config-nick2bad4u?color=green)](https://github.com/Nick2bad4u/eslint-config-nick2bad4u/forks) [![GitHub open issues.](https://flat.badgen.net/github/open-issues/Nick2bad4u/eslint-config-nick2bad4u?color=red)](https://github.com/Nick2bad4u/eslint-config-nick2bad4u/issues) [![codecov.](https://codecov.io/gh/Nick2bad4u/eslint-config-nick2bad4u/branch/main/graph/badge.svg)](https://codecov.io/gh/Nick2bad4u/eslint-config-nick2bad4u)
 
 Shared ESM-only [ESLint flat config](https://eslint.org/docs/latest/use/configure/configuration-files)
-for Nick2bad4u ESLint plugin projects.
+for Nick2bad4u TypeScript/JavaScript repositories.
 
 This package centralizes the lint stack used across those repositories: TypeScript-aware
-ESLint configuration, Markdown/JSON/YAML/CSS-adjacent linting, package checks,
-prose checks, and project-specific plugin presets. Consumers bring `eslint` and
-`typescript` as peer dependencies; this package brings the ESLint plugins and
-parsers that the shared config enables.
+ESLint configuration, Markdown/JSON/YAML/TOML/CSS-adjacent linting, package
+checks, prose checks, and project-specific plugin presets. Consumers bring
+`eslint` and `typescript` as peer dependencies; this package brings the ESLint
+plugins and parsers that the shared config enables.
 
 ## Requirements
 
 | Tool       | Supported range      | Why it is required                                              |
 | ---------- | -------------------- | --------------------------------------------------------------- |
 | Node.js    | `>=22.0.0`           | Runtime for ESLint, the config package, and repository scripts. |
-| ESLint     | `^10.4.0`            | Peer dependency supplied by each consuming project.             |
+| ESLint     | `^10.4.1`            | Peer dependency supplied by each consuming project.             |
 | TypeScript | `^5.0.0 \|\| ^6.0.3` | Peer dependency used by TypeScript-aware lint rules.            |
 
 Repository development also expects npm `>=11.0.0`; consumers can use the package
@@ -85,31 +85,29 @@ Long-form project documentation lives in [`docs/`](./docs/index.md).
 
 ## `createConfig()`
 
-Use `createConfig()` when a project needs to customize root resolution,
-TypeScript project files, or plugin replacement/disabling while keeping the
-shared defaults:
+Use `createConfig()` when a project needs to customize root resolution, import
+resolver project paths, or plugin replacement/disabling while keeping the shared
+defaults:
 
 ```js
-import { createConfig } from "eslint-config-nick2bad4u";
+import {
+ allowDefaultProjectFilePatternPresets,
+ createConfig,
+} from "eslint-config-nick2bad4u";
 
 export default createConfig({
- allowDefaultProjectFilePatterns: [
-  "*.config.{js,mjs,cjs,ts,mts,cts}",
-  "*.config.*.{js,mjs,cjs,ts,mts,cts}",
-  ".*rc.{js,mjs,cjs,ts,mts,cts}",
-  "preset.mjs",
- ],
+ allowDefaultProjectFilePatterns:
+  allowDefaultProjectFilePatternPresets.rootScriptFiles,
  rootDirectory: import.meta.dirname,
- tsconfigPaths: ["./tsconfig.eslint.json"],
 });
 ```
 
-| Option                            | Type                                | Default                      | Use it when                                                                                                              |
-| --------------------------------- | ----------------------------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
-| `allowDefaultProjectFilePatterns` | `readonly string[]`                 | `["*.mjs", ".*.mjs"]`        | Root config files are intentionally outside `tsconfigPaths`; do not include files already covered by your lint tsconfig. |
-| `rootDirectory`                   | `string`                            | `process.cwd()`              | ESLint runs outside the project root or a monorepo package needs its own root.                                           |
-| `tsconfigPaths`                   | `readonly string[]`                 | `["./tsconfig.eslint.json"]` | The project uses a differently named lint tsconfig or a truly separate TypeScript project.                               |
-| `plugins`                         | `Readonly<Record<string, unknown>>` | `{}`                         | You need to dogfood a local plugin build or disable packaged plugin rules by namespace.                                  |
+| Option                            | Type                                | Default                      | Use it when                                                                                                          |
+| --------------------------------- | ----------------------------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| `allowDefaultProjectFilePatterns` | `readonly string[]`                 | Root JS/CJS/MJS globs        | Root config files are intentionally outside the nearest `tsconfig.json`; keep this list tiny and avoid broad globs.  |
+| `rootDirectory`                   | `string`                            | `process.cwd()`              | ESLint runs outside the project root or a monorepo package needs its own root.                                       |
+| `tsconfigPaths`                   | `readonly string[]`                 | `["./tsconfig.eslint.json"]` | Import resolver project paths; this does not replace TypeScript parser project-service discovery of `tsconfig.json`. |
+| `plugins`                         | `Readonly<Record<string, unknown>>` | `{}`                         | You need to dogfood a local plugin build or disable packaged plugin rules by namespace.                              |
 
 An example copy-paste config is available at
 [`examples/eslint.config.create.mjs`](./examples/eslint.config.create.mjs).
@@ -151,14 +149,14 @@ needs to provide a local build of that plugin for dogfooding.
 
 ## TypeScript project setup
 
-The default TypeScript-aware configuration resolves from `process.cwd()` and
-expects `./tsconfig.eslint.json`. That project should include every file ESLint
-can lint: source, tests, scripts, dotfiles, examples, and docs tooling.
+The TypeScript parser uses `projectService`, so typed linting follows
+TypeScript's normal nearest-`tsconfig.json` lookup from `rootDirectory` or
+`process.cwd()`. That `tsconfig.json` should include every TypeScript-aware file
+ESLint can lint: source, tests, scripts, dotfiles, examples, and docs tooling.
 
 ```json
 {
  "$schema": "https://www.schemastore.org/tsconfig.json",
- "extends": "./tsconfig.json",
  "compilerOptions": {
   "allowJs": true,
   "checkJs": true,
@@ -169,9 +167,37 @@ can lint: source, tests, scripts, dotfiles, examples, and docs tooling.
 }
 ```
 
-One catch-all lint tsconfig is easier to maintain than multiple narrow projects.
+If a repository keeps a separate `tsconfig.eslint.json`, that file can still be
+useful for `tsconfigPaths` and import resolution, but it does not make the
+parser project service pick that file instead of `tsconfig.json`. Put
+lint-visible files in a nearest `tsconfig.json`, or opt a small number of root
+files into `allowDefaultProjectFilePatterns`. The shared default already covers
+root-only `js`, `mjs`, and `cjs` files, including dotfiles.
+
+Override the default when a project wants a different root-only fallback:
+
+```js
+import {
+ allowDefaultProjectFilePatternPresets,
+ createConfig,
+} from "eslint-config-nick2bad4u";
+
+export default createConfig({
+ allowDefaultProjectFilePatterns:
+  allowDefaultProjectFilePatternPresets.rootConfigFiles,
+ rootDirectory: import.meta.dirname,
+});
+```
+
+`allowDefaultProjectFilePatternPresets.defaultRootFiles` matches the packaged
+default. `rootScriptFiles` adds `ts`, `mts`, and `cts` for projects that know
+those root files are outside `tsconfig.json`; `rootConfigFiles` and
+`rootMjsFiles` are also available for narrower projects.
+
 The `"**/.*"` include matters because dotfiles such as `.secretlintrc.cjs` are
-not matched by extension globs like `**/*.cjs`.
+not matched by extension globs like `**/*.cjs`. Do not use broad
+`allowDefaultProjectFilePatterns` as a replacement for a correct `tsconfig.json`;
+each default-project match has parser-service overhead.
 
 Set `ESLINT_CONFIG_ROOT` only when you need to drive the root directory from the
 environment instead of passing `rootDirectory` to `createConfig()`.
@@ -227,14 +253,17 @@ Use the aggregate scripts before opening a pull request or publishing:
 
 ```sh
 npm run lint:all
+npm run lint:actions
 npm run release:verify
 ```
 
 `lint:all` builds the runtime, runs ESLint, typechecks, runs Vitest, checks
 Prettier formatting, validates package metadata and published package shape,
-lints YAML, and runs Secretlint. `release:verify` adds the stricter no-cache lint
-path, package checks with `publint` and ATTW, and sync checks for peer ranges and
-Node version files.
+runs Gitleaks, and runs Secretlint. ESLint covers YAML through the shared config;
+use `lint:yaml` or `lint:yamllint` when you need a targeted YAML-only pass.
+`lint:actions` runs `actionlint` against GitHub workflows. `release:verify` uses
+the stricter no-cache lint path, repeats strict package checks with `publint` and
+ATTW, and syncs peer ranges and Node version files.
 
 Release notes are generated with `git-cliff` through the `changelog:*` scripts.
 For contribution and maintenance workflows, see the

package/dist/preset.js

@@ -1,4 +1,19 @@
-import { createConfig as createSharedConfig, configs as sharedConfigs, } from "./shared-config.js";
+import { createConfig as createSharedConfig, allowDefaultProjectFilePatternPresets as sharedAllowDefaultProjectFilePatternPresets, configs as sharedConfigs, } from "./shared-config.js";
+/** Opt-in file-pattern presets for TypeScript ESLint's default-project fallback. */
+export const allowDefaultProjectFilePatternPresets = Object.freeze({
+    defaultRootFiles: [
+        ...sharedAllowDefaultProjectFilePatternPresets.defaultRootFiles,
+    ],
+    rootConfigFiles: [
+        ...sharedAllowDefaultProjectFilePatternPresets.rootConfigFiles,
+    ],
+    rootMjsFiles: [
+        ...sharedAllowDefaultProjectFilePatternPresets.rootMjsFiles,
+    ],
+    rootScriptFiles: [
+        ...sharedAllowDefaultProjectFilePatternPresets.rootScriptFiles,
+    ],
+});
 /** Shared flat config presets. */
 export const presets = Object.freeze({
     all: sharedConfigs.all,
@@ -28,6 +43,7 @@ export const presets = Object.freeze({
 export const createConfig = (options) => createSharedConfig(options);
 /** Default package export containing config presets and factory helper. */
 const nickTwoBadFourU = Object.freeze({
+    allowDefaultProjectFilePatternPresets,
     configs: presets,
     createConfig,
 });

package/dist/preset.js.map

@@ -1 +1 @@
-{"version":3,"file":"preset.js","sourceRoot":"","sources":["../src/preset.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,YAAY,IAAI,kBAAkB,EAGlC,OAAO,IAAI,aAAa,GAC3B,MAAM,oBAAoB,CAAC;AAE5B,kCAAkC;AAClC,MAAM,CAAC,MAAM,OAAO,GAAkC,MAAM,CAAC,MAAM,CAAC;IAChE,GAAG,EAAE,aAAa,CAAC,GAAG;IACtB,IAAI,EAAE,aAAa,CAAC,IAAI;IACxB,WAAW,EAAE,aAAa,CAAC,WAAW;IACtC,cAAc,EAAE,aAAa,CAAC,cAAc;IAC5C,kBAAkB,EAAE,aAAa,CAAC,kBAAkB;IACpD,cAAc,EAAE,aAAa,CAAC,cAAc;IAC5C,oBAAoB,EAAE,aAAa,CAAC,oBAAoB;IACxD,qBAAqB,EAAE,aAAa,CAAC,qBAAqB;IAC1D,qBAAqB,EAAE,aAAa,CAAC,qBAAqB;IAC1D,iBAAiB,EAAE,aAAa,CAAC,iBAAiB;IAClD,aAAa,EAAE,aAAa,CAAC,aAAa;IAC1C,WAAW,EAAE,aAAa,CAAC,WAAW;IACtC,qBAAqB,EAAE,aAAa,CAAC,qBAAqB;IAC1D,WAAW,EAAE,aAAa,CAAC,WAAW;IACtC,iBAAiB,EAAE,aAAa,CAAC,iBAAiB;IAClD,iBAAiB,EAAE,aAAa,CAAC,iBAAiB;IAClD,eAAe,EAAE,aAAa,CAAC,eAAe;IAC9C,oBAAoB,EAAE,aAAa,CAAC,oBAAoB;IACxD,cAAc,EAAE,aAAa,CAAC,cAAc;IAC5C,eAAe,EAAE,aAAa,CAAC,eAAe;IAC9C,WAAW,EAAE,aAAa,CAAC,WAAW;IACtC,yBAAyB,EAAE,aAAa,CAAC,yBAAyB;CACrE,CAAC,CAAC;AAEH,uDAAuD;AACvD,MAAM,CAAC,MAAM,YAAY,GAAG,CACxB,OAAuC,EACF,EAAE,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;AAExE,2EAA2E;AAC3E,MAAM,eAAe,GAGjB,MAAM,CAAC,MAAM,CAAC;IACd,OAAO,EAAE,OAAO;IAChB,YAAY;CACf,CAAC,CAAC;AAEH,eAAe,eAAe,CAAC"}
+{"version":3,"file":"preset.js","sourceRoot":"","sources":["../src/preset.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,YAAY,IAAI,kBAAkB,EAIlC,qCAAqC,IAAI,2CAA2C,EACpF,OAAO,IAAI,aAAa,GAC3B,MAAM,oBAAoB,CAAC;AAE5B,oFAAoF;AACpF,MAAM,CAAC,MAAM,qCAAqC,GAC9C,MAAM,CAAC,MAAM,CAAC;IACV,gBAAgB,EAAE;QACd,GAAG,2CAA2C,CAAC,gBAAgB;KAClE;IACD,eAAe,EAAE;QACb,GAAG,2CAA2C,CAAC,eAAe;KACjE;IACD,YAAY,EAAE;QACV,GAAG,2CAA2C,CAAC,YAAY;KAC9D;IACD,eAAe,EAAE;QACb,GAAG,2CAA2C,CAAC,eAAe;KACjE;CACJ,CAAC,CAAC;AAEP,kCAAkC;AAClC,MAAM,CAAC,MAAM,OAAO,GAAkC,MAAM,CAAC,MAAM,CAAC;IAChE,GAAG,EAAE,aAAa,CAAC,GAAG;IACtB,IAAI,EAAE,aAAa,CAAC,IAAI;IACxB,WAAW,EAAE,aAAa,CAAC,WAAW;IACtC,cAAc,EAAE,aAAa,CAAC,cAAc;IAC5C,kBAAkB,EAAE,aAAa,CAAC,kBAAkB;IACpD,cAAc,EAAE,aAAa,CAAC,cAAc;IAC5C,oBAAoB,EAAE,aAAa,CAAC,oBAAoB;IACxD,qBAAqB,EAAE,aAAa,CAAC,qBAAqB;IAC1D,qBAAqB,EAAE,aAAa,CAAC,qBAAqB;IAC1D,iBAAiB,EAAE,aAAa,CAAC,iBAAiB;IAClD,aAAa,EAAE,aAAa,CAAC,aAAa;IAC1C,WAAW,EAAE,aAAa,CAAC,WAAW;IACtC,qBAAqB,EAAE,aAAa,CAAC,qBAAqB;IAC1D,WAAW,EAAE,aAAa,CAAC,WAAW;IACtC,iBAAiB,EAAE,aAAa,CAAC,iBAAiB;IAClD,iBAAiB,EAAE,aAAa,CAAC,iBAAiB;IAClD,eAAe,EAAE,aAAa,CAAC,eAAe;IAC9C,oBAAoB,EAAE,aAAa,CAAC,oBAAoB;IACxD,cAAc,EAAE,aAAa,CAAC,cAAc;IAC5C,eAAe,EAAE,aAAa,CAAC,eAAe;IAC9C,WAAW,EAAE,aAAa,CAAC,WAAW;IACtC,yBAAyB,EAAE,aAAa,CAAC,yBAAyB;CACrE,CAAC,CAAC;AAEH,uDAAuD;AACvD,MAAM,CAAC,MAAM,YAAY,GAAG,CACxB,OAAuC,EACF,EAAE,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;AAExE,2EAA2E;AAC3E,MAAM,eAAe,GAIjB,MAAM,CAAC,MAAM,CAAC;IACd,qCAAqC;IACrC,OAAO,EAAE,OAAO;IAChB,YAAY;CACf,CAAC,CAAC;AAEH,eAAe,eAAe,CAAC"}