Skip to content

fix(metadata): preserve -- prefix in anchor IDs for CLI flags #758

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
sujalgoel wants to merge 2 commits into
base: main
Choose a base branch
from
+4 −4
Open

fix(metadata): preserve -- prefix in anchor IDs for CLI flags #758

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
079de38
fix(metadata): preserve -- prefix in anchor IDs for CLI flags
sujalgoel Apr 9, 2026
a15edca
test(metadata): remove redundant CLI flag slug tests
sujalgoel 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
4 changes: 2 additions & 2 deletions src/generators/metadata/constants.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ export const DOC_API_SLUGS_REPLACEMENTS = [
{ from: /node.js/i, to: 'nodejs' }, // Replace Node.js
{ from: /&/, to: '-and-' }, // Replace &
{ from: /[/,:;\\ ]/g, to: '-' }, // Replace /,:;\. and whitespace
{ from: /^-+(?!-*$)/g, to: '' }, // Remove any leading hyphens
{ from: /^-(?=[^-])/g, to: '' }, // Remove a single leading hyphen (preserves -- prefix for CLI flags)
{ from: /(?<!^-*)-+$/g, to: '' }, // Remove any trailing hyphens
{ from: /^(?!-+$).*?(--+)/g, to: '-' }, // Replace multiple hyphens
{ from: /^(?!-+$)[^-].*?(--+)/g, to: '-' }, // Replace multiple consecutive hyphens (not at start)
Copy link
Copy Markdown
Member

@MattIPv4 MattIPv4 Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This regex looks very odd, unless there is some magic going on, this is replacing all of [^-].*?(--+) with -?

];

// These are regular expressions used to determine if a given Markdown heading
Expand Down
4 changes: 2 additions & 2 deletions src/generators/metadata/utils/__tests__/slugger.test.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ describe('slug', () => {
assert.strictEqual(slug('-foo', identity), 'foo');
});

it('removes multiple leading hyphens', () => {
assert.strictEqual(slug('--foo', identity), 'foo');
it('preserves double leading hyphens (CLI flag prefix)', () => {
assert.strictEqual(slug('--foo', identity), '--foo');
});

it('preserves an all-hyphen string', () => {
Expand Down
Loading