GitAuto: [FEATURE] Add YAML format to the output formats

[gitauto-ai]

Resolves #156

What is the feature

Add support for a new output format—YAML—to the data generated by the tool. Currently, the tool supports output formats such as CSV, XML, JSON, and Markdown. The YAML output should follow the same structure as the JSON output, providing an additional human-readable and whitespace-sensitive format.

Why we need the feature

• Increased Compatibility: YAML is widely used for configuration files and data exchange in various tools and applications. By supporting YAML, we enhance the tool's compatibility with systems that prefer or require YAML.

• Human-Readable Format: YAML is designed to be easily readable by humans. It improves readability and maintainability when viewing or editing the output data manually.

• User Flexibility: Offering YAML as an output option provides users with greater flexibility to choose the format that best fits their workflow or integrates seamlessly with their existing tools.

How to implement and why

Step 1: Update Output Format Options

• Modify Command-Line Interface: Update the CLI to accept a new option for YAML output, e.g., --format=yaml or -f yaml.
• Adjust Output Handling: Ensure that when YAML is selected as the output format, the tool generates bancos.yml.

Reasoning: Updating the interface allows users to easily select the new format without affecting existing functionalities.

---

Step 2: Implement YAML Serialization

• Choose a YAML Library: Utilize a YAML serialization library compatible with the project (e.g., YamlDotNet for .NET projects).
• Develop Serialization Logic: Implement methods to convert data objects into YAML format, mirroring the existing JSON serialization process.
• Ensure Structural Consistency: The YAML output should match the JSON structure, including all fields and data types.

Reasoning: Leveraging a well-supported library ensures reliability and reduces the risk of serialization errors.

---

Step 3: Update Documentation and Samples

• Documentation: Update the README and any user guides to include instructions and examples for the YAML output format.
• Sample Data: Provide sample YAML data similar to existing examples to demonstrate the output format to users.

Reasoning: Clear documentation assists users in understanding and adopting the new feature effectively.

---

Step 4: Write Unit Tests

• Test Cases: Create unit tests to verify that the YAML serialization produces the correct output for various data inputs, including edge cases.
• Validation: Ensure special characters, whitespace, and indentation are handled correctly in the YAML output.

Reasoning: Testing guarantees the reliability of the new feature and prevents regressions in future updates.

---

Step 5: Maintain Code Quality

• Code Style: Follow existing coding standards and styles as defined in .editorconfig and other configuration files.
• Configuration Files: Update any relevant configuration files (e.g., .csharpierrc.yaml, .deepsource.toml) to account for the new YAML-related code.

Reasoning: Maintaining code quality and consistency aids in long-term maintainability and collaboration.

About backward compatibility

• No Breaking Changes: The addition of the YAML output format is optional and does not alter or remove any existing functionality.
• Existing Workflows Unaffected: Users who rely on current output formats (CSV, XML, JSON, Markdown) will experience no changes to their workflows.
• Optional Feature: Since the YAML output must be explicitly selected, it will not impact users who do not opt to use it.

Conclusion: The feature is fully backward compatible, providing additional functionality without affecting existing users or integrations.

Test these changes locally

git checkout -b gitauto/issue-#156-b65c0f67-2645-4513-8d04-26b3e13e680f
git pull origin gitauto/issue-#156-b65c0f67-2645-4513-8d04-26b3e13e680f

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 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.

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. (Beta)
• @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.

[guibranco]

@gstraccini create labels

[gstraccini]

Creating 16 labels and updating 16 labels! 🏷️

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud