Skip to content

Fix #160: Add proper text escaping in FormatHtml #161

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix #160: Add proper text escaping in FormatHtml #161

wants to merge 1 commit into from

Conversation

@bukzor
Copy link
Contributor

@bukzor bukzor commented Oct 22, 2025

Summary

  • Fixes HTML text nodes containing &, <, > being output without proper escaping
  • Prevents data corruption when round-tripping HTML through xq | xq -j

Changes

  • Added escapeTextContent() function for minimal entity escaping (&amp;, &lt;, &gt;)
  • Modified FormatHtml() to escape text nodes properly
  • Added comprehensive tests verifying output is valid XML

Test plan

  • Unit tests pass: go test ./...
  • New tests verify proper escaping of &, <, > in HTML text nodes
  • Tests confirm xq output can be parsed as XML (required for -j flag)
  • Verified tests fail without the fix (showing they detect the bug)

Example

Before this fix:

echo '<html>1 &amp; 2</html>' | xq
# Output: <html>1 & 2</html>  (bare & causes parse error)
echo '<html>1 &amp; 2</html>' | xq | xq -j
# Error: invalid character entity & (no semicolon)

After this fix:

echo '<html>1 &amp; 2</html>' | xq
# Output: <html>1 &amp; 2</html>  (properly escaped)
echo '<html>1 &amp; 2</html>' | xq | xq -j
# Success: {"html": "1 & 2"}

🤖 Generated with Claude Code

@bukzor @claude
Fix sibprogrammer#160: Add proper text escaping in FormatHtml
b32b900 
HTML text nodes containing &, <, > were output without escaping,
causing xq's output to be unparseable when piped back through xq -j.

This commit adds:
- New escapeTextContent() function for minimal entity escaping
- Modified FormatHtml to escape text nodes with &amp;, &lt;, &gt;
- Tests verifying the output is valid XML

Example issue:
  echo '<html>1 &amp; 2</html>' | xq | xq -j
  # Before: Error - bare & in output
  # After: Success - properly escaped as &amp;

This is a critical fix preventing data corruption when round-tripping
HTML through xq.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@bukzor bukzor mentioned this pull request Oct 22, 2025
Open
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@bukzor