読者です 読者をやめる 読者になる 読者になる

miyabihitoの日記

個人的な技術メモ

npm

npm

Node.jsのパッケージ管理ツール
パッケージの検索・インストールや作成したパッケージのレジストリへの登録が行える。

設定には、デフォルトやユーザ設定ファイル、環境変数(NPM_CONFIG_XXX)が使用されるが、 コマンド実行時に、「--key val」で上書く事が出来る。

パッケージの検索(npm search)

引数に指定したワードで、パッケージをレジストリから検索する。

パッケージの情報取得(npm view)

引数に指定したパッケージに関する情報を表示する。
第2引数に表示する情報を指定できる。

インストール(npm install)

  • --production: package.jsonを使って実行するとき、このオプションなしだと、package.json記載の依存パッケージは全てインストールしてしまうが、付けて実行することにより、devDependenciesのパッケージはインストールされない。

以下のいずれかのオプションの付与で、インストール時にpackage.jsonに依存パッケージとして登録できる。

  • --save: dependenciesに登録される。
  • --save-dev: devDependenciesに登録される。
  • --save-optional: optionalDependenciesに登録される。

インストール済みパッケージの確認(npm list/ls)

listの代わりに、ll, laを使うと、--longオプション付きとして実行される。

インストール済みパッケージの更新(npm update)

latest(レジストリにアップロードすると当てられるタグ)のバージョンにパッケージをアップデートする。

インストール済みパッケージの削除(npm rm/uninstall, npm prune)

  • rm/uninstall

    指定したパッケージの削除

    • --save, --save-dev, --save-optional

      package.jsonの依存パッケージの記載からも削除

  • prune

    package.json記載の依存パッケージではないものを削除する。

    • --production

      devDependenciesのパッケージも削除対象とするオプション。

パッケージスクリプトの実行

package.jsonのscriptsで指定されているスクリプトを実行する。
run-scriptは、任意のスクリプトコマンドを指定できる。

  • npm test
  • npm start
  • npm stop
  • npm restart
  • npm run-script

設定関連(npm config)

set, get, delete, list, edit で、npmの設定を操作・閲覧できる。
「npm config ls -l」で、デフォルトの設定値を確認することが出来る。

package.jsonの作成(npm init)

対話的なコマンド実行により、package.jsonファイルを生成できる。

コマンド入力補完(npm completion)

「. <(npm completion)」を、.bashrc等に記載しておけば、npmのコマンド入力がタブ入力で補完される。

その他