npm

2021-11-14 (日) 12:02:55

npm

npm とは

インストールの種類

  • グローバルインストール
    • パッケージのインストール先:npmディレクトリ配下のnode_modules
    • インストールしたパッケージの利用範囲:全てのプロジェクト
  • ローカルインストール
    • パッケージのインストール先:プロジェクトのディレクトリ配下のnode_modules
    • インストールしたパッケージの利用範囲:対象のプロジェクト

コマンド

  • npmのヘルプ
    npm help
    npm help <command>

npm 本体の操作

  • バージョンを確認
    npm --version
    npm -v
  • npmのアップデート
    npm i npm
    npm i -g npm
    npm rebuild

プロジェクトの管理

  • 初期化
    • プロジェクトのディレクトリ配下で実行する
    • package.json が作成される
      npm init
      npm init -yes
      npm init -y
  • パッケージの復元
    • プロジェクトのディレクトリ配下のpackage.json に記載されているパッケージをインストールする
      npm install

パッケージの管理

  • パッケージのインストール
    • ローカルインストール
      • プロジェクトのディレクトリ配下で実行する
        npm install <package-name>
        npm i <package-name>
        npm i <package-name>@<version-name> ※バージョンの指定
  • グローバルインストール
    npm i -g <package-name> ※全体
  • インストール済のパッケージの確認
    npm list ※カレントディレクトリ内
    npm list -g ※デバイス内全体
  • パッケージのバージョンを確認
    npm list --depth=0
    npm list --depth=0 -g
  • リリースされているパッケージのバージョン一覧を確認
    npm info <package-name> versions
  • パッケージのアンインストール
    npm uninstall <package-name>
    npm un <package-name>
    npm un -g <package-name>
  • パッケージのアップデート
    • アップデートされていないパッケージを確認する
      npm outdated
  • package.json に記載されているバージョンにアップデートする
    npm update
    npm up

その他

  • テストを実行
    npm t
  • インストールしたモジュールの確認
    npm ls

package.json

  • パッケージ定義ファイル
  • インストールするパッケージとパッケージのバージョン情報を一元管理する
  • 当ファイルを使って対象パッケージをインストールすることができる
  • 依存関係
    • 公開向けに必要なパッケージ (dependencies)
      • インストール時に(--save オプション)を指定して追記する
        npm i --save <package-name>
      • 依存関係を削除する
        npm un --save <package-name>
  • 開発向けに必要なパッケージ (devDependencies)
    • インストール時に(--save-dev オプション)を指定して追記する
      npm i --save-dev <package-name>
    • 依存関係を削除する
      npm un --save-dev <package-name>

関連用語