npm init
npm initは、package.jsonファイルを作成するコマンドです。
エイリアスcreate、innit
解説
package.jsonファイルはプロジェクトに関する設定が記されたファイルです。
npm initコマンドは、プロジェクトフォルダに移動してから実行します。
npm initを実行した後にプロンプトで様々な設定値を入力するとファイルが完成します。
すべてデフォルト値でpackage.jsonファイルを作成したい場合は、-yオプションを指定します。
構文
- （構文）
- npm init [オプション] npm create [オプション] npm innit [オプション]
init、create、innit どれを使用しても実行結果は同じです。
| オプション | 説明 |
|---|---|
| -y --yes --force | 値はすべてデフォルト値で作成する |
| --scope=名称 | パッケージ名にスコープを付ける（パッケージ名=myapp） （例）--scope=hoge → @hoge/myapp |
| -h --help | コマンドのヘルプを表示する |
サンプル
C:\myappフォルダに package.jsonファイルを作成する
C:\myapp>npm init
...（省略）...
Press ^C at any time to quit.
package name: (work)
version: (1.0.0)
description:
git repository:
author:
license: (ISC)
...（省略）...
それぞれ値を入力してEnterを押します。
デフォルト値で構わない場合は何も入力せずEnterを押します。
すべてデフォルト値でpackage.jsonファイルを作成する
C:\myapp>npm init -y
Wrote to C:\myapp\package.json:
{
"name": "work",
"version": "1.0.0",
"description": "",
"main": "index.js",
"directories": {
"test": "test"
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC"
}
npm initコマンドのヘルプを表示する
C:\>npm init -h
備考
- npm init、npm create どちらも実行結果は同じです。
（npm createは npm initのエイリアスです。）
関連項目
- npm install：パッケージをインストールする
