Escape strings when creating descriptions

[333fred]

Descriptions are just splatted into the generated code wholesale, not fixing up any characters that are invalid C#, such as newlines, backslashes, and the like. These are now appropriately escaped for use in a C# string without errors.

Summary by CodeRabbit

• New Features

  • Added two new methods, each with multi-line descriptions, to the tools interface in integration tests.

• Bug Fixes

  • Improved handling of method descriptions to ensure they are valid C# string literals, enhancing compatibility and reducing formatting errors in generated code.

[coderabbitai]

Walkthrough

The changes introduce a new helper method to ensure description strings used in generated C# code are valid C# string literals. This method is applied in tool generation and dictionary string construction. Additionally, two new asynchronous methods with multi-line descriptions are added to an interface and its implementation in the integration tests.

Changes

File(s)	Change Summary
src/libs/CSharpToJsonSchema.Generators/Sources.Method.Tools.cs, src/libs/CSharpToJsonSchema.Generators/Sources.Tools.cs	Added usage of GetDescriptionStringAsValidCSharp to format method descriptions as valid C# string literals; introduced new helper method for this purpose; updated dictionary string construction to use the helper.
src/tests/CSharpToJsonSchema.IntegrationTests/VariousTypesTools.cs	Added two async methods with multi-line descriptions to the interface and implementation for testing.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Integration Test
    participant Interface as IVariousTypesTools
    participant Service as VariousTypesService

    Test->>Interface: Call GetValueAsync2()
    Interface->>Service: GetValueAsync2()
    Service-->>Interface: NotImplementedException

    Test->>Interface: Call GetValueAsync3()
    Interface->>Service: GetValueAsync3()
    Service-->>Interface: NotImplementedException

Loading

Poem

In fields of code, a bunny hops,
Escaping quotes and stringy flops.
Descriptions now are crystal clear,
Even when newlines appear!
With tools improved and tests anew,
This rabbit’s proud of what you do.
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 23ce85a and aada4a2.

📒 Files selected for processing (1)

• src/libs/CSharpToJsonSchema.Generators/Sources.Method.Tools.cs (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/libs/CSharpToJsonSchema.Generators/Sources.Method.Tools.cs

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[CLAassistant]

All committers have signed the CLA.