feat: try reading package.json from cwd#51
Merged
JounQin merged 2 commits intoun-ts:mainfrom Aug 9, 2025
Merged
Conversation
🦋 Changeset detectedLatest commit: 25f06a8 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
WalkthroughThe CLI entry point was updated to first attempt reading and parsing the local Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant CLI (cli.ts)
participant FS
participant checkAndPreparePackage
User->>CLI (cli.ts): Run CLI with arguments (name, version, check)
CLI (cli.ts)->>FS: Attempt to read ./package.json
alt package.json exists and name & version match
FS-->>CLI (cli.ts): Return parsed package.json
CLI (cli.ts)->>checkAndPreparePackage: Call with packageJson and check flag
else package.json missing or name/version mismatch
FS-->>CLI (cli.ts): Return null
CLI (cli.ts)->>checkAndPreparePackage: Call with name, version, check flag
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Assessment against linked issues
Assessment against linked issues: Out-of-scope changesNo out-of-scope changes found. Suggested labels
Poem
Note 🔌 MCP (Model Context Protocol) integration is now available in Early Access!Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
commit: |
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed everything up to c76b429 in 1 minute and 18 seconds. Click for details.
- Reviewed
41lines of code in1files - Skipped
0files when reviewing. - Skipped posting
3draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. src/cli.ts:17
- Draft comment:
Empty catch block: consider logging or handling the error to aid debugging when reading/parsing package.json fails. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% The function is clearly designed to gracefully handle the case where the package.json doesn't exist or can't be parsed by returning undefined. The empty catch is intentional - errors here aren't exceptional conditions that need logging, they're expected possibilities. The code handles the undefined return appropriately on line 26. Maybe error logging would help developers debug issues if their package.json exists but is malformed? The error information could be valuable. In this case, the function is explicitly designed to handle missing/invalid package.json by returning undefined. Adding error logging would be noisy since this is an expected case, not an error condition. The empty catch block is intentional and appropriate here - this is a valid pattern for optional configuration reading where failure is an expected case.
2. src/cli.ts:12
- Draft comment:
Consider using an explicit path resolution (e.g., path.join(process.cwd(), PACKAGE_JSON)) for clarity on where package.json is read from. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%None
3. src/cli.ts:27
- Draft comment:
Ensure that checkAndPreparePackage correctly handles both overloads (one accepting a PackageJson object and one with package name/version). - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%None
Workflow ID: wflow_kwH7ffXzrEcmBpCq
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
c76b429 to
ccebe13
Compare
JounQin
requested changes
Aug 9, 2025
ccebe13 to
82dc9ed
Compare
JounQin
approved these changes
Aug 9, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
process.cwd()#49Alternative approach that only runs on the cli variant
Important
Adds
readCwdPackageinsrc/cli.tsto readpackage.jsonfrom the current directory, addressing specific issues.readCwdPackagefunction insrc/cli.tsto readpackage.jsonfrom the current working directory.package.jsonname matchesprocess.argv[2], uses it incheckAndPreparePackage.process.cwd()#49.This description was created by
for c76b429. You can customize this summary. It will automatically update as commits are pushed.
Summary by CodeRabbit
New Features
Bug Fixes