package.json を構成する

  • 4 分

npm とパッケージ管理を使用した Node.js プロジェクト マネジメントの世界へようこそ。 パッケージ化の基本事項と、それが開発プロセスを強化するしくみについて学習します。

パッケージ化と Package Management

Node.js の既定のパッケージ マネージャーである NPM は、外部コードをプロジェクトに組み込むための秘密兵器です。 これは、アプリケーションをより迅速かつ効率的に構築するのに役立つ個人アシスタントを持つようなものです。

パッケージ化は、配布用にコードをギフトラッピングするようなものです。 他のユーザーが簡単にインストールして使用できるパッケージに、コードとその依存関係がきちんとバンドルされます。 パッケージ管理は、これらのパッケージを処理する技術であり、次のものが含まれます。

  • package.json ファイル。プロジェクトのブループリントです。 プロジェクトに関するメタデータがパックされており、依存関係とパッケージ ファイルの管理も行います。
  • npm CLI ツール。npm レジストリからパッケージをインストールおよび管理するあなたの便利屋的存在です。
  • npm レジストリは、プロジェクトですぐに使用できるパブリック パッケージの宝庫です。

package.json を作成する

package.json の作成は、npm init コマンドを実行するのと同じくらい簡単です。 これを行う方法は 2 つあります。

  • npm init:このコマンドはフレンドリーなガイドのようなもので、プロジェクトの名前、バージョン、説明などの詳細を尋ねる段階的なプロセスを案内します。
  • npm init -y:このコマンドは、npm init の特急バージョンです。 質問を素早く通過し、既定値を入力してくれます。

生成する package.json ファイルのリストを次に示します。

{
  "name": "my project",
  "version": "1.0.0",
  "description": "",
  "main": "script.js",
  "dependencies": {},
  "devDependencies": {},
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

package.json ファイル領域について

この package.json ファイルを、プロジェクトに輝きを与える貴重な宝石で満たされた宝箱と考えてください。 これらの宝石は package.json ファイル内のプロパティであり、次の 3 つのメインカテゴリに分類されます。

  • Meta-information:これらのプロパティは、王冠の宝石のようなもので、プロジェクトに関するメタ情報を定義します。 これには、プロジェクト名、説明、作成者、キーワードなどが含まれます。
  • 依存関係:これらは、プロジェクトで使用するパッケージを表す金と銀のコインです。 dependencies と devDependencies のプロパティは、これらの宝物を保持しています。 さらに進むと、これらのプロパティを使用して依存関係をインストール、更新、管理する方法について学びます。
  • スクリプト:これらは、プロジェクト タスクを実行するためのターミナル コマンドです。 開始、ビルド、テスト、リンティングなどのタスクのスクリプトを一覧表示できます。

スクリプトを使用してタスクを迅速化する

package.json ファイルには、少なくとも 4 つの共通スクリプトを含める必要があります。

  • start:このスクリプトにより、プロジェクトが実現されます。 たとえば、コマンド node ./src/index.jsを使用する場合があります。
  • build:このスクリプトにより、プロジェクトのグランド デビューが準備されます。 たとえば、TypeScript を JavaScript に変換する場合があります。
  • test:このスクリプトは、通常はテスト パッケージを使用して、プロジェクトの正常性をチェックします。
  • lint:このスクリプトでは、ESLint などのツールを使用して、コードのスタイルと書式設定の問題が確認されて、コードが整えられます。

これらのスクリプト名は魔法の言葉のようなもので、開発者コミュニティで広く認識されており、プロジェクトを整理するために不可欠です。

スクリプト名を標準化する

package.json ファイルでは、スクリプトはアクションとコマンドで定義されます。

"scripts" : {
  "<action>" : "<command>"
}

次に例を示します。

"scripts" : {
  "start" : "node ./dist/index.js",
  "test": "jest",
  "build": "tsc",
  "lint": "eslint"
}

[スクリプトの実行]

ターミナルでスクリプトを実行するには、コマンド npm run <action> を入力します。 たとえば、npm run lint のようにします。

start と test アクションは "特別" で、コマンド内の単語 run を省略できます。 npm run start コマンドを入力する代わりに、npm start と入力できます。

定義済みの開発環境を使用する

このトレーニング モジュールは、ブラウザーまたはローカル コンピューター用の開発コンテナーを提供します。 このコンテナーには必要なすべての環境が用意されているため、IDE または Node.js をインストールしなくてもこのトレーニング モジュールを使用できます。 このトレーニング モジュールを完了するために、コンテナーについては何も知る必要はありません。