Fixing #43978 add description/readme

This commit is contained in:
Erich Gamma 2018-02-21 13:16:36 +01:00
parent 32b28ce90b
commit eaec7c3383
4 changed files with 16 additions and 2 deletions

11
extensions/npm/README.md Normal file
View file

@ -0,0 +1,11 @@
# Node npm
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 you use the `Tasks` menu.
## 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: `npm` or `yarn`, the default is `npm`.

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.2 KiB

View file

@ -1,12 +1,13 @@
{
"name": "npm",
"publisher": "vscode",
"description": "Extension to add task support for npm scripts.",
"displayName": "Npm support for VSCode",
"displayName": "%displayName%",
"description": "%description%",
"version": "0.0.1",
"engines": {
"vscode": "0.10.x"
},
"icon": "images/npm_icon.png",
"categories": [
"Other"
],

View file

@ -1,4 +1,6 @@
{
"description": "Extension to add task support for npm scripts.",
"displayName": "Npm support for VSCode",
"config.npm.autoDetect": "Controls whether auto detection of npm scripts is on or off. Default is on.",
"config.npm.runSilent": "Run npm commands with the `--silent` option.",
"config.npm.packageManager": "The package manager used to run scripts.",