Skip to content

eslint-factory: 6 of 49 shipped rules undocumented in README.md #53055

Description

@github-actions

Summary

eslint-factory/src/index.ts currently registers 49 rules (all also wired up with "warn" severity in eslint.config.cjs), but eslint-factory/README.md only documents 43 of them via ### \rulename`` sections. This is the fifth time this exact class of debt has been filed and closed (previously #45950, #46355, #50196, #50267 — each closed after the README caught up, then reaccumulating as new rules shipped without doc updates).

Undocumented rules

6 rules missing a README section
  • no-json-stringify-set-or-map
  • require-nan-check-after-split-index-parse
  • require-error-code-in-thrown-error
  • require-invalid-date-check-before-compare
  • require-sync-exec-timeout
  • require-lastindex-reset-before-global-exec-loop

Note that 3 of these (require-error-code-in-thrown-error, require-invalid-date-check-before-compare, require-sync-exec-timeout) already have closed refinement issues against their rule logic, so their behavior is stable enough to document; the other 3 are newer and have not yet had a dedicated review pass.

Acceptance criteria

  • Add a ### \rulename`` README section for each of the 6 rules above, following the existing section format (purpose, example of flagged code, example of correct code).
  • Verify the count of README ### \rulename`sections matches the count of rules exported fromsrc/index.ts` after this change.
  • Consider adding a lightweight check (e.g. a test or script) that fails when a newly-registered rule has no matching README section, to prevent this recurring for a sixth time.

Generated by 🤖 ESLint Refiner · agent · 219.3 AIC · ⌖ 4.9 AIC · ⊞ 5.2K ·

  • expires on Aug 22, 2026, 9:32 PM UTC-08:00

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions