演習 - package.json を構成する

完了

あなたは Tailwind Traders の Node.js 開発者です。 新しい Node.js プロジェクトをセットアップする方法を知っておくことは、重要なスキルです。 セットアップには、package.json ファイルの生成と、このプロジェクトのライフサイクル全体で使用するいくつかの一般的なスクリプトの作成が含まれます。

開発コンテナーでプロジェクトを開く

シンプルな開発環境が提供されています。 既に Node.js LTS がご利用のコンピューター上にインストールされている場合は、このセクションをスキップしてサンプル リポジトリを複製し、ご自身のローカル環境を使用することができます。

  1. MicrosoftDocs/node-essentials GitHub リポジトリの main ブランチに新しい GitHub Codespace を作成するプロセスを開始します。

  2. [codespace の作成] ページで、codespace の構成設定を確認した後に、[新しい codespace の作成] を選択します

    Screenshot of the confirmation screen before creating a new codespace.

  3. Codespace が起動するまで待ちます。 この起動プロセスには数分かかることがあります。

  4. codespace で新しいターミナルを開きます。

    ヒント

    メイン メニューを使用して [ターミナル] メニュー オプションに移動し、[新しいターミナル] オプションを選択できます。

    Screenshot of the codespaces menu option to open a new terminal.

  5. .Node.js が環境にインストールされていることを確認します。

    node --version
    

    開発コンテナーでは、v20.5.1 などの Node.js LTS バージョンが使用されます。 正確なバージョンは異なっている場合があります。

  6. このプロジェクトの残りの演習は、この開発コンテナーのコンテキストで行われます。

新しい Node.js プロジェクトをセットアップする

このユニット用に、JavaScript ソース コードが提供されています。 あなたの作業は、package.json ファイルを作成することです。

  1. ターミナル内で、この演習用のフォルダーに移動します。

    cd node-dependencies/3-exercise-package-json
    
  2. フォルダーの内容を確認します。

    ls -R
    

    このフォルダーには、1 つの index.js ファイルを含む src サブフォルダーが表示されています。

     ./src:
         index.js
    
  3. 次のコマンドを実行して、既定値で package.json ファイルを作成します。

    npm init -y
    

    その package.json ファイルは、この例のようになります。

    {
      "name": "3-exercise-package-json",
      "version": "1.0.0",
      "description": "",
      "main": "index.js",
      "scripts": {
        "test": "echo \"Error: no test specified\" && exit 1"
      },
      "keywords": [],
      "author": "",
      "license": "ISC"
    }
    
  4. これらのプロパティ値を使用して package.json を変更します。

    • name: "tailwind-trader-api"
    • description: "Tailwind Traders データベースからアイテムを管理する HTTP API"
    • main: "index.js"
    • keywords: ["API", "database"]
    • author: "Sam"

    package.json ファイルは、次のコードのようになっているはずです。

    {
      "name": "tailwind-trader-api",
      "version": "1.0.0",
      "description": "HTTP API to manage items from the Tailwind Traders database",
      "main": "index.js",
      "dependencies": {},
      "devDependencies": {},
      "scripts": {
        "test": "echo \"Error: no test specified\" && exit 1"
      },
      "keywords": ["api", "database"],
      "author": "Sam",
      "license": "ISC"
    }
    
  5. scripts セクション内で、test スクリプトの上部に、start という名前の新しいスクリプトを追加します。

    "start": "node ./src/index.js",
    
  6. 変更を保存して、package.json ファイルを保存します。

  7. このコマンドを入力して、start アクションでプロジェクトを開始します。

    npm start
    

    次のように出力されます。

    Welcome to this application
    

これで、このプロジェクトの拡大に合わせて構築することができる、優れた package.json ファイルができました。