Getting started

You can install this awesome extension through the VSCode-Yarn.

Installation

Launch Quick Open

• Linux Ctrl+P
• macOS ⌘P
• Windows Ctrl+P

Paste the following command and press Enter:

ext install gamunu.vscode-yarn

Packaged VSIX Extension ↑

Download the latest .vsix release file from the GitHub repository and install it from the command line

code --install-extension vscode-yarn-*.*.*.vsix

or from within VS Code by launching Quick Open and running the Install from VSIX... command.

GitHub Repository Clone ↑

Change to your .vscode/extensions VS Code extensions directory. Depending on your platform it is located in the following folders:

• Linux ~/.vscode/extensions
• macOs ~/.vscode/extensions
• Windows %USERPROFILE%\.vscode\extensions

Clone the Material Theme repository as gamunu.vscode-yarn:

git clone [email protected]:gamunu/vscode-yarn.git gamunu.vscode-yarn

Features

Commands

• yarn init
• yarn install
• yarn add
• yarn add --dev
• yarn remove <pkg>
• yarn start
• yarn test
• yarn publish [tag]
• yarn run <script>

Not happy with the available commands ? No problem, raw command is also available. Enter any yarn command you want.

Explorer context menu

yarn install also available in the package.json file's explorer context menu.

Run last executed script

You can also run the last executed script by typing yarn run last....

Terminate a script

You can terminate a script with the terminate command. It uses the tree-kill module that you can find on yarn. It has different behaviors on Unix or Windows.

Order of execution of yarn commands

1. If a package.json is opened as an active editor/focused tab yarn will be invoked on it.
2. If the package.json is explicitly defined in the configuration yarn will invoke on it.
3. If above scenarios fail to satisfy. The extension will fallback to package.json in project root folder.

Settings

• yarn.runInTerminal Defines whether the command is run in a terminal window or whether the output form the command is shown in the Output window. The default is to show the output in the output window.
• yarn.dontHideOutputOnSuccess Keep the output panel visible when yarn execution is successful. No effect with runInTerminal. The default is to keep output window open.
• yarn.bin Custom npm bin name, the default is yarn.
• yarn.packageJson Default package json path. relative to current project root.

Example

{
  "yarn.runInTerminal": false,
  "yarn.dontHideOutputOnSuccess": false
  "yarn.packageJson": "src/package.json"
}

Keyboard Shortcuts

The extension defines a chording keyboard shortcut for the R key. As a consequence an existing keybinding for R is not executed immediately. If this is not desired, then please bind another key for these commands, see the customization documentation.

Contribute

Report a bug or a suggestion by posting an issue on the git repository (https://github.com/gamunu/vscode-yarn).

vscode-yarn incorporates code modified from fknop vscode-npm.