@sarj/eslint-plugin 9.6.0 → 9.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -12,14 +12,11 @@ import sarj from "@sarj/eslint-plugin";
12
12
  export default [...sarj.configs.recommended];
13
13
  ```
14
14
 
15
- 51 rules. Each rule's source under `src/rules/` opens with a one-line claim and
16
- two links: its tests, which are the examples, and `docs/rules/<rule>.md`, which
17
- holds the measurements, the false-positive family behind every guard, and the
18
- alternatives that were rejected. `meta.docs.url` points at the same document, so
19
- `--format=stylish` prints it. Both links are derived from the rule's name, so a
20
- rename moves them.
15
+ 55 rules. Each source under `src/rules/` states one concise claim and links to
16
+ its paired tests. The definition and named test cases are the complete rule
17
+ specification, and `meta.docs.url` points directly to those executable examples.
21
18
 
22
- Presets: `recommended` (warn-first), `strict` (every rule at error), `style-guide` (formatting/naming subset).
19
+ 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.
23
20
 
24
21
  ## Renamed in 7.0.0, aliases deleted in 9.0.0 (breaking)
25
22
 
@@ -43,8 +40,8 @@ exported for codemods:
43
40
  import { renamedRules } from "@sarj/eslint-plugin";
44
41
  ```
45
42
 
46
- Migration steps, the reasoning behind each name, and why the aliases went:
47
- [`docs/rules/_renames.md`](../../docs/rules/_renames.md).
43
+ The rename map and migration behavior live in
44
+ [`src/rules/_renames.ts`](src/rules/_renames.ts) and its tests.
48
45
 
49
46
  ## New in 4.1.0 — `no-hand-rolled-sleep`
50
47
 
@@ -118,8 +115,8 @@ an abandoned placeholder.
118
115
 
119
116
  From a 37,918-comment, nine-repo measurement study. All three are
120
117
  deletion-class, so each was validated against zod / swr / zustand / TanStack
121
- Query as well as the maintained repos. `docs/rules/<rule>.md` carries the hit
122
- counts and the false-positive class every guard was built from.
118
+ Query as well as the maintained repos. Each paired test suite records the
119
+ false-positive shapes guarded by the implementation.
123
120
 
124
121
  | Rule | What it catches | Preset |
125
122
  |---|---|---|