package.jsonは、プロジェクトのレシピのようなものです。
プロジェクトの構成や必要な材料(依存関係)を詳細に記述することで、プロジェクトの構築と管理をスムーズに行うことができるのですが中身を理解していない部分もありましたので確認していきたいと思います。
1. プロジェクトの基礎情報
- name: プロジェクトの名前です。パッケージを公開する際に使われます
- version: プロジェクトのバージョン番号です。semver(Semantic Versioning)と呼ばれるルールに従って、バージョン管理を行います
- description: プロジェクトの説明文です。プロジェクトの内容を簡潔に説明します
2. コマンドライン: scripts
-
scripts: プロジェクトの様々な操作をコマンドラインで実行するための定義です
-
serve: 開発サーバーを起動して、プロジェクトをローカルで確認するためのコマンドです。
npm run serveで実行します -
build: プロジェクトをビルドして、本番環境用のコードを生成するためのコマンドです。
npm run buildで実行します -
lint: コードのスタイルや構文をチェックするコマンドです。
npm run lintで実行します - さらに、独自のスクリプトを追加することも可能です
-
serve: 開発サーバーを起動して、プロジェクトをローカルで確認するためのコマンドです。
3. プロジェクトに必要な材料: dependencies
-
dependencies: プロジェクトの実行に必要なパッケージ(ライブラリ)のリストです
- vue: Vue.jsの本体ライブラリ。Vue.jsの機能をすべて提供します
- vue-router: Vue Routerのライブラリ。Vue.jsアプリケーションのルーティング機能を提供します
- 他の必要なライブラリもここに記述します
4. 開発に必要な材料: devDependencies
-
devDependencies: プロジェクトの開発時に必要なパッケージのリストです
- @vue/cli-service: Vue CLIのコアとなる部分を提供します
- @vue/cli-plugin-babel: Babelのプラグイン。JavaScriptのコードを様々なブラウザで動作するように変換する機能を提供します
- @vue/cli-plugin-eslint: ESLintのプラグイン。コードのスタイルや構文をチェックして、より良いコードを作成するための機能を提供します
- eslint: JavaScriptのコードリンティングツール。コードのエラーや潜在的な問題点を検出します
- eslint-plugin-vue: Vue.js用のESLintプラグイン。Vue.jsのコードのリンティングを行います
- vue-template-compiler: Vue.jsのテンプレートをJavaScriptのコードに変換するコンパイラ
5. プロジェクトの情報: authorとlicense
- author: プロジェクトの作者の名前です
- license: プロジェクトのライセンスです。著作権や利用規約を定めます
package.jsonの使い方
-
インストール:
npm installコマンドでdependenciesとdevDependenciesに記載されたパッケージをインストールします -
実行:
npm run serveやnpm run buildなどのコマンドで、scriptsに定義されたスクリプトを実行します -
バージョン管理: プロジェクトのバージョンアップに合わせて、
versionフィールドを更新しま
まとめ
package.jsonは、プロジェクトを作成する際に自動的に作成されるため中身の理解ができていませんでした。
今回まとめたことにより理解を深めることができました。
プロジェクトの依存関係やスクリプトを正しく定義することで、開発をよりスムーズに行うことができるためしっかりと理解した上で使っていきたいです。