Skip to content
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

Use code styling for replacement rule name in deprecated rule notice #154

Merged
merged 1 commit into from
Oct 21, 2022
Merged

Use code styling for replacement rule name in deprecated rule notice #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion lib/rule-notices.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ const RULE_NOTICES: {
*/
function ruleNamesToList(ruleNames: readonly string[]) {
return ruleNames
.map((ruleName) => `[${ruleName}](${ruleName}.md)`)
.map((ruleName) => `[\`${ruleName}\`](${ruleName}.md)`)
.join(', ');
}

Expand Down
2 changes: 1 addition & 1 deletion test/lib/__snapshots__/generator-test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ exports[`generator #generate deprecated rules updates the documentation 1`] = `
exports[`generator #generate deprecated rules updates the documentation 2`] = `
"# Description (\`test/no-foo\`)

❌ This rule is deprecated. It was replaced by [no-bar](no-bar.md).
❌ This rule is deprecated. It was replaced by [\`no-bar\`](no-bar.md).

<!-- end rule header -->
"
Expand Down