npm runコマンドとnpxコマンドの使い方

管理者

4年前

npm runコマンド (npm srcipts)とは？

Node.jsをインストールすると、npm run xxxで任意のコマンドを実行できるようになる。
これはnpm scriptsと呼ばれ、任意のコマンドのショートカット（エイリアス）を定義することができる機能である。

package.jsonのscriptsに実行したいコマンドを定義する。
例えば、以下のように定義するとnpm run nowでdateコマンドが実行できるようになる。
※package.jsonが格納されているディレクトリに移動してから実行

{
  "scripts": {
    "now": "date"
  }
}

npm-scriptsの実行時にコマンドオプションを指定したい場合は、--の後ろにオプションを指定する。
以下の定義であれば、npm run now -- -uとnpm run utcはどちらもdate -uコマンドが実行される。

{
  "scripts": {
    "now": "date",
    "utc": "date -u"
  }
}

名前がstart, stop, restart, testの場合はrunを省略して実行することができる。
例えば、npm run startはnpm startだけで実行することができる。

以下の定義であれば、npm testでdateコマンドが実行される。

{
  "scripts": {
    "test": "date"
  }
}

npmやyarnでインストールしたパッケージを実行するためのコマンド。
npxコマンドを使わない場合は./node_modules/.bin/xxxで実行する必要があるが、npxコマンドを使うとnpx xxxだけで実行することができる。

例えば、webpackというパッケージをnpm install webpackでインストールをした場合、./node_modules/.bin/webpackをnpx webpackだけで実行することができる。

インストールされていないパッケージをnpxコマンドで指定した場合、パッケージをインストールしてから実行される。
実行後にパッケージは破棄される。