JavaScript

npmでライブラリをインストールする方法【Node.JS】

どうも、つよぽんです!

今回は、npmを使ってライブラリをインストールする方法について解説します。

「npm」はNode.jsをインストールすると使えるようになるターミナルのコマンドになります。

Node.jsのインストール方法は、以前書いた記事「Node.JSをインストールする【画像解説付き】」で解説しています。

今回の記事の内容は以下の解説記事でも使っているスライドの内容をさらに詳しく解説したものとなります。

あわせて読みたい
【Node.JS】npmを使ってライブラリをインストールする今回はnpmコマンドを使ってライブラリをインストールする方法を学習します。Node.JSのプロジェクトで依存ライブラリをインストールするときは「npm install」を使います。npm installの使い方も色々と種類があります。その中でも使うことが多いnpm installの方法を解説します。...

今回の記事は次のような方に向けて書きました。

想定読者
  1. npmコマンドを使って、ライブラリをインストールする方法を知りたい
  2. package.jsonのdependenciesとdevDependenciesに依存ライブラリを追記する方法を知りたい
  3. package.jsonに記述されている依存ライブラリを一気にインストールする方法を知りたい

この記事を読み終えた後のあなたは次のことがわかるようになっています。

この記事を読み終えた後のあなた
  • npmコマンドを使ってライブラリをインストール出来るようになる
  • ライブラリをインストールする時に、自動でpackage.jsonの「dependencies」「devDependencies」に依存ライブラリ情報を追記できるようになる
  • package.jsonの「dependencies」「devDependencies」の情報を使って、依存ライブラリを一気にインストール出来るようになる

それでは以下の内容で話を進めていきます。

今回の内容
  1. ライブラリインストール前の作業 : package.jsonを作る
  2. npmコマンドを使ってライブラリをインストールする方法
  3. package.jsonの情報を使って依存ライブラリを一気にインストールする

「npm init」で package.jsonを作る(インストール前作業)

npmコマンドを使ってライブラリをインストールする前に、「package.json」を事前に作成するのが一般的です。

package.jsonが存在するディレクトリ内で、npmコマンドを使ってライブラリをインストールすると、インストールしたライブラリ情報をpackage.json内の「dependencies」と「devDependencies」のプロパティに自動で記録してきます。

「package.json」の作り方は、以前書いた記事「【Node.js】package.jsonの作り方と役割」を参考にしていただけたらと思います。

「npm install」で使ってライブラリをインストールする

npmコマンドを使ってライブラリをインストールするには「npm install」を使います。

package.jsonを作成したばかりで、まだ何もライブラリをインストールしていないときのpackage.jsonの内容は以下の画像のような感じになっているかと思います。(※画像をクリックすると別タブで画像が開きます)

ライブラリをインストールする前のpackage.jsonの内容ライブラリをインストールする前のpackage.jsonの内容

それでは、package.jsonの準備が出来たら実際に「npm install」コマンドを使ってライブラリをインストールしていきましょう。

package.jsonのdependenciesに追記しながらライブラリをインストールする方法

まず最初はpackage.jsonの「dependencies」に、インストールするライブラリ情報を記述しながら、ライブラリ本体をインストールする方法を解説します。

dependenciesとは

package.jsonの「dependencies」とは、サービスを動かすのに必要なライブラリ情報を記述するところになります。

例えば、Webサービスを動かすのに「express」というライブラリが必要であれば、「express」は「dependencies」に追記するべきです。

インストール方法

dependenciesに追記しながらライブラリをインストールするには以下のコマンドを使います。

npm install ライブラリ名

もしくは、

npm install -S ライブラリ名

例えば「express」というライブラリを「npm install express」もしくは「npm install -S express」でインストールすると、package.jsonの「dependencies」に「express」の情報が自動で追記されます。(※画像をクリックすると別タブで画像が開きます)

「npm install ライブラリ名」でdependenciesに追記しながらライブラリをnode_modulesディレクトリにインストールする「npm install ライブラリ名」でdependenciesに追記しながらライブラリをnode_modulesディレクトリにインストールする

package.jsonにはインストールしたライブラリ情報が記述されて、ライブラリ本体は「node_modules」ディレクトリに格納されます。

もし、ライブラリインストール時に「node_modules」ディレクトリが無いときは、ライブラリを初めてインストールするタイミングで「node_modules」ディレクトリが自動で作成されます。

package.jsonのdevDependenciesに追記しながらライブラリをインストールする方法

