feat(cli): new "check" command for validating ZModel

[ymc9]

Fixes #1646

[coderabbitai]

Walkthrough

Walkthrough

The recent changes introduce a new CLI action for schema validation, encapsulated in the check function. This addition enhances the CLI's capabilities by allowing users to validate ZenStack schemas directly from the command line. Additionally, modifications to the loadDocument function streamline its processing based on a new optional parameter. The updates focus on improving the schema checking process, ensuring a more robust and user-friendly experience.

Changes

Files	Change Summary
packages/schema/src/cli/actions/check.ts, packages/schema/src/cli/index.ts	Added a new CLI action for schema validation, encapsulated in the check function, enhancing CLI functionality.
packages/schema/src/cli/actions/index.ts	Updated export statements to add check while removing format, altering the public API.
packages/schema/src/cli/cli-util.ts	Modified loadDocument to include a validateOnly parameter, allowing early return of parsed models for validation tasks.

Assessment against linked issues

Objective	Addressed	Explanation
CLI syntax checking for ZModel (#1646)	✅

---

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 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 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

Outside diff range, codebase verification and nitpick comments (1)

packages/schema/src/cli/actions/check.ts (1)

10-14: Implementation of check function is approved.

The function aligns with the PR objectives to validate the schema. Consider adding error handling to manage potential errors during schema loading.

 export async function check(_projectPath: string, options: Options) {
     const schema = options.schema ?? getDefaultSchemaLocation();
-    await loadDocument(schema);
+    try {
+        await loadDocument(schema);
+        console.log('The schema is valid.');
+    } catch (error) {
+        console.error('Schema validation failed:', error);
+    }
 }

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b863060 and e38f62a.

Files selected for processing (4)

• packages/schema/src/cli/actions/check.ts (1 hunks)
• packages/schema/src/cli/actions/index.ts (1 hunks)
• packages/schema/src/cli/cli-util.ts (2 hunks)
• packages/schema/src/cli/index.ts (2 hunks)

Additional comments not posted (5)

packages/schema/src/cli/actions/index.ts (2)

1-1: Export of check module is approved.

The addition of the check export aligns with the PR objectives to introduce a new command for syntax validation.

---

2-2: Retention of format module export is approved.

The retention of the format export ensures existing functionality remains accessible.

packages/schema/src/cli/index.ts (2)

63-71: Implementation of checkAction function is approved.

The function is consistent with other action functions and ensures telemetry tracking for the check command.

---

144-148: Integration of check command is approved.

The integration aligns with the PR objectives and provides a clear description of the command's purpose.

packages/schema/src/cli/cli-util.ts (1)

Line range hint 30-98: Enhancement: Addition of validateOnly parameter in loadDocument.

The introduction of the validateOnly parameter is a valuable enhancement, allowing the function to return early when validation is the sole requirement. The default value ensures backward compatibility.

However, ensure that the new parameter is correctly utilized across the codebase.

Run the following script to verify the usage of the validateOnly parameter: