mirror of
https://github.com/nodejs/node.git
synced 2025-05-14 08:30:29 +00:00
248f4c3764
PR-URL: https://github.com/nodejs/node/pull/39813 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Rich Trott <rtrott@gmail.com>
80 lines
1.9 KiB
Markdown
80 lines
1.9 KiB
Markdown
---
|
|
title: npm-set-script
|
|
section: 1
|
|
description: Set tasks in the scripts section of package.json
|
|
---
|
|
|
|
### Synopsis
|
|
An npm command that lets you create a task in the `scripts` section of the `package.json`.
|
|
|
|
```bash
|
|
npm set-script [<script>] [<command>]
|
|
```
|
|
|
|
|
|
**Example:**
|
|
|
|
* `npm set-script start "http-server ."`
|
|
|
|
```json
|
|
{
|
|
"name": "my-project",
|
|
"scripts": {
|
|
"start": "http-server .",
|
|
"test": "some existing value"
|
|
}
|
|
}
|
|
```
|
|
|
|
### Configuration
|
|
|
|
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
|
<!-- automatically generated, do not edit manually -->
|
|
<!-- see lib/utils/config/definitions.js -->
|
|
#### `workspace`
|
|
|
|
* Default:
|
|
* Type: String (can be set multiple times)
|
|
|
|
Enable running a command in the context of the configured workspaces of the
|
|
current project while filtering by running only the workspaces defined by
|
|
this configuration option.
|
|
|
|
Valid values for the `workspace` config are either:
|
|
|
|
* Workspace names
|
|
* Path to a workspace directory
|
|
* Path to a parent workspace directory (will result to selecting all of the
|
|
nested workspaces)
|
|
|
|
When set for the `npm init` command, this may be set to the folder of a
|
|
workspace which does not yet exist, to create the folder and set it up as a
|
|
brand new workspace within the project.
|
|
|
|
This value is not exported to the environment for child processes.
|
|
|
|
<!-- automatically generated, do not edit manually -->
|
|
<!-- see lib/utils/config/definitions.js -->
|
|
|
|
#### `workspaces`
|
|
|
|
* Default: false
|
|
* Type: Boolean
|
|
|
|
Enable running a command in the context of **all** the configured
|
|
workspaces.
|
|
|
|
This value is not exported to the environment for child processes.
|
|
|
|
<!-- automatically generated, do not edit manually -->
|
|
<!-- see lib/utils/config/definitions.js -->
|
|
|
|
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
|
|
|
### See Also
|
|
|
|
* [npm run-script](/commands/npm-run-script)
|
|
* [npm install](/commands/npm-install)
|
|
* [npm test](/commands/npm-test)
|
|
* [npm start](/commands/npm-start)
|