docs: document missing ESLint factory rules - #50960
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
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:
Once commits appear, the review will focus on:
Great work documenting the root cause and suggesting improvements to the Daily Documentation Healer workflow!
|
There was a problem hiding this comment.
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 shadowedfetchfunctions.
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
tryboundary 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
| - `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. |
|
🎉 This pull request is included in a new release. Release: |
The ESLint factory README omitted two registered rules, leaving rule-reference documentation incomplete.
Rule index
prefer-structured-cloneandrequire-fetch-response-body-try-catch.Rule references