Skip to content

Conversation

@ymc9
Copy link
Member

@ymc9 ymc9 commented Mar 24, 2024

Fixes #1079

Summary by CodeRabbit

  • Refactor
    • Improved the project saving process by directly formatting text before saving, enhancing efficiency and simplifying the code structure.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 24, 2024

Walkthrough

Walkthrough

The change involves the removal of the formatFile function, which utilized Prettier for formatting source files in the Zenstack SDK. Instead of formatting files individually, the update directly applies formatting to the text of each source file through the formatText method within the saveProject function. This adjustment streamlines the process, ensuring files are formatted just before they are saved to disk, potentially simplifying the codebase and its dependencies.

Changes

File Path Change Summary
packages/sdk/src/code-gen.ts Removed formatFile function; integrated formatText method for text formatting in saveProject.

Assessment against linked issues

Objective Addressed Explanation
Is prettier required in zenstack sdk? (#1079)

The change directly addresses the concern raised in issue #1079 regarding the necessity of prettier within the Zenstack SDK. By removing the formatFile function and instead using formatText method directly, the dependency on prettier is made more explicit and justified, assuming formatText still relies on prettier for its operation. Without access to the complete codebase or the explicit mention of removing prettier as a dependency, it's assumed that the adjustment validates the continued use of prettier, answering the primary question of its necessity.

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

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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between c13a1fd and d3a7802.
Files ignored due to path filters (2)
  • packages/sdk/package.json is excluded by: !**/*.json
  • pnpm-lock.yaml is excluded by: !**/*.yaml
Files selected for processing (1)
  • packages/sdk/src/code-gen.ts (2 hunks)
Additional comments: 1
packages/sdk/src/code-gen.ts (1)
  • 26-26: The change to directly call formatText on source files simplifies the dependency structure and aligns with the PR's objective. Ensure that the formatting output of formatText meets the project's standards.

@ymc9 ymc9 merged commit a0ca15d into v2 Mar 24, 2024
@ymc9 ymc9 deleted the chore/remove-prettier-1 branch March 24, 2024 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants