feat: add reference property to context.report() for external docs links#2734
Open
mvanhorn wants to merge 2 commits intoRedocly:mainfrom
Open
feat: add reference property to context.report() for external docs links#2734mvanhorn wants to merge 2 commits intoRedocly:mainfrom
mvanhorn wants to merge 2 commits intoRedocly:mainfrom
Conversation
|
Collaborator
|
Could you add a E2E or a unit test that demonstrates how the output will look like? And please do not modify our PR template. |
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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
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
Adds a
referenceproperty tocontext.report()so custom rules can link to external documentation explaining the design decision behind a rule.Usage
Output (stylish format):
Changes
packages/core/src/walk.ts: Addedreference?: stringtoProblemandNormalizedProblemtypespackages/core/src/format/format.ts: Display reference URL in both stylish and GitHub Actions output formattersThe property passes through automatically via the
...optsspread in the normalization logic, so no additional wiring is needed.Fixes #1052
This contribution was developed with AI assistance (Claude Code).