Unify binary files for npx #52

TimWallaceDev · 2024-07-23T23:31:27Z

The Pull Request is ready

fixes unify binaries in cli issues#1118
all actions are passing
only fixes a single issue

Overview

There is now an npx command iabc that is used to create all benchmark projects. It accepts arguments "curl", "har", and "open-api" for respective creation modes. If no argument is added, it creates the default benchmark.

eg. npx iabc

Review points

The previous commands are still included in the project. Should they all be removed?

CLI

the change works with both supported node versions
the default behaviour did not change
shared code has been extracted in a different file

Summary by CodeRabbit

New Features
- Introduced a new command-line interface (CLI) utility for enhanced command execution.
- Added support for multiple commands, improving user interaction with the CLI.
Chores
- Updated package.json to include the new CLI script, expanding available functionalities while preserving existing ones.

coderabbitai · 2024-07-23T23:31:34Z

Walkthrough

The changes introduced a new command-line utility, bin/iabc.js, which processes user commands to enhance project functionality. This script facilitates interaction through predefined commands like "curl", "har", and "open-api", while defaulting to a general make function when no command is specified. Additionally, the package.json file was updated to include the new script in the bin section, allowing for easier access and execution alongside existing scripts.

Changes

File	Change Summary
`bin/iabc.js`	Introduced a new CLI utility for processing command-line arguments, allowing execution of commands like "curl", "har", and "open-api", with error handling for unknown commands.
`package.json`	Added a new entry `"iabc": "bin/iabc.js"` in the `bin` section to enhance script availability, preserving existing entries.

Poem

🐰 In the garden of code, new paths we explore,
With iabc.js, there's magic in store!
Commands at our fingertips, quick as a flash,
Tail twitching with joy, as we make a new splash!
So hop on this script, let our features unite,
In the world of CLI, we dance with delight! 🌟

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:

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.
- @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)

bin/iabc.js (1)
19-21: Remove trailing blank lines.

The trailing blank lines can be removed for cleaner code.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 354e1d3 and 9c77b5f.

Files selected for processing (2)

bin/iabc.js (1 hunks)
package.json (1 hunks)

Additional comments not posted (6)

bin/iabc.js (5)

1-4: LGTM!

The shebang line and imports are correctly set up.

5-8: LGTM!

The command-line arguments are correctly retrieved and assigned.

9-11: LGTM!

The default behavior when no command is provided is correctly handled.

12-15: LGTM!

The specified commands are correctly handled by calling the create function.

16-18: LGTM!

Unknown commands are correctly handled by throwing an error.

package.json (1)

70-71: LGTM!

The new entry for the iabc script is correctly added in the bin section.

Idrinth · 2024-07-23T23:44:29Z

bin/iabc.js

+}
+else {
+    if (command === "curl" || command === "har" || command === "open-api"){
+        create(process.argv, process.cwd(),);


shouldn't this call different creates? process.argv needs to be manipulated somewhere to fit the old implementation - or the old implementation must change

Idrinth · 2024-07-23T23:45:07Z

package.json

@@ -67,7 +67,8 @@
    "iabgbfh": "bin/generate-benchmark-from-har.js",
    "iabmp": "bin/make-benchmark-project.js",
    "iabgfoa": "bin/generate-benchmark-from-open-api.js",
-    "iabgbfc": "bin/generate-benchmark-from-curl.js"
+    "iabgbfc": "bin/generate-benchmark-from-curl.js",


please remove the old ones completely

TimWallaceDev and others added 3 commits July 20, 2024 16:05

hardcode version number for dependency

5a7f28e

Unify multiple binaries into one (iabc)

fe679d8

Merge branch 'idrinth-api-bench:the-one' into the-one

9c77b5f

coderabbitai bot reviewed Jul 23, 2024

View reviewed changes

Idrinth requested changes Jul 23, 2024

View reviewed changes

TimWallaceDev closed this Jul 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unify binary files for npx #52

Unify binary files for npx #52

TimWallaceDev commented Jul 23, 2024 •

edited by Idrinth

Loading

coderabbitai bot commented Jul 23, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

Idrinth Jul 23, 2024

Idrinth Jul 23, 2024

Unify binary files for npx #52

Unify binary files for npx #52

Conversation

TimWallaceDev commented Jul 23, 2024 • edited by Idrinth Loading

The Pull Request is ready

Overview

Review points

CLI

Summary by CodeRabbit

coderabbitai bot commented Jul 23, 2024 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

Idrinth Jul 23, 2024

Choose a reason for hiding this comment

Idrinth Jul 23, 2024

Choose a reason for hiding this comment

TimWallaceDev commented Jul 23, 2024 •

edited by Idrinth

Loading

coderabbitai bot commented Jul 23, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)