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(controller): add NCC for compiling controller into a standalone js #444

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Larkooo
Copy link
Contributor

@Larkooo Larkooo commented Jul 5, 2024

for web projects without a bundler, like Unity games running on WebGL, we need to bundle packages into standalone source files, so this PR adds "ncc" and a compile directive to build the typescript files and their dependencies into a singular index.js file

Summary by CodeRabbit

  • Chores
    • Added a new build script for compiling the project.
    • Included @vercel/ncc as a development dependency.

Copy link

vercel bot commented Jul 5, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Jul 15, 2024 0:34am
keychain ✅ Ready (Inspect) Visit Preview Jul 15, 2024 0:34am
ui ✅ Ready (Inspect) Visit Preview Jul 15, 2024 0:34am
ui-next ✅ Ready (Inspect) Visit Preview Jul 15, 2024 0:34am

Copy link

vercel bot commented Jul 5, 2024

@Larkooo is attempting to deploy a commit to the cartridge Team on Vercel.

A member of the Team first needs to authorize it.

@Larkooo
Copy link
Contributor Author

Larkooo commented Jul 5, 2024

one thing to note though is that the last commit on @vercel/ncc was 5 months ago so it doesn't seem like it's being properly maintained. a great alternative to that would be rollup which is another bundler altogether

@Larkooo Larkooo force-pushed the compile-controller branch from 480b1a2 to 6f7b55e Compare July 12, 2024 14:27
Copy link

coderabbitai bot commented Jul 12, 2024

Important

Review skipped

Review was skipped due to path filters

Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent update to the controller package's package.json file introduces a new build script that uses ncc for compiling the project. Consequently, @vercel/ncc has been added as a development dependency to facilitate this build process.

Changes

File Change Summary
packages/controller/package.json Added a new script compile using ncc and included @vercel/ncc as a devDependency.

Poem

In the codebase where changes dwell,
A new script emerged, all will tell.
Vercel's ncc joins the dance,
To build and compile, enhancing our chance.
The controller's path now finely spun,
Code flows smoothly, the job well done. 🌟🐇


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

Copy link

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

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
packages/controller/package.json (1)

11-11: Missing ncc package in devDependencies.

The compile script is correctly defined, and the ./packages/controller/src/index.ts file is present. However, the ncc package is not listed as a dependency in the package.json file. Please add ncc to the devDependencies to ensure the compile script functions correctly.

  • package.json: Add "ncc": "^<appropriate-version>" to devDependencies.
Analysis chain

LGTM! But verify the compile script functionality.

The addition of the compile script using ncc is approved.

However, ensure that the compile script works as expected by running it and verifying the output.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the compile script functionality.

# Test: Run the compile script. Expect: Successful build output in the `build` directory.
npm run compile

Length of output: 88


Script:

#!/bin/bash
# Verify the presence and correctness of the compile script in the package.json file.

# Extract the compile script from the package.json file.
jq '.scripts.compile' packages/controller/package.json

Length of output: 90


Script:

#!/bin/bash
# Verify the presence of the ncc package in the package.json file.
jq '.devDependencies.ncc' packages/controller/package.json

# Verify the presence of the ./src/index.ts file.
fd index.ts --exec echo "{}"

Length of output: 2045

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c73f040 and 6f7b55e.

Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
Files selected for processing (1)
  • packages/controller/package.json (2 hunks)
Additional comments not posted (1)
packages/controller/package.json (1)

28-28: LGTM! But consider the maintenance status of @vercel/ncc.

The addition of @vercel/ncc to support the compile script is approved.

However, consider the suggestion to use Rollup as an alternative bundler if the maintenance status of @vercel/ncc becomes a concern.

Verification successful

The @vercel/ncc package is actively maintained.

The latest commit date for the @vercel/ncc repository is 2024-07-12, indicating recent activity. The addition of @vercel/ncc to support the compile script is approved.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the maintenance status of the `@vercel/ncc` package.

# Test: Check the latest commit date of the `@vercel/ncc` repository. Expect: Recent activity.
gh repo view vercel/ncc --json updatedAt --jq '.updatedAt'

Length of output: 79

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