diff --git a/extensions/npm/README.md b/extensions/npm/README.md new file mode 100644 index 00000000000..678f3c6edf7 --- /dev/null +++ b/extensions/npm/README.md @@ -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`. diff --git a/extensions/npm/images/npm_icon.png b/extensions/npm/images/npm_icon.png new file mode 100644 index 00000000000..f7f18b560ee Binary files /dev/null and b/extensions/npm/images/npm_icon.png differ diff --git a/extensions/npm/package.json b/extensions/npm/package.json index f8e04312c27..be884ffe538 100644 --- a/extensions/npm/package.json +++ b/extensions/npm/package.json @@ -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" ], diff --git a/extensions/npm/package.nls.json b/extensions/npm/package.nls.json index 3f537686a6c..211b7768501 100644 --- a/extensions/npm/package.nls.json +++ b/extensions/npm/package.nls.json @@ -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.",