初期化処理を行う!npm initの使い方【初心者向け】

初心者向けにnpm initの使い方について解説しています。npm initで初期化処理を行い、package.jsonを生成する流れを説明しています。コマンドの使い方と実際に使う例を分かりやすく紹介しているので、実際に書きながら覚えていきましょう。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

今回はnpm initについて解説します。

npm initでpackage.jsonを生成する流れを実際にコマンドを入力しながら説明しているので、ご自身でも行いながら理解していきましょう。

Node.jsとは何か説明した記事もあるので、ぜひチェックしてみてください。

 

なお本記事は、TechAcademyのNode.jsオンライン講座の内容をもとに作成しています。

 

田島悠介

今回はnpm initを勉強するよ。必ず使うことになる重要なコマンドなので覚えておこう。

大石ゆかり

田島メンター!npm initというのはどういうコマンドですか〜?

田島悠介

これはpackage.jsonというファイルを設定・作成するものだよ。実際にやってみながら見ていこうか。

大石ゆかり

了解です!

npm initとは

npm initとは、npmをインストールした後最初に使用する初期化処理を意味するコマンドです。

initとは、initializeの省略で、初期化を意味します。初期化処理を行うことで、package.jsonが生成されます。

package.jsonはjson形式で記載されたインストールしたパッケージを管理するための目録のような情報です。

この情報を最初に初期化して、インストールや環境設定をするたびにきちんと目録を更新させることで、正しくnpmを使用することができます。

その為、実務上でもnpm initはプロジェクト開始時などに必ず使用します。

npmとはについて解説している記事もあるので、合わせてご覧ください。

 

npm initの使い方

コマンド

npn init

 

表示結果

 

解説

今回はsampleというディレクトリ(フォルダ)でnpm initを実行しています。

このことで、sampleというディレクトリで初期化処理を行います。

最後の行にpackage name: (a) とありますが、この時点でコンピューターと対話しながらパッケージ目録であるpackage.jsonに記載する内容を生成していきます。

 

田島悠介

まずはnpm initと入力してリターンキーを押してみよう。

大石ゆかり

実行しましたが、何か項目が出てきてそこで止まってしまいましたね。

田島悠介

ここで必要な情報を入力していくんだ。各項目の役割について解説するよ。

[PR] Node.jsで挫折しない学習方法を動画で公開中

npm initを実際に使用してpackage.jsonを生成してみよう

コマンド

package name: (a) sample
version: (1.0.0) 0.0.0
description:
entry point: (index.js)
test command:
git repository:
keywords:
author: techacademy
license: (ISC)

 

表示結果

 

解説

全てのコマンドに共通して言えることは、対話型のコマンドの場合、最初にコンピューターが何かしらの質問をしてきて、それに回答するという方式でコマンド入力していきます。

回答しない場合は、エンターキーを押すことで、( )内にコンピューターが指定してきた情報のまま生成する場合や、( )の表示がない場合には無記載で生成する事になります。

解答せずエンターキーを押し続けることでもpackage.jsonは生成されますし、それ自体何も問題になることではありませんので、初回は全てエンターキーを安心して押して下さい。

 

1行目のpackage name: (a) sampleでは、package name: (a)が最初にコンピューターが表示した状態に対し、sampleという部分を追加で入力しています。

ここではパッケージの名前をsampleにしました。

2行目version: (1.0.0) 0.0.0では、コンピューターからversion: (1.0.0) というバージョンで生成するかと尋ねられていることに対して、0.0.0というバージョンにすると回答しました。

3行目のdescription:ではそのままエンターを押すことで、descriptionつまり概要説明は無記載にしました。

4行目のentry point: (index.js)でもそのままエンターを押すことで、初期表示させるファイルをindex.jsファイルのままにしています。

5行目test command:でもエンターを押すことでテストコマンドを無しにする設定にしています。

6行目のgit repository:でもエンターを押すことで、Github等に保存するリポジトリ情報は初期状態では登録しない設定にしています。

7行目のkeywords:では、npm公開時等で使用されるキーワードを設定できますが、エンターを押すことで、設定せずに進みます。

8行目のauthor: techacademyでは、npm公開時に必要とされる作者情報を設定できます。今回はtechacademyと記載しました。

9行目のlicense: (ISC)はnpm公開時に適用する権利情報を記載します。今回は標準のISCというライセンス表示にします。

 

package.jsonを生成する確認

先程の対話型コマンドに最後まで回答すると次の画面になります。

最後の行にあるIs this ok? (yes) の部分でエンターキーを押すことで同意して、package.jsonを生成することができます。

 

npm initで生成したpackage.jsonをメモ帳で開いた表示

先程対話型コマンドで生成したpackage.jsonが生成されていることが確認できました。

 

今回はnpm initについて解説しました。

初期化処理を行う際にぜひ参考にしてみてください。

Node.jsの学習サイトもまとめているので、合わせて参考にしてみてください。

 

田島悠介

それぞれの情報の意味と入力例だよ。

大石ゆかり

ここで入力した内容が、package.jsonに反映されるわけですね。

田島悠介

そうだね。とりあえずpackage.jsonを作成したい場合は全てエンターキーで進めてみよう。終わったら実際にファイルが作成されているか確認してみるといいよ。

大石ゆかり

分かりました、やってみます。ありがとうございました!

また、オンラインのプログラミングスクールTechAcademyでは、Node.jsオンライン講座を開催しています。

Node.jsを使ってWebアプリケーションを開発することができます。

現役エンジニアがパーソナルメンターとして受講生に1人ずつつき、マンツーマンのメンタリングで学習をサポートし、最短4週間で習得することが可能です。