Repository navigation
fix: escape backslashes in generated frontmatter descriptions - #396
Merged
Merged
Conversation
escapeYamlString handled quotes and newlines but not backslashes, so
the escapeRegExp JSDoc summary produced `\,` inside the YAML
description and broke the vitepress website build ("unknown escape
sequence"). Escape backslashes first, then quotes.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The v2.0.0 website deploy failed: the generated
docs/api/escapeRegExp.mdfrontmatter contained an unescaped backslash (\,) from the escapeRegExp JSDoc summary, which vitepress rejects as an unknown YAML escape sequence.escapeYamlStringin the api-documenter markdown plugin escaped quotes and newlines but not backslashes. Backslashes are now escaped first, then quotes.Test plan
\\(valid YAML)vitepress build docspasses locally (was failing in 179ms on this file)After merging, re-run the website workflow to deploy the v2.0.0 docs.
🤖 Generated with Claude Code