Skip to content

Commit 57aa89f

Browse files
authored
feat: use run by default and run-script as the alias (#8265)
npm/statusboard#467 This pull request standardizes the use of `npm run` across the codebase and documentation, replacing all references to the `npm run-script` - now an alias. It also includes file renaming and updates to reflect this change.
1 parent 78b5a6f commit 57aa89f

File tree

34 files changed

+397
-132
lines changed

34 files changed

+397
-132
lines changed

docs/lib/content/commands/npm-exec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ project.
274274

275275
### See Also
276276

277-
* [npm run-script](/commands/npm-run-script)
277+
* [npm run](/commands/npm-run)
278278
* [npm scripts](/using-npm/scripts)
279279
* [npm test](/commands/npm-test)
280280
* [npm start](/commands/npm-start)

docs/lib/content/commands/npm-restart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: Restart a package
1010

1111
### Description
1212

13-
This restarts a project. It is equivalent to running `npm run-script
13+
This restarts a project. It is equivalent to running `npm run
1414
restart`.
1515

1616
If the current project has a `"restart"` script specified in
@@ -38,7 +38,7 @@ If it does _not_ have a `"restart"` script specified, but it does have
3838

3939
### See Also
4040

41-
* [npm run-script](/commands/npm-run-script)
41+
* [npm run](/commands/npm-run)
4242
* [npm scripts](/using-npm/scripts)
4343
* [npm test](/commands/npm-test)
4444
* [npm start](/commands/npm-start)

docs/lib/content/commands/npm-run-script.md renamed to docs/lib/content/commands/npm-run.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: npm-run-script
2+
title: npm-run
33
section: 1
44
description: Run arbitrary package scripts
55
---

docs/lib/content/commands/npm-shrinkwrap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ design and purpose of package locks in npm, see
2020
### See Also
2121

2222
* [npm install](/commands/npm-install)
23-
* [npm run-script](/commands/npm-run-script)
23+
* [npm run](/commands/npm-run)
2424
* [npm scripts](/using-npm/scripts)
2525
* [package.json](/configuring-npm/package-json)
2626
* [package-lock.json](/configuring-npm/package-lock-json)

docs/lib/content/commands/npm-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ the file specified in a package's `"main"` attribute when evoking with
2121
`node .`
2222

2323
As of [`npm@2.0.0`](https://blog.npmjs.org/post/98131109725/npm-2-0-0), you can
24-
use custom arguments when executing scripts. Refer to [`npm run-script`](/commands/npm-run-script) for more details.
24+
use custom arguments when executing scripts. Refer to [`npm run`](/commands/npm-run) for more details.
2525

2626
### Example
2727

@@ -49,7 +49,7 @@ npm start
4949

5050
### See Also
5151

52-
* [npm run-script](/commands/npm-run-script)
52+
* [npm run](/commands/npm-run)
5353
* [npm scripts](/using-npm/scripts)
5454
* [npm test](/commands/npm-test)
5555
* [npm restart](/commands/npm-restart)

docs/lib/content/commands/npm-stop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ npm stop
4242

4343
### See Also
4444

45-
* [npm run-script](/commands/npm-run-script)
45+
* [npm run](/commands/npm-run)
4646
* [npm scripts](/using-npm/scripts)
4747
* [npm test](/commands/npm-test)
4848
* [npm start](/commands/npm-start)

docs/lib/content/commands/npm-test.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ npm test
3737

3838
### See Also
3939

40-
* [npm run-script](/commands/npm-run-script)
40+
* [npm run](/commands/npm-run)
4141
* [npm scripts](/using-npm/scripts)
4242
* [npm start](/commands/npm-start)
4343
* [npm restart](/commands/npm-restart)

docs/lib/content/commands/npm-version.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ deletes the `build/temp` directory.
9898
### See Also
9999

100100
* [npm init](/commands/npm-init)
101-
* [npm run-script](/commands/npm-run-script)
101+
* [npm run](/commands/npm-run)
102102
* [npm scripts](/using-npm/scripts)
103103
* [package.json](/configuring-npm/package-json)
104104
* [config](/using-npm/config)

docs/lib/content/commands/npx.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ This resulted in some shifts in its functionality:
153153

154154
### See Also
155155

156-
* [npm run-script](/commands/npm-run-script)
156+
* [npm run](/commands/npm-run)
157157
* [npm scripts](/using-npm/scripts)
158158
* [npm test](/commands/npm-test)
159159
* [npm start](/commands/npm-start)

docs/lib/content/configuring-npm/package-json.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,7 @@ file in the `bin` field, so it is available to run by `name` or `name.cmd` (on
378378
Windows PowerShell). When this package is installed as a dependency in another
379379
package, the file will be linked where it will be available to that package
380380
either directly by `npm exec` or by name in other scripts when invoking them
381-
via `npm run-script`.
381+
via `npm run`.
382382

383383

384384
For example, myapp could have this:

0 commit comments

Comments
 (0)