Skip to content

docs: document missing ESLint factory rules - #50960

Merged
pelikhan merged 2 commits into
mainfrom
copilot/docs-self-healing-fixes
Aug 7, 2026
Merged

docs: document missing ESLint factory rules#50960
pelikhan merged 2 commits into
mainfrom
copilot/docs-self-healing-fixes

Conversation

Copilot AI commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

The ESLint factory README omitted two registered rules, leaving rule-reference documentation incomplete.

  • Rule index

    • Add entries for prefer-structured-clone and require-fetch-response-body-try-catch.
  • Rule references

    • Document detected forms, exclusions, and suggestion behavior from each rule’s implementation.
JSON.parse(JSON.stringify(value)) // prefer-structured-clone
await fetch(url).json()           // require-fetch-response-body-try-catch

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Thanks for working on this documentation fix! 👋 This PR is aligned with the project's documentation improvement goals and the description clearly outlines the gaps and plan.

However, there's one thing to note before this can be reviewed for merge:

  • Push the commits — This PR is currently in WIP/DRAFT state with 0 changes. The workflow run encountered a file-protection issue when trying to push signed commits (protected file: eslint-factory/README.md). Once the protected file protection is sorted out or the commits are pushed through an authorized mechanism, this PR will have actual changes ready for review.

Once commits appear, the review will focus on:

  • Documentation parity between eslint-factory/README.md and eslint-factory/src/index.ts (the two missing rules)
  • Content derivation from each rule's meta.docs.description and create() logic

Great work documenting the root cause and suggesting improvements to the Daily Documentation Healer workflow!

Generated by ✅ Contribution Check · auto · 50.2 AIC · ⊞ 8.7K ·

Copilot AI changed the title [WIP] Update self-healing documentation for eslint-factory docs: document missing ESLint factory rules Aug 7, 2026
Copilot AI requested a review from pelikhan August 7, 2026 01:48
@pelikhan
pelikhan marked this pull request as ready for review August 7, 2026 02:21
Copilot AI balanced review requested due to automatic review settings August 7, 2026 02:21
@pelikhan
pelikhan merged commit a232f5c into main Aug 7, 2026
@pelikhan
pelikhan deleted the copilot/docs-self-healing-fixes branch August 7, 2026 02:21

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documents two registered ESLint rules to restore rule-reference parity.

Changes:

  • Adds both rules to the index.
  • Documents detection, exclusions, and suggestions.
  • Some documented behavior does not match implementation.
Show a summary per file
File Description
eslint-factory/README.md Adds references for the two missing rules.

Review details

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Suppressed comments (2)

eslint-factory/README.md:284

  • The implementation matches any identifier named fetch, without resolving whether it is the global binding. Calling these chains “global” is therefore inaccurate for locally shadowed fetch functions.
The rule recognizes direct global `fetch(...)` chains and identifiers assigned from a bare `await fetch(...)`. It supports direct or string-literal computed body methods, such as `response["json"]()`.

eslint-factory/README.md:293

  • Deferred-callback calls are not out of scope: the rule deliberately ignores the outer try boundary and reports these calls because that handler cannot catch their later asynchronous failures. Listing them under “Out of scope” incorrectly implies they are not flagged.
- calls in deferred callbacks nested within a `try` block, because that `try` cannot catch their asynchronous failures
  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Balanced

Comment thread eslint-factory/README.md
- `JSON.parse(JSON.stringify(value))`
- `JSON["parse"](JSON["stringify"](value))`

The rule only reports a `JSON.stringify(...)` call with exactly one argument, because replacer or indentation arguments change the round-trip semantics.
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.86.0

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] Self-healing documentation fixes from issue analysis - 2026-08-07

3 participants