初心者向けnpm initコマンドの使い方【入門】

Web開発でJavaScriptを使う場合、必要なライブラリやモジュールを管理するためにnpmというツールがよく使われます。

npmを使ってライブラリをインストールする前に、プロジェクトを初期化する必要があります。そのためのコマンドがnpm initです。

この記事では、npm initコマンドの使い方を、初心者でもわかりやすく解説します。

この記事でわかること

npm initコマンドの操作手順

1 npm initコマンドを実行する
2 項目内容
3 まとめ
4 投稿者

npm initコマンドを実行する

まず、プロジェクトフォルダに移動し、以下のコマンドを実行します。

その後、項目内容に沿って入力していきます。

npm init

項目内容

項目内容は、プロジェクト名、バージョン、作者、ライセンスなどに関するものです。

必須項目

プロジェクト名 (package name): プロジェクトの名前を入力します。
バージョン (version): プロジェクトのバージョンを入力します。
説明 (description): プロジェクトの説明を入力します。
エントリーポイント (main): アプリケーションのメインファイルパスを入力します。
著者 (author): プロジェクトの作者の名前を入力します。
ライセンス (license): プロジェクトのライセンスを選択します。

任意項目

キーワード (keywords): プロジェクトに関連するキーワードを入力します。
リポジトリ (repository): プロジェクトのリポジトリURLを入力します。
バグトラッカー (bugs): バグトラッカーのURLを入力します。
ホームページ (homepage): プロジェクトのホームページURLを入力します。

package.jsonファイル

項目の入力を終えると、package.jsonファイルが作成されます。

package.jsonファイルには、プロジェクトに関する情報がJSON形式で記述されています。

JSON

{
"name": "my-project",
"version": "1.0.0",
"description": "My awesome project",
"main": "index.js",
"author": "Bard",
"license": "MIT",
"keywords": ["javascript", "node", "npm"],
"repository": {
"type": "git",
"url": "https://github.com/bard/my-project.git"
},
"bugs": {
"url": "https://github.com/bard/my-project/issues"
},
"homepage": "https://bard.ai/"
}

【例】

以下は、実際にnpm initコマンドを実行した例です。

$ npm init

package name: (my-project)
version: (1.0.0)
description: My awesome project
entry point: (index.js)
author: Bard
license: (MIT)
About to write to /Users/bard/my-project/package.json: