Skip to content

fix(sync): quote TIP authors with @ to prevent YAML parse error #392

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
max-digi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(sync): quote TIP authors with @ to prevent YAML parse error #392

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 vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,13 @@ function syncTips(): Plugin {
// Escape angle brackets outside of code blocks/inline code so MDX doesn't
// treat them as JSX (e.g. `Mapping<B256, bool>` in prose).
content = escapeAngleBrackets(content)
// Quote frontmatter `authors:` values that start with a YAML reserved
// character (e.g. `@handle`). Upstream TIPs occasionally include GitHub
// handles like `@0xrusowsky`, which break YAML parsing unless quoted.
content = content.replace(
/^(authors:\s*)([@&*!|>%#`].*)$/m,
(_m, prefix, value) => `${prefix}"${value.replace(/"/g, '\\"')}"`,
)
const outputPath = path.join(outputDir, file.name.replace('.md', '.mdx'))
await fs.writeFile(outputPath, content)
}),
Expand Down
Loading