目次
この記事でわかること
- package.jsonの役割と、なぜ必要なのか
- ファイルの中身の構成と各フィールドの意味
- 初心者が押さえておきたい基本ポイント
はじめに
「npm installは使ったことあるけど、package.jsonって何のためにあるの?」 「触らずに放置してるけど、実は重要?」
そんな疑問を持っているNode.jsビギナーさんに向けて、今回は package.json
の基本をわかりやすく紹介します。
package.jsonってなに?
package.json
は、Node.jsのプロジェクトにおける設定ファイルです。 言い換えれば、プロジェクトの「取扱説明書」。
主に以下のような役割を持っています:
- プロジェクトの名前やバージョンなどの基本情報の管理
- 使っているライブラリ(依存関係)を一覧で記録
npm run
で使うスクリプトの定義
このファイルがあるおかげで、他の人がプロジェクトをクローンしても、 npm install
一発で必要なパッケージが揃うんです。
基本構成とよく使うフィールド
以下はシンプルな package.json
の例です:
{
"name": "my-app",
"version": "1.0.0",
"description": "これはサンプルのアプリです",
"main": "index.js",
"scripts": {
"start": "node index.js"
},
"dependencies": {
"express": "^4.18.2"
},
"devDependencies": {
"nodemon": "^3.0.1"
}
}
フィールド名 | 役割 |
---|---|
name | プロジェクト名(英小文字・記号なし) |
version | バージョン番号 |
description | 簡単な説明 |
main | アプリのエントリポイント(=最初に読み込むJS) |
scripts | npm run で実行できるスクリプト群 |
dependencies | 本番環境で必要なライブラリ |
devDependencies | 開発時にのみ使うライブラリ(例:テスト、linter等) |
よくある疑問(FAQ)
Q. package.jsonは手で書くの?
A. 手書きもできますが、 npm init
コマンドで自動生成できます!
Q. dependenciesとdevDependenciesの違いは?
A. 本番に必要かどうか。ビルド・テスト系はdevDependencies。
Q. スクリプトって複数書ける?
A. もちろんOK。start、build、test、lint など用途に応じて定義しましょう。
まとめ
package.json
はNode.jsプロジェクトの「設定ファイル」- プロジェクト情報やライブラリ、スクリプトを管理する
npm init
で簡単に作れるので、まずは中身を見てみよう!
コメント