feat: use run by default and run-script as the alias (#8265)

owlstronaut · web-flow · commit 57aa89ff70e0 · 2025-05-06T09:06:06.000-07:00
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.
diff --git a/docs/lib/content/commands/npm-exec.md b/docs/lib/content/commands/npm-exec.md
@@ -274,7 +274,7 @@ project.
 
 ### See Also
 
-* [npm run-script](/commands/npm-run-script)
+* [npm run](/commands/npm-run)
 * [npm scripts](/using-npm/scripts)
 * [npm test](/commands/npm-test)
 * [npm start](/commands/npm-start)
diff --git a/docs/lib/content/commands/npm-restart.md b/docs/lib/content/commands/npm-restart.md
@@ -10,7 +10,7 @@ description: Restart a package
 
 ### Description
 
-This restarts a project.  It is equivalent to running `npm run-script
+This restarts a project.  It is equivalent to running `npm run
 restart`.
 
 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
 
 ### See Also
 
-* [npm run-script](/commands/npm-run-script)
+* [npm run](/commands/npm-run)
 * [npm scripts](/using-npm/scripts)
 * [npm test](/commands/npm-test)
 * [npm start](/commands/npm-start)
diff --git a/docs/lib/content/commands/npm-run.md b/docs/lib/content/commands/npm-run.md
@@ -1,5 +1,5 @@
 ---
-title: npm-run-script
+title: npm-run
 section: 1
 description: Run arbitrary package scripts
 ---
diff --git a/docs/lib/content/commands/npm-shrinkwrap.md b/docs/lib/content/commands/npm-shrinkwrap.md
@@ -20,7 +20,7 @@ design and purpose of package locks in npm, see
 ### See Also
 
 * [npm install](/commands/npm-install)
-* [npm run-script](/commands/npm-run-script)
+* [npm run](/commands/npm-run)
 * [npm scripts](/using-npm/scripts)
 * [package.json](/configuring-npm/package-json)
 * [package-lock.json](/configuring-npm/package-lock-json)
diff --git a/docs/lib/content/commands/npm-start.md b/docs/lib/content/commands/npm-start.md
@@ -21,7 +21,7 @@ the file specified in a package's `"main"` attribute when evoking with
 `node .`
 
 As of [`npm@2.0.0`](https://blog.npmjs.org/post/98131109725/npm-2-0-0), you can
-use custom arguments when executing scripts. Refer to [`npm run-script`](/commands/npm-run-script) for more details.
+use custom arguments when executing scripts. Refer to [`npm run`](/commands/npm-run) for more details.
 
 ### Example
 
@@ -49,7 +49,7 @@ npm start
 
 ### See Also
 
-* [npm run-script](/commands/npm-run-script)
+* [npm run](/commands/npm-run)
 * [npm scripts](/using-npm/scripts)
 * [npm test](/commands/npm-test)
 * [npm restart](/commands/npm-restart)
diff --git a/docs/lib/content/commands/npm-stop.md b/docs/lib/content/commands/npm-stop.md
@@ -42,7 +42,7 @@ npm stop
 
 ### See Also
 
-* [npm run-script](/commands/npm-run-script)
+* [npm run](/commands/npm-run)
 * [npm scripts](/using-npm/scripts)
 * [npm test](/commands/npm-test)
 * [npm start](/commands/npm-start)
diff --git a/docs/lib/content/commands/npm-test.md b/docs/lib/content/commands/npm-test.md
@@ -37,7 +37,7 @@ npm test
 
 ### See Also
 
-* [npm run-script](/commands/npm-run-script)
+* [npm run](/commands/npm-run)
 * [npm scripts](/using-npm/scripts)
 * [npm start](/commands/npm-start)
 * [npm restart](/commands/npm-restart)
diff --git a/docs/lib/content/commands/npm-version.md b/docs/lib/content/commands/npm-version.md
@@ -98,7 +98,7 @@ deletes the `build/temp` directory.
 ### See Also
 
 * [npm init](/commands/npm-init)
-* [npm run-script](/commands/npm-run-script)
+* [npm run](/commands/npm-run)
 * [npm scripts](/using-npm/scripts)
 * [package.json](/configuring-npm/package-json)
 * [config](/using-npm/config)
diff --git a/docs/lib/content/commands/npx.md b/docs/lib/content/commands/npx.md
@@ -153,7 +153,7 @@ This resulted in some shifts in its functionality:
 
 ### See Also
 
-* [npm run-script](/commands/npm-run-script)
+* [npm run](/commands/npm-run)
 * [npm scripts](/using-npm/scripts)
 * [npm test](/commands/npm-test)
 * [npm start](/commands/npm-start)
diff --git a/docs/lib/content/configuring-npm/package-json.md b/docs/lib/content/configuring-npm/package-json.md
@@ -378,7 +378,7 @@ file in the `bin` field, so it is available to run by `name` or `name.cmd` (on
 Windows PowerShell). When this package is installed as a dependency in another
 package, the file will be linked where it will be available to that package
 either directly by `npm exec` or by name in other scripts when invoking them
-via `npm run-script`.
+via `npm run`.
 
 
 For example, myapp could have this:
diff --git a/docs/lib/content/nav.yml b/docs/lib/content/nav.yml
@@ -144,8 +144,8 @@
   - title: npm root
     url: /commands/npm-root
     description: Display npm root
-  - title: npm run-script
-    url: /commands/npm-run-script
+  - title: npm run
+    url: /commands/npm-run
     description: Run arbitrary package scripts
   - title: npm sbom
     url: /commands/npm-sbom
diff --git a/docs/lib/content/using-npm/scripts.md b/docs/lib/content/using-npm/scripts.md
@@ -9,7 +9,7 @@ description: How npm handles the "scripts" field
 The `"scripts"` property of your `package.json` file supports a number
 of built-in scripts and their preset life cycle events as well as
 arbitrary scripts. These all can be executed by running
-`npm run-script <stage>` or `npm run <stage>` for short. *Pre* and *post*
+`npm run <stage>` or `npm run <stage>` for short. *Pre* and *post*
 commands with matching names will be run for those as well (e.g. `premyscript`,
 `myscript`, `postmyscript`). Scripts from dependencies can be run with
 `npm explore <pkg> -- npm run <stage>`.
@@ -180,7 +180,7 @@ If there is a `restart` script defined, these events are run, otherwise
 * `restart`
 * `postrestart`
 
-#### [`npm run <user defined>`](/commands/npm-run-script)
+#### [`npm run <user defined>`](/commands/npm-run)
 
 * `pre<user-defined>`
 * `<user-defined>`
@@ -358,7 +358,7 @@ file.
 
 ### See Also
 
-* [npm run-script](/commands/npm-run-script)
+* [npm run](/commands/npm-run)
 * [package.json](/configuring-npm/package-json)
 * [npm developers](/using-npm/developers)
 * [npm install](/commands/npm-install)
diff --git a/docs/lib/content/using-npm/workspaces.md b/docs/lib/content/using-npm/workspaces.md
@@ -221,6 +221,6 @@ npm run test --workspaces --if-present
 
 * [npm install](/commands/npm-install)
 * [npm publish](/commands/npm-publish)
-* [npm run-script](/commands/npm-run-script)
+* [npm run](/commands/npm-run)
 * [config](/using-npm/config)
 
diff --git a/lib/commands/restart.js b/lib/commands/restart.js
@@ -1,6 +1,6 @@
 const LifecycleCmd = require('../lifecycle-cmd.js')
 
-// This ends up calling run-script(['restart', ...args])
+// This ends up calling run(['restart', ...args])
 class Restart extends LifecycleCmd {
   static description = 'Restart a package'
   static name = 'restart'
diff --git a/lib/commands/run.js b/lib/commands/run.js
@@ -16,7 +16,7 @@ class RunScript extends BaseCommand {
     'script-shell',
   ]
 
-  static name = 'run-script'
+  static name = 'run'
   static usage = ['<command> [-- <args>]']
   static workspaces = true
   static ignoreImplicitWorkspace = false
@@ -201,7 +201,7 @@ class RunScript extends BaseCommand {
     }
 
     if (runScripts.length) {
-      const via = `via \`${blue('npm run-script')}\`:`
+      const via = `via \`${blue('npm run')}\`:`
       if (!cmds.length) {
         output.standard(`${title('Scripts')} available ${pkgId} ${via}`)
       } else {
diff --git a/lib/commands/start.js b/lib/commands/start.js
@@ -1,6 +1,6 @@
 const LifecycleCmd = require('../lifecycle-cmd.js')
 
-// This ends up calling run-script(['start', ...args])
+// This ends up calling run(['start', ...args])
 class Start extends LifecycleCmd {
   static description = 'Start a package'
   static name = 'start'
diff --git a/lib/commands/stop.js b/lib/commands/stop.js
@@ -1,6 +1,6 @@
 const LifecycleCmd = require('../lifecycle-cmd.js')
 
-// This ends up calling run-script(['stop', ...args])
+// This ends up calling run(['stop', ...args])
 class Stop extends LifecycleCmd {
   static description = 'Stop a package'
   static name = 'stop'
diff --git a/lib/commands/test.js b/lib/commands/test.js
@@ -1,6 +1,6 @@
 const LifecycleCmd = require('../lifecycle-cmd.js')
 
-// This ends up calling run-script(['test', ...args])
+// This ends up calling run(['test', ...args])
 class Test extends LifecycleCmd {
   static description = 'Test a package'
   static name = 'test'
diff --git a/lib/lifecycle-cmd.js b/lib/lifecycle-cmd.js
@@ -9,11 +9,11 @@ class LifecycleCmd extends BaseCommand {
   static ignoreImplicitWorkspace = false
 
   async exec (args) {
-    return this.npm.exec('run-script', [this.constructor.name, ...args])
+    return this.npm.exec('run', [this.constructor.name, ...args])
   }
 
   async execWorkspaces (args) {
-    return this.npm.exec('run-script', [this.constructor.name, ...args])
+    return this.npm.exec('run', [this.constructor.name, ...args])
   }
 }
 
diff --git a/lib/npm.js b/lib/npm.js
@@ -221,7 +221,7 @@ class Npm {
     const command = new Command(this)
 
     // since 'test', 'start', 'stop', etc. commands re-enter this function
-    // to call the run-script command, we need to only set it one time.
+    // to call the run command, we need to only set it one time.
     if (!this.#command) {
       this.#command = command
       process.env.npm_command = this.command
diff --git a/lib/utils/cmd-list.js b/lib/utils/cmd-list.js
@@ -50,7 +50,7 @@ const commands = [
   'repo',
   'restart',
   'root',
-  'run-script',
+  'run',
   'sbom',
   'search',
   'set',
@@ -105,7 +105,7 @@ const aliases = {
   t: 'test',
   ddp: 'dedupe',
   v: 'view',
-  run: 'run-script',
+  'run-script': 'run',
   'clean-install': 'ci',
   'clean-install-test': 'install-ci-test',
   x: 'exec',
@@ -132,9 +132,9 @@ const aliases = {
   'dist-tags': 'dist-tag',
   upgrade: 'update',
   udpate: 'update',
-  rum: 'run-script',
+  rum: 'run',
   sit: 'install-ci-test',
-  urn: 'run-script',
+  urn: 'run',
   ogr: 'org',
   'add-user': 'adduser',
 }
diff --git a/smoke-tests/tap-snapshots/test/index.js.test.cjs b/smoke-tests/tap-snapshots/test/index.js.test.cjs
@@ -27,10 +27,9 @@ All commands:
     help-search, init, install, install-ci-test, install-test,
     link, ll, login, logout, ls, org, outdated, owner, pack,
     ping, pkg, prefix, profile, prune, publish, query, rebuild,
-    repo, restart, root, run-script, sbom, search, set,
-    shrinkwrap, star, stars, start, stop, team, test, token,
-    undeprecate, uninstall, unpublish, unstar, update, version,
-    view, whoami
+    repo, restart, root, run, sbom, search, set, shrinkwrap,
+    star, stars, start, stop, team, test, token, undeprecate,
+    uninstall, unpublish, unstar, update, version, view, whoami
 
 Specify configs in the ini-formatted file:
     {NPM}/{TESTDIR}/home/.npmrc
@@ -355,7 +354,7 @@ exports[`test/index.js TAP basic npm prefix > should have expected prefix output
 {NPM}/{TESTDIR}/project
 `
 
-exports[`test/index.js TAP basic npm run-script > should have expected run-script output 1`] = `
+exports[`test/index.js TAP basic npm run > should have expected run output 1`] = `
 > project@1.0.0 hello
 > echo Hello
 
diff --git a/smoke-tests/test/index.js b/smoke-tests/test/index.js
@@ -182,10 +182,10 @@ t.test('basic', async t => {
     )
   })
 
-  await t.test('npm run-script', async t => {
-    const cmdRes = await npm('run', 'hello')
+  await t.test('npm run', async t => {
+    const cmdRes = await npm('run-script', 'hello')
 
-    t.matchSnapshot(cmdRes.stdout, 'should have expected run-script output')
+    t.matchSnapshot(cmdRes.stdout, 'should have expected run output')
   })
 
   await t.test('npm prefix', async t => {
diff --git a/tap-snapshots/test/lib/commands/completion.js.test.cjs b/tap-snapshots/test/lib/commands/completion.js.test.cjs
@@ -88,7 +88,7 @@ Array [
     repo
     restart
     root
-    run-script
+    run
     sbom
     search
     set
@@ -135,7 +135,7 @@ Array [
     t
     ddp
     v
-    run
+    run-script
     clean-install
     clean-install-test
     x
diff --git a/tap-snapshots/test/lib/commands/publish.js.test.cjs b/tap-snapshots/test/lib/commands/publish.js.test.cjs
@@ -197,7 +197,7 @@ Object {
     "man/man1/npm-repo.1",
     "man/man1/npm-restart.1",
     "man/man1/npm-root.1",
-    "man/man1/npm-run-script.1",
+    "man/man1/npm-run.1",
     "man/man1/npm-sbom.1",
     "man/man1/npm-search.1",
     "man/man1/npm-shrinkwrap.1",
diff --git a/tap-snapshots/test/lib/commands/run.js.test.cjs b/tap-snapshots/test/lib/commands/run.js.test.cjs
diff --git a/tap-snapshots/test/lib/docs.js.test.cjs b/tap-snapshots/test/lib/docs.js.test.cjs
diff --git a/tap-snapshots/test/lib/npm.js.test.cjs b/tap-snapshots/test/lib/npm.js.test.cjs
diff --git a/test/lib/commands/help-search.js b/test/lib/commands/help-search.js
diff --git a/test/lib/commands/run.js b/test/lib/commands/run.js
diff --git a/test/lib/lifecycle-cmd.js b/test/lib/lifecycle-cmd.js
diff --git a/test/lib/npm.js b/test/lib/npm.js
diff --git a/workspaces/arborist/test/fixtures/reify-cases/tap-with-yarn-lock.js b/workspaces/arborist/test/fixtures/reify-cases/tap-with-yarn-lock.js
diff --git a/workspaces/config/lib/definitions/definitions.js b/workspaces/config/lib/definitions/definitions.js