次にpackage.jsonの「devDependencies」に、インストールするライブラリ情報を記述しながら、ライブラリ本体をインストールする方法を解説します。

devDependenciesとは

package.jsonの「devDependencies」とは、サービスを動かすのに直接必要なわけではないが、開発時にあると便利なライブラリ(ツール)を記述するところになります。

例えば、「複数のファイルを1つにまとめるライブラリ」「テストライブラリ」などはWebサービスを動かすのには直接は必要としませんが、開発時に使うツールとなるので「devDependencies」に追記するべきです。

インストール方法

devDependenciesに追記しながらライブラリをインストールするには以下のコマンドを使います。

npm install -D ライブラリ名

例えば「mocha」というライブラリを「npm install -D mocha」でインストールすると、package.jsonの「devDependencies」に「mocha」の情報が自動で追記されます。(※画像をクリックすると別タブで画像が開きます)

「npm install -D ライブラリ名」でdevDependenciesに追記しながらライブラリをnode_modulesディレクトリにインストールする「npm install -D ライブラリ名」でdevDependenciesに追記しながらライブラリをnode_modulesディレクトリにインストールする

「dependencies」の代わりに「devDependencies」にライブラリ情報が追記される以外は、ライブラリ本体のインストール先など、他の挙動は先ほどの「npm install ライブラリ名」と同じになります。

「npm install」でpackage.jsonに記述されている依存ライブラリを一気に全部インストールする

最後に、依存ライブラリを一気にインストールする方法を解説します。

結論から言うと、package.jsonのあるディレクトリで「npm install」コマンドを実行すると、依存ライブラリを一気にインストールできます。
(「npm install ライブラリ名」ではなく、「npm install」だけであっている。)

「npm install」を実行する前の状態(画像)

「npm install」を実行する前の状態「npm install」を実行する前の状態

「npm install」を実行したあとの様子(画像)

「npm install」を実行した後の状態「npm install」を実行した後の状態

どんなときに「npm install」を使うか?

「node_modules」ディレクトリは通常、「.gitignore」を使ってgitのバージョン管理から外します。

理由は、npmでインストールしたライブラリは、そのライブラリの依存ライブラリも一緒に「node_modules」にインストールします。

そのため、「node_modules」ディレクトリはすぐに肥大化します。

この「node_modules」をバージョン管理に含めてしまうと、「git clone」で手元にダウンロードするときにかなりの時間がかかってしまいます。

そこで、「.gitignore」でバージョン管理から除外することで、手元にダウンロードする時間を軽減することできます。

そして、「git clone」などで手元にプロジェクトをダウンロードした後、依存ライブラリを用意する際には「npm install」を実行することで、自分のパソコン上でもサービスが動く状態を作り出せるのです。

まとめ

今回の話をまとめると次のとおりです。

今回のまとめ
  • npmでライブラリをインストールする前には「package.json」を用意する
  • 「npm install ライブラリ名」もしくは「npm install -S ライブラリ名」でdependenciesに追記しながらライブラリをインストールできる
  • 「npm install -D ライブラリ名」でdevDependenciesに追記しながらライブラリをインストールできる
  • 「package.json」に依存ライブラリが記述されている状態で、node_modulesディレクトリが存在しないときは「npm install」で依存ライブラリを一気にインストールできる

今回の内容は以下の記事内のスライドの補足資料として作成しました。スライドの全部を確認したい方は以下の記事も参照して頂けたらと思います。

あわせて読みたい
【Node.JS】npmを使ってライブラリをインストールする今回はnpmコマンドを使ってライブラリをインストールする方法を学習します。Node.JSのプロジェクトで依存ライブラリをインストールするときは「npm install」を使います。npm installの使い方も色々と種類があります。その中でも使うことが多いnpm installの方法を解説します。...
【やる気満々な方向け】学習サポートとオンライン講義やってます!

Webエンジニアになりたい人向けに、MENTAにて『【やる気満々な方向け】未経験からのWebエンジニア育成コース』というプランを用意しております。

このプランでは、主に「【学習コンテンツ】Web開発」を使って学習を進めていただきます。

あわせて読みたい
Web開発Webエンジニアになるために必要な知識・スキルを学習できるコンテンツを用意しました。未経験者でも、①開発環境の準備、②Webの基本的な仕組み、③HTML、④CSS、⑤JavaScriptと順を追って学習することでスキルが身につくことを目的に教材を作成しています。...

誰向けのプラン?

こちらのプランは次のような方に向けて作られています。

