Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(okam): add cli #1087

Merged
merged 2 commits into from
Apr 25, 2024
Merged

feat(okam): add cli #1087

merged 2 commits into from
Apr 25, 2024

Conversation

sorrycc
Copy link
Member

@sorrycc sorrycc commented Apr 25, 2024

mako -h

Usage: mako <command> [options]

Commands:
  build

Options:
  --help
  --version,-v

Examples:
  mako build
  mako -v

mako build -h

Usage: mako build [options]

Options:
  --help,-h
  --root
  --watch,-w

Examples:
  mako build
  mako build --watch
  mako build --root ./src

Summary by CodeRabbit

  • New Features
    • Added command-line parsing with yargs-parser for improved user interaction.
    • Enhanced script execution based on provided commands.
    • Added showHelp() function to display usage information and commands.
    • Added showBuildHelp() to handle the build command.

Copy link
Contributor

coderabbitai bot commented Apr 25, 2024

Walkthrough

The changes encompass updating the mako.js file to point to the cli module in the dist directory, adding yargs-parser as a dependency, and enhancing command-line parsing in cli.ts with a new showHelp() function and improved script execution based on commands.

Changes

File(s) Summary
mako.js
package.json
Updated require path in mako.js to point to cli module in dist, added yargs-parser as a new dependency in package.json.
cli.ts Enhanced code with command-line parsing using yargs-parser, added showHelp() function for usage info and improved script execution.

Poem

In the code did the rabbit hop,
Updating paths without a stop.
yargs-parser now joins the fun,
Enhancing scripts one by one.
CodeRabbit dances in the digital crop.

Note

Pull Request Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://coderabbit.ai


Commits Files that changed from the base of the PR and between 8ef93f4 and 7ffd46c.
Files selected for processing (1)
  • packages/mako/src/cli.ts (1 hunks)

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

@sorrycc sorrycc merged commit 679f9c8 into master Apr 25, 2024
8 checks passed
@delete-merged-branch delete-merged-branch bot deleted the sorrycc-e93v branch April 25, 2024 01:10
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.

1 participant