43 lines
2.6 KiB
Markdown
43 lines
2.6 KiB
Markdown
|
# Node npm
|
||
|
|
|
||
|
|
**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled.
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
### Task Running
|
||
|
|
|
||
|
|
This extension supports running npm scripts defined in the `package.json` as [tasks](https://code.visualstudio.com/docs/editor/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](https://code.visualstudio.com/Docs/editor/tasks#_task-autodetection).
|
||
|
|
|
||
|
|
### Script Explorer
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
### Run Scripts from the Editor
|
||
|
|
|
||
|
|
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`.
|
||
|
|
|
||
|
|
### Run Scripts from a Folder in the Explorer
|
||
|
|
|
||
|
|
The extension supports running a script as a task from a folder in the Explorer. The command `Run NPM Script in Folder...` shown in the Explorer context menu finds all scripts in `package.json` files that are contained in this folder. You can then select the script to be executed as a task from the resulting list. You enable this support with the `npm.runScriptFromFolder` which is `false` by default.
|
||
|
|
|
||
|
|
### Others
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
## Settings
|
||
|
|
|
||
|
|
- `npm.autoDetect` - Enable detecting scripts as tasks, the default is `on`.
|
||
|
|
- `npm.runSilent` - Run npm script with the `--silent` option, the default is `false`.
|
||
|
|
- `npm.packageManager` - The package manager used to run the scripts: `auto`, `npm`, `yarn`, `pnpm` or `bun`. The default is `auto`, which detects your package manager based on files in your workspace.
|
||
|
|
- `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` or `run`, the default is `open`.
|
||
|
|
- `npm.enableRunFromFolder` - Enable running npm scripts from the context menu of folders in Explorer, the default is `false`.
|
||
|
|
- `npm.scriptCodeLens.enable` - Enable/disable the code lenses to run a script, the default is `false`.
|