Skip to content

fix(metadata): preserve underscores in generated anchor IDs #749

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
thisalihassan wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

fix(metadata): preserve underscores in generated anchor IDs #749

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 src/generators/metadata/constants.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export const IGNORE_STABILITY_STEMS = ['documentation'];
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: '-' }, // Replace /,:;\. and whitespace
{ from: /^-+(?!-*$)/g, to: '' }, // Remove any leading hyphens
{ from: /(?<!^-*)-+$/g, to: '' }, // Remove any trailing hyphens
{ from: /^(?!-+$).*?(--+)/g, to: '-' }, // Replace multiple hyphens
Expand Down
8 changes: 4 additions & 4 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 @@ -25,8 +25,8 @@ describe('slug', () => {
});

describe('special character to hyphen replacement', () => {
it('replaces underscores with hyphens', () => {
assert.strictEqual(slug('foo_bar', identity), 'foo-bar');
it('preserves underscores', () => {
assert.strictEqual(slug('foo_bar', identity), 'foo_bar');
});

it('replaces forward slashes with hyphens', () => {
Expand Down Expand Up @@ -85,8 +85,8 @@ describe('slug', () => {
assert.strictEqual(slug('Hello World'), 'hello-world');
});

it('converts underscored names to hyphenated slugs', () => {
assert.strictEqual(slug('child_process'), 'child-process');
it('preserves underscores in module names', () => {
assert.strictEqual(slug('child_process'), 'child_process');
});

it('handles titles with no special characters', () => {
Expand Down
Loading