Skip to content

Conversation

@devxpain
Copy link
Contributor

@devxpain devxpain commented Jun 3, 2025

Related GitHub Issue

Discussions: 4238

Description

This commit introduces a new pnpm install:vsix command and updates the README.md to improve the developer experience for installing and testing the VS Code extension.

  • New pnpm install:vsix command: Automates the process of uninstalling the current extension, building the latest VSIX package, and installing it. This simplifies iterative development and testing.
  • Updated README.md: The 'Run the extension' section has been significantly expanded and clarified, now detailing:
    • Development Mode (F5) for quick changes.
    • Automated VSIX Installation using the new pnpm install:vsix command.
    • Manual VSIX Installation steps.
  • New scripts/install-vsix.js: Provides the logic for the automated installation process.
  • Reload Window Note: Added a note in the documentation about code --reload-window not always working reliably, potentially requiring a manual VS Code restart.

Test Procedure

  • Run pnpm install:vsix

Type of Change

  • 🐛 Bug Fix: Non-breaking change that fixes an issue.
  • New Feature: Non-breaking change that adds functionality.
  • 💥 Breaking Change: Fix or feature that would cause existing functionality to not work as expected.
  • ♻️ Refactor: Code change that neither fixes a bug nor adds a feature.
  • 💅 Style: Changes that do not affect the meaning of the code (white-space, formatting, etc.).
  • 📚 Documentation: Updates to documentation files.
  • ⚙️ Build/CI: Changes to the build process or CI configuration.
  • 🧹 Chore: Other changes that don't modify src or test files.

Pre-Submission Checklist

  • Issue Linked: This PR is linked to an approved GitHub Issue (see "Related GitHub Issue" above).
  • Scope: My changes are focused on the linked issue (one major feature/fix per PR).
  • Self-Review: I have performed a thorough self-review of my code.
  • Code Quality:
    • My code adheres to the project's style guidelines.
    • There are no new linting errors or warnings (npm run lint).
    • All debug code (e.g., console.log) has been removed.
  • Testing:
    • New and/or updated tests have been added to cover my changes.
    • All tests pass locally (npm test).
    • The application builds successfully with my changes.
  • Branch Hygiene: My branch is up-to-date (rebased) with the main branch.
  • Documentation Impact: I have considered if my changes require documentation updates (see "Documentation Updates" section below).
  • Changeset: A changeset has been created using npm run changeset if this PR includes user-facing changes or dependency updates.
  • Contribution Guidelines: I have read and agree to the Contributor Guidelines.

Documentation Updates

Get in Touch


Important

Adds pnpm install:vsix command and updates documentation to streamline VSIX package installation for VS Code extension development.

  • New Feature:
    • Adds pnpm install:vsix command in package.json to automate VSIX package installation.
    • Implements scripts/install-vsix.js to handle uninstalling, building, and installing the VSIX package.
  • Documentation:
    • Updates README.md to include instructions for using pnpm install:vsix and manual VSIX installation steps.
    • Adds note about potential need for manual VS Code restart after installation.

This description was created by Ellipsis for 4f0c5225f7f5c570ece1e82724e8850945ebf622. You can customize this summary. It will automatically update as commits are pushed.

@devxpain devxpain requested review from cte and mrubens as code owners June 3, 2025 09:38
@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. documentation Improvements or additions to documentation enhancement New feature or request labels Jun 3, 2025
@daniel-lxs daniel-lxs added the Issue/PR - Triage New issue. Needs quick review to confirm validity and assign labels. label Jun 3, 2025
@daniel-lxs daniel-lxs moved this from Triage to PR [Needs Prelim Review] in Roo Code Roadmap Jun 3, 2025
@hannesrudolph hannesrudolph added PR - Needs Preliminary Review and removed Issue/PR - Triage New issue. Needs quick review to confirm validity and assign labels. labels Jun 3, 2025
@devxpain devxpain force-pushed the vsix branch 2 times, most recently from f41873d to a0dcc96 Compare June 5, 2025 10:13
Copy link
Member

