mops watch

[ZenVoich]

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced a watch command in the CLI for monitoring .mo files, checking for syntax errors, running tests, and deploying canisters.
  • Added functionality to retrieve error messages in test reports with the new getErrorMessages method.
  • Implemented a Deployer class for managing canister deployments with enhanced state management and error handling.
  • Added ErrorChecker, Generator, Tester, and WarningChecker classes to streamline various operational checks during development.
  • Introduced a file-watching capability that triggers checks upon file changes.
  • Enhanced the dfx.json parsing functionality to filter and retrieve Motoko canisters.

• Bug Fixes

  • Updated the getDefaultPackages function to support the new dfxVersion "0.23.0".

• Documentation

  • Enhanced documentation for the mops toolchain bin command with a new section on executing tool binaries.

• Chores

  • Updated the dfx.json configuration file to reflect the new version "0.23.0".

[coderabbitai[bot]]

Walkthrough

The pull request introduces several changes across multiple files, primarily enhancing functionality in the CLI and related modules. Key updates include the addition of a new case in the getDefaultPackages function for dfxVersion "0.23.0", the introduction of a watch command in the CLI, and the creation of new classes for managing deployments, error checking, and warnings. The changes also include updates to the dfx.json configuration file and modifications to the documentation for the mops toolchain. Overall, the modifications expand the tool's capabilities while maintaining existing structures.

Changes

File Path	Change Summary
backend/main/registry/getDefaultPackages.mo	Added a case for dfxVersion "0.23.0" in getDefaultPackages, returning package "base" version "0.11.2".
cli/check-requirements.ts	Updated checkRequirements to call getMocVersion(false) for obtaining mocVersion.
cli/cli.ts	Introduced watch command for monitoring .mo files, added options for syntax checking, warnings, tests, etc.
cli/commands/bench.ts	Updated compilerVersion retrieval in bench to use getMocVersion(true).
cli/commands/sync.ts	Added getMocPath function and updated getUsedPackages to use it.
cli/commands/test/test.ts	Updated testWithReporter and runAll to include an optional signal parameter for aborting operations.
cli/commands/watch/deployer.ts	Introduced Deployer class for managing canister deployments with methods for running and aborting processes.
cli/commands/watch/parseDfxJson.ts	Introduced functionality for parsing dfx.json and retrieving Motoko canisters.
cli/commands/watch/watch.ts	Added watch function for monitoring file changes and executing various checks based on options.
dfx.json	Updated dfx version from 0.22.0 to 0.23.0 with minor adjustments to schema reference.
dfx.schema.json	Introduced new JSON schema for validating dfx.json configuration files.
docs/docs/00-introduction.md	Enhanced introduction to Mops, detailing its functionalities beyond a package manager.
docs/docs/cli/4-dev/01-mops-watch.md	Added documentation for the mops watch command and its various options.
docs/docs/cli/4-dev/category.json	Updated category label from "Testing & Benchmarking" to "Development".
cli/package.json	Updated @types/node dependency version from "22.5.4" to "22.7.4" and added promisify-child-process dependency.
cli/helpers/get-moc-path.ts	Modified getMocPath to include throwIfNotFound parameter and improved error handling.
cli/helpers/get-moc-version.ts	Updated getMocVersion to include throwOnError parameter and improved error handling.

Possibly related PRs

• #236: The changes in this PR involve updates to the CI workflow related to the moc-version, which may indirectly relate to the getDefaultPackages function if the version impacts package resolution or compatibility.
• #245: This PR introduces functionality for checking dependency conflicts, which is relevant to the getDefaultPackages function as it deals with package management and could be affected by the new case added for dfxVersion "0.23.0".
• #246: The enhancements to the testing framework for replicas may relate to the overall package management and deployment processes, which could include the functionality of getDefaultPackages in a broader context of testing and deployment scenarios.

🐰✨ In the land of code, where changes bloom,
A watch command now clears the gloom.
With errors checked and warnings tamed,
Our canisters dance, all neatly named.
So hop along, let’s deploy with cheer,
For every new feature brings us near! 🐇🎉

---

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:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, 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 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.