Skip to content

fix: stripRichTextMarkup must not corrupt Mermaid node syntax #4

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

Closed
NeoVand wants to merge 1 commit into from
Closed

fix: stripRichTextMarkup must not corrupt Mermaid node syntax #4

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
7 changes: 7 additions & 0 deletions src/lib/utils/text-parser.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,4 +117,11 @@ describe('stripRichTextMarkup', () => {
expect(out).not.toContain('{{');
expect(out.toLowerCase()).toContain('handshake');
});

it('leaves Mermaid node-shape syntax untouched (non-slug ids)', () => {
// Mermaid reuses {{…}} (hexagon) and [[…]] (subroutine) — these are not
// our refs and must survive stripping so diagram labels stay valid.
expect(stripRichTextMarkup('T3{{"Middlebox"}}')).toBe('T3{{"Middlebox"}}');
expect(stripRichTextMarkup('N[[Subroutine Step]]')).toBe('N[[Subroutine Step]]');
});
});
23 changes: 17 additions & 6 deletions src/lib/utils/text-parser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,10 @@ function bracketFallbackLabel(rawId: string): string {
}
}

/** A real cross-reference id is a lowercase slug (optionally `prefix:id` or
* `part/chapter`). Used to tell our refs apart from Mermaid shape syntax. */
const REF_ID = /^[a-z0-9][a-z0-9:/-]*$/;

/**
* Strip rich-text atoms ([[…]] / {{…}} / **…**) down to their label
* text. For surfaces that render strings as raw DOM text (screen-reader
Expand All @@ -261,12 +265,19 @@ export function stripRichTextMarkup(raw: string): string {
// abbreviation, concept term, …) rather than vanishing — otherwise a bare
// `[[tcp]]` in a stripped field (tooltip / aria-label) would silently drop
// the word.
//
// IMPORTANT: only resolve when the id is slug-shaped (lowercase kebab/colon).
// Mermaid reuses `{{…}}` (hexagon) and `[[…]]` (subroutine) for node *shapes*,
// e.g. `T3{{"Middlebox"}}`. Those aren't our refs — left untouched so this
// function (which also cleans Mermaid node labels) doesn't corrupt diagrams.
return raw
.replace(/\[\[([^\][|]+)(?:\|([^\]]+))?\]\]/g, (_m, id, label) =>
label != null ? label : bracketFallbackLabel(id)
)
.replace(/\{\{([^}{|]+)(?:\|([^}]+))?\}\}/g, (_m, id, label) =>
label != null ? label : (getConceptById(id)?.term ?? id)
)
.replace(/\[\[([^\][|]+)(?:\|([^\]]+))?\]\]/g, (m, id, label) => {
if (label != null) return label;
return REF_ID.test(id) ? bracketFallbackLabel(id) : m;
})
.replace(/\{\{([^}{|]+)(?:\|([^}]+))?\}\}/g, (m, id, label) => {
if (label != null) return label;
return REF_ID.test(id) ? (getConceptById(id)?.term ?? id) : m;
})
.replace(/\*\*([^*]+)\*\*/g, '$1');
}
Loading