Add versions to dependencies in readme install instructions#139
Add versions to dependencies in readme install instructions#139
Conversation
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 11 minutes and 11 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughUpdated installation instructions in the README to pin specific major versions for UI dependencies ( Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@readme.md`:
- Line 42: The README install command pins lucide-react@1 which mismatches the
package version; update the npm install line (the command that currently
includes "lucide-react@1") to match packages/ui/package.json by using the
declared version specifier (e.g., "lucide-react@^0.534.0") so consumers
installing via the README get a compatible dependency.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
|
||
| ```bash | ||
| npm install @radix-ui/react-collapsible @radix-ui/react-tabs classnames lucide-react react-json-pretty react-resizable-panels | ||
| npm install @radix-ui/react-collapsible@1 @radix-ui/react-tabs@1 classnames@2 lucide-react@1 react-json-pretty@2 react-resizable-panels@3 |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify README install versions align with packages/ui/package.json majors (and optionally exact versions).
set -euo pipefail
README_FILE="readme.md"
PKG_FILE="$(fd -a '^package\.json$' packages/ui | head -n1)"
echo "Using package file: ${PKG_FILE}"
echo "---- README install line ----"
rg -n "npm install .*@radix-ui/react-collapsible" "${README_FILE}"
echo "---- UI package dependency versions ----"
jq -r '.dependencies | to_entries[] | "\(.key)=\(.value)"' "${PKG_FILE}" | \
rg "(`@radix-ui/react-collapsible`|@radix-ui/react-tabs|classnames|lucide-react|react-json-pretty|react-resizable-panels)="
Repository: evilmartians/agent-prism
Length of output: 502
Fix lucide-react version mismatch in install command.
Line 42 pins lucide-react@1, but packages/ui/package.json declares lucide-react@^0.534.0. This incompatibility will break consumers following the README. Update to align with actual dependency versions.
Suggested fix
-npm install `@radix-ui/react-collapsible`@1 `@radix-ui/react-tabs`@1 classnames@2 lucide-react@1 react-json-pretty@2 react-resizable-panels@3
+npm install `@radix-ui/react-collapsible`@1.1.11 `@radix-ui/react-tabs`@1.1.13 classnames@2.5.1 lucide-react@0.534.0 react-json-pretty@2.2.0 react-resizable-panels@3.0.6
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| npm install @radix-ui/react-collapsible@1 @radix-ui/react-tabs@1 classnames@2 lucide-react@1 react-json-pretty@2 react-resizable-panels@3 | |
| npm install `@radix-ui/react-collapsible`@1.1.11 `@radix-ui/react-tabs`@1.1.13 classnames@2.5.1 lucide-react@0.534.0 react-json-pretty@2.2.0 react-resizable-panels@3.0.6 |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@readme.md` at line 42, The README install command pins lucide-react@1 which
mismatches the package version; update the npm install line (the command that
currently includes "lucide-react@1") to match packages/ui/package.json by using
the declared version specifier (e.g., "lucide-react@^0.534.0") so consumers
installing via the README get a compatible dependency.
1 participant
This PR adds versions to the dependencies in the install instructions of the README.
Motivation
Because we distribute with degit (copying components’ src to the consuming project), the dependencies are installed as a separate step and aren’t locked to any version. So, when you follow the install instructions, latest versions are installed, and they can have some breaking changes since when the readme was written.
Summary by CodeRabbit