package.jsonは依存するnpmのライブラリの管理やスクリプトの管理を行うための設定ファイルです。
主な設定項目は次のとおりです。
| オプション | 必須 | 説明 |
|---|---|---|
name |
必須 | パッケージ名(公開しない場合も) |
version |
必須 | バージョン情報 |
private |
任意 | 公開するなら記入不要/false、後悔しないならtrueを設定 |
description |
任意 | パッケージの説明。npm searchなどで使う |
keyword |
任意 | 検索ワードを配列で設定。npm searchなどで使う |
homepage |
任意 | プロジェクトのホームページ |
license |
任意 | ライセンス設定。BSD-2-Clause, MIT, SPDXなど |
scripts |
任意 | npm runなどで実行可能なコマンドを設定します |
dependencies |
任意 | プロジェクトが依存するパッケージとバージョンを指定します |
devDependencies |
任意 | プロジェクトの開発で使うパッケージとバージョンを指定します |
😸 dependencies/devDependencies
プロジェクトが依存するライブラリ(パッケージ)を一括でインストールするにはnpm installを使います。
指定したライブラリ・バージョンをまとめてインストールしてくれます。
🐞 script
npm start、npm testのようにあらかじめ決められたコマンドを設定したり、npm run xxxで任意をコマンドを設定できます。
dependenciesやdevDependenciesなどpackage.jsonに設定されている依存モジュールも合わせて読み込こまれます。
{ |
上記の例ではnpm startでPATHが通った状態でgitbook serveを実行できます。npm run eslint:fixではPATHが通った状態でeslint *.js --fixを実行できます。
