fix(vscode): language server error when formatting models with Unsupported fields

[ymc9]

Fixes #1517

[coderabbitai]

Walkthrough

Walkthrough

The ZModelFormatter class has been updated to handle the Unsupported field type, ensuring robust length calculation without failures in formatting. This change resolves formatting issues encountered in VSCode extensions when models include fields marked as Unsupported. Additionally, integration tests have been modified to include an Unsupported type to verify the formatter's improved handling capabilities.

Changes

File Path	Change Summary
packages/schema/src/language-server/zmodel-formatter.ts	Enhanced ZModelFormatter class to handle Unsupported field type and added a default fall-back case for unexpected types.
tests/integration/tests/cli/format.test.ts	Modified the Post model to include a foo field with Unsupported("foo") to test the formatter's robustness.

Sequence Diagram(s)

The following Mermaid diagram illustrates the updated sequence for handling a field with the Unsupported type in the ZModelFormatter:

sequenceDiagram
    participant Client
    participant Formatter
    participant ASTNode
    Client->>Formatter: Format ASTNode
    Formatter->>ASTNode: Get field type
    ASTNode-->>Formatter: Unsupported("foo")
    Formatter->>Formatter: Compute length for Unsupported type
    Formatter-->>Client: Formatted ASTNode

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Formatting ZModel with the Unsupported type fails (#1517)	✅

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7f9e408 and f2f4eb3.

Files selected for processing (2)

• packages/schema/src/language-server/zmodel-formatter.ts (1 hunks)
• tests/integration/tests/cli/format.test.ts (4 hunks)

Additional comments not posted (3)

tests/integration/tests/cli/format.test.ts (2)

25-25: LGTM!

The test case correctly includes the Unsupported field and verifies the formatted output.

Also applies to: 38-38

---

52-52: LGTM!

The test case correctly includes the Unsupported field and verifies the formatted output with Prisma style.

Also applies to: 63-63, 65-65

packages/schema/src/language-server/zmodel-formatter.ts (1)

108-120: LGTM!

The method correctly handles unsupported field types and integrates well with the existing logic.