npmコマンド虎の巻

npm stop

npm stopは、package.jsonのstopに定義されたコマンドを実行するコマンドです。

エイリアスなし

解説

package.jsonのscripts欄のstopに定義したコマンドを実行します。
scripts欄に記載したコマンドを実行するには npm run(npm run-script)を使用しますが、
stopはよく使用するため専用にコマンド化されている感じです。

npm run を使用しても実行できるため、以下はすべて同じ意味です。
・npm stop
・npm run stop
・npm run-script stop

「npm run」は「npm run-script」のエイリアス(別名)です。

構文

(構文)
npm stop [オプション]
【オプション】
オプション説明
-- <オプション>オプションを渡す
(例)-gオプションを渡す→ npm stop -- -g
-hコマンドのヘルプを表示する

サンプル

package.jsonのscript欄のstopに定義してあるコマンドを実行する

(C:\test\my-app\package.json)

{ ・・・省略・・・ "scripts": { "stop": "npm index.js" } ・・・省略・・・ }
C:\test\my-app>npm stop

コマンド「npm index.js」が実行されます

package.jsonのscript欄のstopに定義してあるコマンドに -gオプションを渡してを実行する

(C:\test\my-app\package.json)

{ ・・・省略・・・ "scripts": { "stop": "npm ls" } ・・・省略・・・ }
C:\test\my-app>npm stop -- -g

コマンド「npm ls -g」が実行されます

npm stopコマンドのヘルプを表示する

npm stop -h

備考

  • package.jsonの scripts欄の stopには、パッケージの実行を停止するためのコマンドを定義することが通例です。

関連項目

  • npm run-script:任意のコマンドを実行する
  • npm start:package.jsonのstartに定義されたコマンドを実行する
  • npm stop:package.jsonのstopに定義されたコマンドを実行する
  • npm test:package.jsonのtestに定義されたコマンドを実行する