Skip to content

feat: add reference property to context.report() for external docs links #2734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mvanhorn wants to merge 2 commits into
base: main
Choose a base branch
from
+8 −1
Open

feat: add reference property to context.report() for external docs links #2734

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48763d0
feat: add reference property to context.report() for external docs links
mvanhorn Apr 10, 2026
590886e
style: fix oxfmt formatting in format.ts
mvanhorn Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion packages/core/src/format/format.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,7 @@ export function formatProblems(
`[${idx + 1}] ${bgColor(fileWithLoc)} ${atPointer}\n\n` +
`${problem.message}\n\n` +
formatDidYouMean(problem) +
(problem.reference ? `Reference: ${colorize.blue(problem.reference)}\n\n` : '') +
getCodeframe(loc, color) +
'\n\n' +
formatFrom(cwd, problem.from) +
Expand Down Expand Up @@ -440,7 +441,11 @@ function outputForGithubActions(problems: NormalizedProblem[], cwd: string): voi
break;
}
const suggest = formatDidYouMean(problem);
const message = suggest !== '' ? problem.message + '\n\n' + suggest : problem.message;
const reference = problem.reference ? `Reference: ${problem.reference}\n\n` : '';
const message =
problem.message +
(suggest !== '' ? '\n\n' + suggest : '') +
(reference !== '' ? '\n\n' + reference : '');
const properties = {
title: problem.ruleId,
file: isAbsoluteUrl(location.source.absoluteRef)
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/walk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ export type Problem = {
from?: LocationObject;
forceSeverity?: RuleSeverity;
ruleId?: string;
reference?: string;
};

export type NormalizedProblem = {
Expand All @@ -89,6 +90,7 @@ export type NormalizedProblem = {
from?: LocationObject;
suggest: string[];
ignored?: boolean;
reference?: string;
};

export type WalkContext = {
Expand Down
Loading