@sarj/eslint-plugin 9.6.0 → 9.7.1

package/README.md

@@ -12,14 +12,11 @@ import sarj from "@sarj/eslint-plugin";
 export default [...sarj.configs.recommended];
 ```
 
-51 rules. Each rule's source under `src/rules/` opens with a one-line claim and
-two links: its tests, which are the examples, and `docs/rules/<rule>.md`, which
-holds the measurements, the false-positive family behind every guard, and the
-alternatives that were rejected. `meta.docs.url` points at the same document, so
-`--format=stylish` prints it. Both links are derived from the rule's name, so a
-rename moves them.
+55 rules. Each source under `src/rules/` states one concise claim and links to
+its paired tests. The definition and named test cases are the complete rule
+specification, and `meta.docs.url` points directly to those executable examples.
 
-Presets: `recommended` (warn-first), `strict` (every rule at error), `style-guide` (formatting/naming subset).
+Presets: `recommended` (warn-first), `strict` (every shipped rule at its declared strict severity), `style-guide` (formatting/naming subset). The two-sentence comment rule warns; its three-sentence companion errors.
 
 ## Renamed in 7.0.0, aliases deleted in 9.0.0 (breaking)
 
@@ -43,8 +40,8 @@ exported for codemods:
 import { renamedRules } from "@sarj/eslint-plugin";
 ```
 
-Migration steps, the reasoning behind each name, and why the aliases went:
-[`docs/rules/_renames.md`](../../docs/rules/_renames.md).
+The rename map and migration behavior live in
+[`src/rules/_renames.ts`](src/rules/_renames.ts) and its tests.
 
 ## New in 4.1.0 — `no-hand-rolled-sleep`
 
@@ -118,8 +115,8 @@ an abandoned placeholder.
 
 From a 37,918-comment, nine-repo measurement study. All three are
 deletion-class, so each was validated against zod / swr / zustand / TanStack
-Query as well as the maintained repos. `docs/rules/<rule>.md` carries the hit
-counts and the false-positive class every guard was built from.
+Query as well as the maintained repos. Each paired test suite records the
+false-positive shapes guarded by the implementation.
 
 | Rule | What it catches | Preset |
 |---|---|---|
@@ -141,7 +138,7 @@ Both distilled from two years of PR-review comments across ~1,065 PRs.
 | `prefer-zod-infer` | An `interface`/`type` that restates a Zod schema declared in the same module instead of deriving it with `z.infer`. Options: `ignoreTypeNames`, `requireIdenticalShape` (default `true`). | warn / error |
 | `prefer-module-level-constant` | A literal-only `const` collection (array, object, `Set`, `Map`, `Object.freeze`) or non-global regex declared inside a function body, never mutated and never escaping — hoist it to module scope. Options: `minElements` (default 3), `checkRegex`, `ignoreTestFiles`. | warn / error |
 | `prefer-module-level-schema` | A Zod schema built inside a function body that closes over nothing the function owns — hoist it to module scope instead of rebuilding it per call, per request, per render. Silent when it references a parameter, local, type parameter, local type, or `this` (that is a schema FACTORY), when it is already memoized, and inside `z.lazy`. Options: `factories` (default: the object-like composites), `minProperties` (default 1), `ignoreTestFiles`. | warn / error |
-| `prefer-non-nullable-collection` | An array type explicitly combined with `null`/`undefined`, creating two equivalent empty states. | warn / error |
+| `prefer-non-nullable-collection` | A required array property or direct alias explicitly combined with `null`/`undefined`, creating two equivalent empty states. Optional API fields are excluded because omission can be meaningful. | warn / error |
 
 ## Options