feat: support format switch in VSCode extension

[jiashengguo]

Summary by CodeRabbit

• New Features

  • Added a new configuration option in package.json to customize Prisma style indentation.

• Refactor

  • Updated the document formatting logic in the language server to enhance customization and performance.

• Documentation

  • Improved internal documentation for the language server components.

[coderabbitai]

Walkthrough

Walkthrough

The changes involve enhancing the formatting capabilities of a language server for a tool called ZenStack. A new configuration for Prisma style indentation was added, and significant updates were made to support configurable document formatting, including changes in method names and the use of additional parameters and services for formatting logic.

Changes

File Path	Change Summary
packages/schema/package.json	Added a new configuration section for "ZenStack" to control Prisma style indentation.
packages/schema/src/language-server/.../zmodel-formatter.ts	Updated with new imports, method renaming from doDocumentFormat to formatDocument, and enhanced to use ConfigurationProvider.
packages/schema/src/language-server/.../zmodel-module.ts	Updated the Formatter function to include a services parameter, affecting ZModelFormatter instantiation.

Possibly related issues

• VScode extension: Suppport formatting of access policy expression #559: The enhancements to the formatting capabilities in the language server could potentially address the need for configurable formatting preferences and integration into the workflow as outlined in this issue. This aligns with the objectives of enabling and configuring formatting support.

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 6e9a04d and 539107f.

Files selected for processing (1)

• packages/schema/src/language-server/zmodel-formatter.ts (2 hunks)

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

• packages/schema/src/language-server/zmodel-formatter.ts

---

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:

Note: Auto-reply has been disabled for this repository by the repository owner. 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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: 1