Skip to content

eslint-factory: 10 of 38 custom rules undocumented in README.md #50196

Description

@github-actions

Summary

eslint-factory/src/index.ts registers 38 rules under the gh-aw-custom/* namespace, but eslint-factory/README.md only documents 28 of them. The following 10 rules have no ### rule-name`` section in the README:

  • prefer-get-error-message-over-string
  • require-rmsync-try-catch
  • no-core-error-then-process-exit
  • no-core-error-then-process-exitcode
  • no-exec-interpolated-command
  • no-setfailed-then-exit-zero
  • no-err-stack-then-string-fallback
  • no-caught-error-interpolation
  • no-core-error-then-setfailed
  • require-escaped-regexp-interpolation

This has been a standing gap tracked internally across multiple refinement passes (2026-06-29 through 2026-07-08) but never filed as an issue. It matters because:

  • Each rule's own docs.description builds a URL of the form https://github.com/github/gh-aw/tree/main/eslint-factory#<rule-name> (see createRule in each rule file) — for these 10 rules that link currently 404s / lands on a page with no matching anchor.
  • Contributors who see a gh-aw-custom/<rule-name> warning have no discoverable explanation of intent, rationale, or false-positive suppression guidance (the documented rules consistently include an eslint-disable-next-line example where relevant, e.g. require-escaped-regexp-interpolation is already suppressed at actions/setup/js/glob_pattern_helpers.cjs:74-75 with no README section to point to).

Acceptance criteria

  • Add a ### \rule-name`section ineslint-factory/README.md` for each of the 10 rules listed above, following the existing format used by the other 28 rules (short description, example flagged pattern, example fix/suppression where applicable).
  • Confirm every entry in eslint-factory/src/index.ts's rules map has a corresponding README section (i.e., documented-rule count == registered-rule count).
  • No behavior change to the rules themselves — documentation only.

Scope

eslint-factory/README.md only. No rule source changes required.

Generated by 🤖 ESLint Refiner · agent · 261.5 AIC · ⌖ 30.2 AIC · ⊞ 4.9K ·

  • expires on Aug 10, 2026, 10:21 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