fix: preserve comments and formatting in yml

[saravmajestic]

Overview

Problem

• In doc editor, comments are not preserved when saving the changes
• When saving a new model/column, tests are not saved as data_tests, instead saved as tests in dbt1.8

Solution

• Use parseDocument api from yaml library to preserve the metadata in yaml files. This will preserve the comments and other formatting
• Pass right column name for identifying if tests should be saved as data_tests or tests

Screenshot/Demo

A picture is worth a thousand words. Please highlight the changes if applicable.

How to test

• Add some comments in schema.yml
• open doc editor and modify and save
• comments should not be removed
• Follow the steps in https://github.com/AltimateAI/vscode-dbt-power-user/issues/1449 for verifying data_tests change

Checklist

• [ ] I have run this code and it appears to resolve the stated issue
• [ ] README.md updated and added information about my change

---

[!IMPORTANT] Preserve comments in YAML files and correctly save test data in docsEditPanel.ts using parseDocument from YAML library.

• Behavior:
  • Use parseDocument from YAML library in docsEditPanel.ts to preserve comments and formatting in YAML files.
  • Correctly save test data as data_tests or tests based on column name in docsEditPanel.ts.
• Functions:
  • Add setOrDeleteInParsedDocument() and findEntityInParsedDoc() in docsEditPanel.ts to manage YAML document entities.
• Misc:
  • Minor refactoring in altimateWebviewProvider.ts for code clarity.

^{This description was created by for 78f324fe83ce1224e26dd903f130f7e696836d66. It will automatically update as commits are pushed.}

---

Summary by CodeRabbit

• New Features

  • Introduced new interfaces for improved documentation schema handling.
  • Enhanced YAML document parsing and manipulation capabilities.
  • Added new commands for better interaction with the webview.

• Bug Fixes

  • Improved error handling and user notifications in command processing.

• Refactor

  • Restructured command handling logic for better clarity and consistency.
  • Streamlined methods for managing documentation data and YAML parsing.

[coderabbitai[bot]]

Walkthrough

The pull request introduces several new interfaces in the docGenService.ts file to enhance type definitions for documentation schemas. It adds DocumentationSchemaColumn, DocumentationSchemaModel, and DocumentationSchema interfaces, which define the structure of documentation-related data. Additionally, modifications in altimateWebviewProvider.ts restructure the command handling logic and add new commands, while docsEditPanel.ts enhances YAML document parsing and manipulation with new methods and improved logic for handling documentation data.

Changes

File Path	Change Summary
src/services/docGenService.ts	Added interfaces: DocumentationSchemaColumn, DocumentationSchemaModel, DocumentationSchema.
src/webview_provider/altimateWebviewProvider.ts	Restructured handleCommand method; added commands: "validateCredentials", "sendTelemetryError".
src/webview_provider/docsEditPanel.ts	Added methods: setOrDeleteInParsedDocument, findEntityInParsedDoc; modified resolveWebview for YAML parsing.

Possibly related PRs

• #1452: The changes in this PR involve the CodeBlock component, which may utilize the new DocumentationSchema and DocumentationSchemaColumn interfaces added in the main PR for structured documentation handling.

Suggested reviewers

• anandgupta42
• mdesmet

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.