Ensure string escape sequences are preserved

[MichaelDoyle]

No description provided.

[gemini-code-assist]

Hello @MichaelDoyle, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

Hello team,

Gemini here, providing a summary of this pull request by @MichaelDoyle. The primary goal of this PR, as indicated by the title, is to ensure that string values containing escape sequences (like \n for newline or \t for tab) are correctly displayed within the ngx-json-treeview component. Previously, these sequences might not have been rendered as intended, potentially showing up literally or causing formatting issues.

The core change involves updating the component's logic for rendering string values to use JSON.stringify. This standard method correctly formats strings for JSON representation, including escaping special characters. The PR also includes updates to the demo application to add examples of strings with escape sequences, allowing for verification of the fix.

Highlights

• String Rendering Fix: Modified the ngx-json-treeview component to use JSON.stringify when displaying string values. This ensures that escape sequences within strings are correctly represented.
• Demo Updates: Added new examples in the demo application (app.component.html and app.component.ts) to showcase strings containing newline (\n) and tab (\t) escape sequences, verifying the fix.
• Demo Stringify Helper: Updated the stringify helper function in the demo app's app.component.ts to return strings directly without JSON.stringifying them, likely to avoid double-escaping strings that are intended to be displayed by the component's new logic.

Changelog

• projects/demo/src/app/app.component.html
  • Added a new ngx-json-treeview instance displaying a string with a newline escape sequence.
• projects/demo/src/app/app.component.ts
  • Added a new property stringPre to the baseObj with a string containing newline and tab escape sequences.
  • Modified the stringify method to return string inputs directly, bypassing JSON.stringify for strings.
• projects/ngx-json-treeview/src/lib/ngx-json-treeview.component.ts
  • Changed the logic for rendering string values to use JSON.stringify(segment.value) instead of '"' + segment.value + '"' to correctly handle escape sequences.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

---

Strings hold hidden breaks,
Newline, tab, for goodness sakes.
JSON shows them right.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request effectively addresses the preservation of string escape sequences in the JSON tree view. The core change in ngx-json-treeview.component.ts to use JSON.stringify() for string segment descriptions is the correct approach to ensure that strings are displayed as their literal JSON representation, including quotes and escaped characters. The modifications in the demo application (app.component.ts and app.component.html) appropriately demonstrate and test this improved behavior, particularly with the new test cases and the adjustment to the stringify helper for the preview pane.

Overall, the changes are clear, targeted, and enhance the correctness of the component. Well done!

Summary of Findings

• Code Quality: The changes are well-implemented and directly address the issue of preserving string escape sequences. The use of JSON.stringify is appropriate for generating the correct string representation.
• Demo Application Updates: The updates to the demo application, including new test cases and the modification to the stringify helper function, effectively showcase the improved behavior and aid in verifying the fix.

Merge Readiness

The changes in this pull request are well-implemented and address the stated goal of preserving string escape sequences. The code quality is good, and the solution is robust. I believe this pull request is in good shape and ready for merging. As always, ensure any CI checks pass and consider if any further manual testing is desired by the team. I am not authorized to approve pull requests, so please seek approval from other designated reviewers.