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

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

guibranco / BancosBrasileiros-MergeTool