マニュアル: npm

Gitの設定(.gitignore)

コマンドを実行するとnode_modulesディレクトリができるが、 これは管理対象外なので、.gitignoreに入れること。 以下のようにgiboを使うと楽。

gibo Node >> .gitignore

コマンド

• npm list, npm ls: インストールされたパッケージをリストにする
• npm uninstall パッケージ名: パッケージをアンインストール

npx

• npm/npx: npm package executor

node_modules/.bin/ の下にバイナリが格納されるんですが、指定するのが面倒なので代わりに使えます。 対話型シェルでは export PATH=$PATH:node_modules/.bin でもいいと思います(コマンドの補完が効くので)

初期化(init)

init | npm Documentation

• 書式
  • 以下のいずれか。
  • npm init オプション
  • npm init <initializer>
    • initializerはnpxというコマンドに渡すようだが、何が指定可能かは調査中。
• オプション
  • --yes: 通常は対話的に行うが、その対話をスキップ

パッケージのリスト(ls, list)

ls | npm Documentation

npm ls
npm ls --depth=0 # 直下のもののみリスト
npm ls -g # グローバルにインストールされているものを表示

インストール(install, i)

install | npm Documentation

• npm install パッケージ名: パッケージをインストール
  • パッケージ名の後に@バージョン番号と入れると、特定のバージョンを入れる。
  • 最新のものを入れたい場合は、 @latest と入れる¹。
• オプション
  • -g: グローバル領域にインストールする。
  • --save: 実行時に必要なモジュールとして、package.jsonに記録
  • --save-dev: 開発時に必要なモジュールとして、package.jsonに記録

アンインストール(uninstall, rm)

uninstall | npm Documentation

npm uninstall パッケージ名
npm uninstall --save パッケージ名
npm uninstall --save-dev パッケージ名
npm uninstall -g パッケージ名

package.json

package.json | npm Documentation

主なパラメータ

• main: require() されたときに呼ばれるエントリポイント。通常はメインスクリプト。
• license(string): ライセンス。
  • SPDX License List | Software Package Data Exchange (SPDX)
  • MITライセンスの場合は MIT と書くとよい。

dependencies

• ドキュメント

• dependencies(object)
  • name(string): パッケージ名。
  • version(string): バージョン。後述。

バージョンの記載方法

• version: バージョンが完全一致
• >version: 指定されたバージョンより上
• >=version: 指定されたバージョン以上
• <version: 指定されたバージョン未満
• <=version: 指定されたバージョン以下
• ~version: 指定されたバージョンとだいたい同じ
• ^version: 指定されたバージョンと互換性がある

scripts

package.jsonに記載する設定で、 よく使うコマンドを登録しておくものです。 (詳細は使っていないのでまだ今度)

例えばwebpackを使う場合、以下のように書くと、 npm run buildで実行できるようになります。

{
  "scripts": {
    "build": "webpack --mode production"
  }
}

公式サイト

• install | npm Documentation
• package.json | npm Documentation
• 05 - Working with package.json | npm Documentation
• scripts | npm Documentation
• package.json | npm Documentation

外部サイト

• npmでnode.jsのpackageを管理する - Qiita
• 今時のフロントエンド開発2017 (3. webpack編) - Qiita

関連項目

• 辞書: npm
• タグ: npm
• マニュアル: yarn