refactor: create symlink in ~/.local/bin
Close https://github.com/leoafarias/fvm/issues/832
Summary by CodeRabbit
-
Refactor
- Simplified installation and uninstallation processes by using the user's local bin directory and removing privilege escalation and shell-specific PATH modifications.
-
Chores
- Removed the update script, consolidating installation and update steps into a single streamlined process.
-
Documentation
- Updated user instructions to provide a clear, generic message for adding the binary directory to PATH manually.
@ipcjs is attempting to deploy a commit to the FlutterTools Team on Vercel.
A member of the Team first needs to authorize it.
Walkthrough
The installation and uninstallation scripts for FVM have been refactored to use a user-local installation approach. All logic for privilege escalation, system-wide symlink creation, and shell configuration modification has been removed. The installer now creates a symlink in the user's $HOME/.local/bin directory and instructs the user to manually add this directory to their PATH. The uninstaller is updated to remove the symlink from the local bin directory. The update script has been deleted entirely. These changes simplify the installation process and avoid permission issues.
Changes
| File(s) | Change Summary |
|---|---|
| scripts/install.sh | Refactored to eliminate privilege escalation, system-wide symlink creation, and shell config edits. Now creates a user-local symlink in $HOME/.local/bin and prints manual PATH instructions. Verification runs from the new location. |
| scripts/uninstall.sh | Updated to remove OS detection, use user-local symlink directory, and check/remove symlink in $HOME/.local/bin. Removes PATH modification messages. |
| scripts/update.sh | Deleted the update script entirely. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant InstallScript
participant LocalBinDir
User->>InstallScript: Run install.sh
InstallScript->>LocalBinDir: Ensure $HOME/.local/bin exists
InstallScript->>LocalBinDir: Create symlink to fvm binary
InstallScript->>User: Print PATH export instructions
InstallScript->>User: Verify installation and print success
Assessment against linked issues
| Objective | Addressed | Explanation |
|---|---|---|
| Remove privilege escalation and system-wide symlink to fix Linux install (#832) | β | |
| Use user-local bin directory and provide manual PATH instructions (#832) | β |
Poem
In my burrow, scripts now run with ease,
No more sudo, no root-user pleas!
A symlink hops to my local bin,
PATH instructionsβlet the fun begin!
With update gone and install so light,
This bunny codes through day and night.
πβ¨
[!TIP]
β‘π¬ Agentic Chat (Pro Plan, General Availability)
- We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
π Recent review details
Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro
π₯ Commits
Reviewing files that changed from the base of the PR and between b6692c2247b324c6b22432446ca9438bebcff38b and ce5838f6c5af7b2e90e9dae33a257866d4ddc016.
π Files selected for processing (3)
-
scripts/install.sh(3 hunks) -
scripts/uninstall.sh(2 hunks) -
scripts/update.sh(0 hunks)
π€ Files with no reviewable changes (1)
- scripts/update.sh
π Additional comments (2)
scripts/uninstall.sh (1)
1-33: User-local uninstall logic is correct and safe.The script now cleanly uninstalls FVM from user-local directories, with appropriate checks and error handling. No issues found.
scripts/install.sh (1)
1-132: User-local installation logic is robust and safe.The script now installs FVM in user-local directories, with clear error handling and user instructions. No issues found.
β¨ Finishing Touches
- [ ] π Generate Docstrings
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.
πͺ§ 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>, please review it. -
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
@coderabbitaiin 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
@coderabbitaiin 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase. -
@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 using PR comments)
-
@coderabbitai pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai generate docstringsto generate docstrings for this PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
Thanks for this PR @ipcjs!
Closing as issue #832 has been resolved. If you feel this approach is still valuable, please feel free to reopen with context on how it improves upon the current solution.
Appreciate the contribution! π