fix(md): comment out tab-indented blocks instead of executing them#1485
Closed
Fmarzochi wants to merge 1 commit into
Closed
fix(md): comment out tab-indented blocks instead of executing them#1485Fmarzochi wants to merge 1 commit into
Fmarzochi wants to merge 1 commit into
Conversation
Tab-indented blocks in Markdown (4 spaces or tab) were being pushed
verbatim to the output and executed as JavaScript. Any prose text in
those blocks caused a SyntaxError at runtime, e.g.:
This assumes the environment is configured.
yields: SyntaxError: Unexpected identifier 'assumes'
The fix mirrors the behavior already used for non-JS fenced blocks:
prefix each indented line with '// ' so it becomes a comment.
Updated the existing legacy-behavior test to reflect the new output
and added a regression test for the prose-text SyntaxError case.
Fixes #1388
Signed-off-by: Felipe Marzochi <fmarzochi@gmail.com>
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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
1 participant
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.
Fixes #1388 / regression: SyntaxError when running zx on markdown files with indented prose
Tab-indented blocks (4 spaces or tab, per CommonMark spec) were pushed verbatim to the JS output and executed. Any prose text in those blocks caused a SyntaxError at runtime. For example, a README with:
produced: SyntaxError: Unexpected identifier 'assumes'
The fix mirrors the behavior already used for non-JS fenced blocks: prefix each indented line with '// ' so it becomes a comment. Two places in md.ts needed the change: the transition from root to tab state, and the tab state itself.
Updated the existing legacy-behavior test to reflect the new output and added a regression test for the prose-text case.