Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/tidy-deprecations-smile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@node-core/doc-kit': patch
---

Preserve deprecation codes in generated table-of-contents labels.
22 changes: 22 additions & 0 deletions src/generators/jsx-ast/utils/__tests__/buildBarProps.test.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,28 @@ describe('extractHeadings', () => {
assert.equal(result[1].value, 'new Buffer');
});

it('preserves deprecation codes in heading labels', () => {
const entries = [
{
heading: {
depth: 2,
data: {
text: 'DEP0001: `http.OutgoingMessage.prototype.flush`',
name: 'http.OutgoingMessage.prototype.flush',
slug: 'DEP0001',
},
},
},
];

const result = extractHeadings(entries);

assert.equal(
result[0].value,
'DEP0001: http.OutgoingMessage.prototype.flush'
);
});

it('drops overload headings and links to the first signature', () => {
const entries = [
{
Expand Down
5 changes: 3 additions & 2 deletions src/generators/jsx-ast/utils/buildBarProps.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,9 @@ const headingLabel = data => {
data.text
// Remove any containing code blocks
.replace(/`/g, '')
// Remove any prefixes (i.e. 'Class:')
.replace(/^[^:]+:/, '')
// Remove any prefixes (i.e. 'Class:'), except deprecation codes
// (i.e. 'DEP0001:') which are part of the label
.replace(/^(?!DEP\d+:)[^:]+:/, '')
// Trim the remaining whitespace
.trim()
);
Expand Down
Loading