feat(controller): add NCC for compiling controller into a standalone js #444
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@Larkooo is attempting to deploy a commit to the cartridge Team on Vercel. A member of the Team first needs to authorize it. |
|
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
force-pushed
the
compile-controller
branch
from
480b1a2
to
6f7b55e
Compare
|
Important Review skippedReview was skipped due to path filters Files ignored due to path filters (1)
You can disable this status message by setting the WalkthroughThe recent update to the Changes
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
packages/controller/package.json (1)
11-11: Missingnccpackage indevDependencies.The compile script is correctly defined, and the
./packages/controller/src/index.tsfile is present. However, thenccpackage is not listed as a dependency in thepackage.jsonfile. Please addnccto thedevDependenciesto ensure the compile script functions correctly.
package.json: Add"ncc": "^<appropriate-version>"todevDependencies.Analysis chain
LGTM! But verify the compile script functionality.
The addition of the compile script using
nccis approved.However, ensure that the
compilescript 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 compileLength 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.jsonLength 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
Files ignored due to path filters (1)
pnpm-lock.yamlis 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/nccto support the compile script is approved.However, consider the suggestion to use Rollup as an alternative bundler if the maintenance status of
@vercel/nccbecomes a concern.Verification successful
The
@vercel/nccpackage is actively maintained.The latest commit date for the
@vercel/nccrepository is 2024-07-12, indicating recent activity. The addition of@vercel/nccto 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
broody
force-pushed
the
main
branch
3 times, most recently
from
679bdca
to
d495c0b
Compare
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
@vercel/nccas a development dependency.