【初心者向け】npmについてよく知らない人のための教科書 ~npm installは何をおこなっているのか~

はじめに

対象はnpmを学習し始めた人、npmへの理解が浅い人となります。
本記事は、npm(node package manager)に苦手意識があった筆者が克服するために勉強した備忘録です。

開発環境

• Apple M1
  • Big Sur 11.6
• Node.js
  • 16.13.0
• npm
  • 8.1.0

npmとは

こちらについては、【初心者向け】NPMとpackage.jsonを概念的に理解するをお読みください。
「パッケージとは何か」や「package.jsonとpackage-lock.jsonの違い」など、とても理解がしやすいようにまとめられております。
いつかこんな素敵な記事を書いてみたいです。

npm installとは

• パッケージをインストールするコマンドです。
• package.jsonのdependenciesとdevDependenciesに書かれているパッケージをインストールする
• npm installのエイリアスは、

npm i
または
npm add

です。
まれにエイリアスを使って、解説している記事があり、「このコマンド初めて見たかも？」と思ったものはエイリアスの可能性が高いです。
また、公式を見てみると、他のコマンドにもエイリアスがたくさんあることがわかります。

dependenciesとは

• 本番環境で必要なパッケージが書かれている
• dependenciesにパッケージを追加したいときは、

npm install <package-name> --save-prod
--save-prodを、-Pとしても可能

であるが、「--save-prod」はデフォルトなため

npm install <package-name>

と、「--save-prod」を省略できます。

devDependenciesとは

• 開発環境やテストに必要なパッケージが書かれている
• devDependenciesにパッケージを追加したいときは

npm install <package-name> --save-dev
--save-devを、-Dとしても可能

さいごに

わからないことがあった時に、Qiitaやドキュメント以外の記事を漁るクセなおしたい。
まず最初に目を通すべきは、やはりドキュメントですね！

参考・おすすめ記事

• 「『package.json』って何？って時に少し調べた時のノート」
  • https://overworker.hatenablog.jp/entry/2020/09/27/232236
• 「package-lock.jsonってなに？」
  • https://qiita.com/sugurutakahashi12345/items/1f6bb7a372b8263500e5
• 「package.json のチルダ(~) とキャレット(^)」
  • https://qiita.com/sotarok/items/4ebd4cfedab186355867
• 「【いまさらですが】package.jsonのdependenciesとdevDependencies」
  • https://qiita.com/chihiro/items/ca1529f9b3d016af53ec
• 「npmパッケージのvulnerability対応フロー」
  • https://qiita.com/riversun/items/7f1679509f38b1ae8adb