@daniel-lxs daniel-lxs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @devxpain, Thank you for your contribution!

I left a couple of questions that are worth checking out before we approve your PR.

Let me know what you think!

@daniel-lxs daniel-lxs moved this from PR [Needs Prelim Review] to PR [Changes Requested] in Roo Code Roadmap Jun 6, 2025
@devxpain devxpain requested a review from jr as a code owner June 7, 2025 00:56
@devxpain devxpain requested a review from daniel-lxs June 7, 2025 01:06
@daniel-lxs daniel-lxs moved this from PR [Changes Requested] to PR [Needs Review] in Roo Code Roadmap Jun 23, 2025
@daniel-lxs daniel-lxs moved this from PR [Needs Review] to PR [Needs Prelim Review] in Roo Code Roadmap Jun 23, 2025
Copy link
Member

@daniel-lxs daniel-lxs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @devxpain, I left a suggestion to make the script a bit more robust, let me know what you think.

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Jun 26, 2025
@devxpain
Copy link
Contributor Author

devxpain commented Jun 26, 2025

Hi @daniel-lxs, I’ve updated it based on your code and added the -y flag for automatic confirmation.

@devxpain devxpain requested a review from daniel-lxs June 26, 2025 08:26
@daniel-lxs daniel-lxs moved this from PR [Changes Requested] to PR [Needs Review] in Roo Code Roadmap Jun 26, 2025
@daniel-lxs daniel-lxs moved this from PR [Needs Review] to PR [Needs Prelim Review] in Roo Code Roadmap Jun 30, 2025
@daniel-lxs daniel-lxs moved this from PR [Needs Prelim Review] to PR [Needs Review] in Roo Code Roadmap Jun 30, 2025
@daniel-lxs
Copy link
Member

@devxpain
I'll share with you a patch with the needed changes to address the latest review:
pr-4284-review-fixes.txt

Let me know if you have any questions.

@daniel-lxs daniel-lxs moved this from PR [Needs Review] to PR [Changes Requested] in Roo Code Roadmap Jun 30, 2025
- Introduce `pnpm install:vsix` command for automated VSIX installation.
- This new command handles uninstalling existing versions, building the latest VSIX, and installing it directly into the specified editor.
- Add options (`-y` for non-interactive, `--editor=<command>` to specify editor like `cursor` or `code-insiders`) to the `install:vsix` script.
- Update `README.md` to provide clearer, segmented instructions for running the extension:
    - Development Mode (F5) with clarified hot reload behavior.
    - Automated VSIX Installation using the new `pnpm install:vsix` command.
    - Manual VSIX Installation steps.
@devxpain
Copy link
Contributor Author

devxpain commented Jul 1, 2025

@devxpain I'll share with you a patch with the needed changes to address the latest review: pr-4284-review-fixes.txt

Let me know if you have any questions.

@daniel-lxs I’ve already applied your patch—thanks for the fixes!

@daniel-lxs daniel-lxs moved this from PR [Changes Requested] to PR [Needs Prelim Review] in Roo Code Roadmap Jul 1, 2025
@daniel-lxs daniel-lxs moved this from PR [Needs Prelim Review] to PR [Needs Review] in Roo Code Roadmap Jul 1, 2025
Copy link
Member

@daniel-lxs daniel-lxs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @devxpain!

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jul 1, 2025
@mrubens mrubens merged commit 0ee3680 into RooCodeInc:main Jul 1, 2025
17 checks passed
@github-project-automation github-project-automation bot moved this from New to Done in Roo Code Roadmap Jul 1, 2025
@github-project-automation github-project-automation bot moved this from PR [Needs Review] to Done in Roo Code Roadmap Jul 1, 2025
@devxpain devxpain deleted the vsix branch July 2, 2025 02:53
utarn pushed a commit to modelharbor/ModelHarbor-Agent that referenced this pull request Jul 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request lgtm This PR has been approved by a maintainer PR - Needs Preliminary Review size:L This PR changes 100-499 lines, ignoring generated files.

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants