Notice: This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled.
This extension supports running npm scripts defined in the package.json
as tasks. Scripts with the name 'build', 'compile', or 'watch'
are treated as build tasks.
To run scripts as tasks, use the Tasks menu.
For more information about auto detection of Tasks, see the documentation.
The Npm Script Explorer shows the npm scripts found in your workspace. The explorer view is enabled by the setting npm.enableScriptExplorer
. A script can be opened, run, or debug from the explorer.
The extension supports to run the selected script as a task when editing the package.json
file. You can either run a script from
the hover shown on a script or using the command Run Selected Npm Script
.
The extension fetches data from https://registry.npmjs/org and https://registry.bower.io to provide auto-completion and information on hover features on npm dependencies.
npm.autoDetect
- Enable detecting scripts as tasks, the default ison
.npm.runSilent
- Run npm script with the--silent
option, the default isfalse
.npm.packageManager
- The package manager used to run the scripts:npm
oryarn
, the default isnpm
.npm.exclude
- Glob patterns for folders that should be excluded from automatic script detection. The pattern is matched against the absolute path of the package.json. For example, to exclude all test folders use '**/test/**'.npm.enableScriptExplorer
- Enable an explorer view for npm scripts.npm.scriptExplorerAction
- The default click action:open
orrun
, the default isopen
.npm.scriptCodeLens.enable
- Enable/disable the code lenses to run a script, the default isfalse
.