Fix #2019: Escape pipe characters in CSV-to-Markdown table conversion#2028
Open
dry-shy wants to merge 1 commit into
Open
Fix #2019: Escape pipe characters in CSV-to-Markdown table conversion#2028dry-shy wants to merge 1 commit into
dry-shy wants to merge 1 commit into
Conversation
|
@dry-shy please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
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
Fixes #2019 by escaping pipe (
|) characters in CSV cell values before generating Markdown tables.Problem
Markdown tables use the pipe character (
|) as a column separator. When CSV cell values contain unescaped pipe characters, the generated Markdown table becomes malformed and renders incorrectly in GitHub Flavored Markdown.Example CSV:
Current output:
This causes the table structure to break because
x|yis interpreted as multiple columns.Solution
Added a helper function to escape pipe characters in header and data cells before rendering Markdown rows:
All table cells are now processed through
_escape_cell()before being added to the Markdown output.Result
Generated Markdown:
The table now renders correctly even when cell values contain pipe characters.
Testing
Added/updated tests to verify that:
Related Issue
Fixes #2019