Skip to content

fix: throw an error if text block contains HTML comment markup #81

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

Merged
chrispcampbell merged 1 commit into from
Dec 12, 2024
Merged

fix: throw an error if text block contains HTML comment markup #81

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
11 changes: 11 additions & 0 deletions packages/docs-builder/src/context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,17 @@ export class Context {
}
}

// Fail the build if a block contains an HTML comment; usually when a comment appears
// it is the result of a misconfigured command block (like for a `section` or `def`),
// and those should never appear in the translation files, so we trap them here
if (text.includes('<!--')) {
throw new Error(
this.getScopedMessage(
`Block for '${fullId}' contains an unexpected HTML comment, which should not be included in translation files`
)
)
}

this.blocks.set(fullId, {
id: fullId,
text,
Expand Down