npmコマンド虎の巻

npm test

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

エイリアスt、tst

解説

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

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

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

構文

(構文)
npm test [オプション] npm t [オプション] npm tst [オプション]

npm test、npm t、npm tst どれでも実行結果は同じです。

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

サンプル

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

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

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

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

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

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

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

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

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

npm test -h

備考

  • package.jsonの scripts欄の testには、デバッグで使用するコマンドを定義することが通例です。

関連項目

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