VueJS Commander

VueJS Commander is a Visual Studio Code extension designed to streamline the execution of common Vue.js and Nuxt.js commands. It simplifies project creation, development server management, and production builds directly from the VS Code command palette.

Index

• VueJS Commander
  • Index
  • Requirements
  • Setup
    • Step 1: Open Command Palette in VS Code
    • Step 2: Add Configuration to settings.json
    • Step 3: Restart VS Code
  • Configuration
  • Commands
  • Community
  • Contributing
  • Code of Conduct
  • Changelog
  • License

Requirements

• VS Code 1.88.0 or higher.

Setup

Step 1: Open Command Palette in VS Code

1. Open the Command Palette in VS Code:

   • Windows: CTRL + SHIFT + P
   • macOS: CMD + SHIFT + P

2. Open the Workspace Settings:

   • Type Preferences: Open Workspace Settings (JSON).

Step 2: Add Configuration to settings.json

Copy the following configuration into your .vscode/settings.json file:

{
    "vuejs.commander.enable": true,
    "vuejs.commander.packages.defaultPackageManager": "npm",
    "vuejs.commander.terminal.hideFromUser": false
}

Commands run in the selected workspace folder by default. Set vuejs.commander.terminal.currentWorkingDirectory only when you need to override that folder with an explicit absolute path.

Step 3: Restart VS Code

Restart VS Code to apply the settings.

Configuration

You can customize VueJS Commander by modifying its settings in .vscode/settings.json. Some of the available settings are:

• vuejs.commander.enable: Enable or disable the extension.
• vuejs.commander.packages.defaultPackageManager: Set the default package manager for the project. Options are npm, yarn or pnpm (default: "npm").
• vuejs.commander.terminal.currentWorkingDirectory: Optional override for the terminal working directory. When unset, commands run in the selected workspace folder. Must be an absolute path when set.
• vuejs.commander.terminal.hideFromUser: Hide the terminal from the user. If set to true, the terminal will run in the background (default: false).

Commands

Command	Description
Create New Project	Create a new Vue/Nuxt project
Start Development Server	Start the development server
Build for Production	Build the project for production

All commands are available from the Command Palette and from the VueJS Commander submenu in the Explorer context menu on workspace root folders. In multi-root workspaces, Command Palette commands reuse the selected workspace folder, while Explorer commands run in the targeted folder.

Community

This extension is maintained by the Vue JS Colombia Meetup Community. Stay updated on new features and improvements:

• GitHub
• Twitter (X)

Contributing

We welcome contributions from the community! To get started:

1. Fork the GitHub repository.
2. Make your changes and submit a pull request.

For contribution guidelines, refer to the Contribution Guide.

Code of Conduct

We value a welcoming and inclusive community. Please review our Code of Conduct before participating.

Changelog

See the full list of changes in the CHANGELOG.md file.

License

This extension is licensed under the MIT License. See the MIT License for details.