feat(linter): render upstream docs URL in website References section#22769
Merged
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3bcd990f90
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
3bcd990 to
8df8bbf
Compare
8df8bbf to
ef3f0d5
Compare
Boshen
added a commit
to oxc-project/website
that referenced
this pull request
May 27, 2026
Read an optional `upstream` field from the page's frontmatter (matching the rest of the rule-page data flow — `rule`, `type_aware`, etc.) and, when present, render an "Upstream rule docs" link directly below "Rule Source" in the references list. Used by oxc-project/oxc#22769 which writes the upstream URL into the frontmatter of every auto-generated rule docs page (skipped for native oxc rules and unknown plugins).
Boshen
added a commit
to oxc-project/website
that referenced
this pull request
May 27, 2026
…1137) Read an optional `upstream` field from the page's frontmatter (matching the rest of the rule-page data flow — `rule`, `type_aware`, etc.) and, when present, render an "Upstream rule docs" link directly below "Rule Source" in the references list. Used by oxc-project/oxc#22769 which writes the upstream URL into the frontmatter of every auto-generated rule docs page (skipped for native oxc rules and unknown plugins).
ef3f0d5 to
e86c0c0
Compare
Member
Author
Merge activity
|
…22769) ## Summary Renders the upstream-plugin docs URL inside each rule's `## References` section on oxc.rs. - New `tasks/website_linter/src/rules/upstream.rs` with `upstream_docs_url(plugin, name) -> Option<String>` — convention-based per plugin, with per-rule overrides for cases where the directory differs from the true upstream: - `react/rules-of-hooks` and `react/exhaustive-deps` → `eslint-plugin-react-hooks` - `react/only-export-components` → `eslint-plugin-react-refresh` - `doc_page.rs` emits the URL as slot content inside the existing `<RuleReferences>` element. Native oxc rules and unknown plugins produce an empty `<RuleReferences>`. Follow-up to #22768. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
e86c0c0 to
687ad14
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Renders the upstream-plugin docs URL inside each rule's
## Referencessection on oxc.rs.tasks/website_linter/src/rules/upstream.rswithupstream_docs_url(plugin, name) -> Option<String>— convention-based per plugin, with per-rule overrides for cases where the directory differs from the true upstream:react/rules-of-hooksandreact/exhaustive-deps→eslint-plugin-react-hooksreact/only-export-components→eslint-plugin-react-refreshdoc_page.rsemits the URL as slot content inside the existing<RuleReferences>element. Native oxc rules and unknown plugins produce an empty<RuleReferences>.Follow-up to #22768.
🤖 Generated with Claude Code