はじめに
対象は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』って何？って時に少し調べた時のノート」
- 「package-lock.jsonってなに？」
- 「package.json のチルダ(~) とキャレット(^)」
- 「【いまさらですが】package.jsonのdependenciesとdevDependencies」
- 「npmパッケージのvulnerability対応フロー」