プラン対象者
  1. Progateやドットインストールで一通り学習したけど、次に何をすればよいかわからない
  2. Webエンジニアになるまでの学習プランがあると助かる
  3. 学習していてわからないところが出てきたときに質問したい
  4. コードレビューして欲しい
  5. オンライン講義に参加したい
  6. 学習した内容をアウトプットした際に、フィードバックがもらえたら嬉しい
  7. おすすめの学習教材を知りたい
  8. Webフロントエンド・バックエンドを学習したい
  9. フルスタックエンジニアになりたい
  10. 文系出身で今までプログラミングをしてこなかったけど、将来Webエンジニアになりたい
  11. 将来フリーランスになることを目指している

プラン内容は?

【やる気満々な方向け】未経験からのWebエンジニア育成コース』では次のことを行っております。

プラン内容
  1. Web白熱教室の学習コンテンツをメインに、指定した教材を使って学習する (学習プランに沿って学習を進めていただきます。)
  2. 学習コンテンツの課題をこなしたあとは、僕にコードレビュー依頼を投げていただくことで、コードを添削する(課題クリア後は、引き続き学習プランの内容を続けていただきます。)
  3. プラン契約者が参加するSlackグループにて質問し放題
  4. Slack内にある「アウトプットの場」チャンネルにて、学習したことをアウトプットをしていただくことで、それに対しフィードバックをする (学習内容のアウトプットは復習にもなるため、アウトプットすることを強く推奨します。)
  5. 画面共有を使ったオンライン講義 (オンライン講義は録画して、いつでもふり返れるようにしています。(オンライン講義動画(ウェビナー動画)))
  6. 学習プラン以外の内容に対しての質疑応答 (内容によっては回答できないものもありますが、まずは気軽に質問していただけたらと思います。)
  7. 不定期で行うオフラインでの勉強会に参加(僕自身が東京住みのため、東京・もしくは東京近郊で開催します)

その他注意点

1人で対応していることもあるため、対応が難しくなった場合は急遽募集を終了する可能性もあることをご了承ください。

プラン契約者数が35人に達したら値上げする予定です

現在の値段は10000円です。

つまり、「月の飲み会3回くらいの金額」となります。

飲み会に行く代わりに、学習時間を優先すると考えれば自己投資としてはだいぶリーズナブルかと思います。

1日1回、カフェでコーヒー1杯分くらいの値段(約330円)」で以下の環境が手に入るとイメージして頂けたらと思います。

1日330円で手に入る環境
  1. コードを添削してもらえる
  2. 学習したことのアウトプットに対してフィードバックしてもらえる
  3. いつでも質問出来る
  4. 週1のオンライン講義に参加できる
  5. 過去のオンライン講義動画を好きな時間に復習できる(いつでも閲覧可能)
  6. 不定期で行うオフラインでの勉強会に参加できる(僕自身が東京住みのため、東京・もしくは東京近郊で開催します)
  7. 自分の住まいの近場のメンティーさん同士で集まって、オフラインで勉強会を開くのも可能(初めて開催する場合は事前に僕に連絡をいただけたらと思います)

ただ、プラン契約者数が35人に達したら15000円値上げする予定です。
(2019年2月21日現在のプラン契約者数は30人)

値上げする理由は次のとおりです。

値上げ理由
  1. このプランを始めた当初(2018年9月)と比べて、学習コンテンツ(スライド・課題・動画)が充実してきた
  2. このプランに参加していただいているメンティーさんの中から、「Web未経験から学習を初めて2~3ヵ月くらいで案件獲得までこぎつけることができた」という実績ができた
  3. 学習サポート(コードレビューや質疑応答など)を1人で行っており、人数が増えすぎるとサポートに支障が出てくるため、値上げという形で参加ハードルをあげた
    (人数を制限することによりサポートの質を維持するため)

今後も契約者が増えたり、学習コンテンツがさらに充実していった場合は段階的に料金改定させていただく予定です。

契約した時点の金額がずっと継続される

現在、学習プランを提供しているプラットフォームである「MENTA」の性質上、契約した時点の金額は変わることがありません。

つまり、今後プラン料金が15000円20000円と上がったとしても、月々の料金は申し込んだときの料金となるので、10000円のときに契約した場合は、受講中はずっと10000円で受講することができます。

詳しく話を聞いてみたい方は

以下のいずれかでメッセージをいただけたらと思います^^

 

プラン内容については以下のリンク先からも確認することが出来ます^^

【やる気満々な方向け】未経験からのWebエンジニア育成コース

COMMENT

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です