Visual Studio Codeのlaunch.jsonファイルに環境変数を直接記述

Visual Studio Codeのlaunch.jsonに環境変数を追加する方法

Visual Studio Code（VSCode）のlaunch.jsonファイルは、デバッグプロセスの設定を保存するために使用されます。このファイルには、デバッガがどのようにプログラムを実行するかを指示する様々なオプションが含まれています。 launch.jsonに環境変数を追加することで、デバッグ時にプログラムで使用できる変数を設定することができます。

手順

1. launch.jsonファイルを開く:

   • VSCodeで、デバッグしたいプロジェクトを開きます。
   • [Ctrl + Shift + P]（Windows、Linux）または [Cmd + Shift + P]（Mac）を押してコマンドパレットを開きます。
   • **「Launch.jsonを開く」**と入力し、Enterキーを押します。
   • 既存のlaunch.jsonファイルを選択するか、新しいファイルを作成します。

2. envプロパティを追加する:

   • 例：

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "My Debug Configuration",
      "type": "node",
      "script": "index.js",
      "env": {
        "MY_ENV_VAR": "my value"
      }
    }
  ]
}

* 上記の例では、**MY_ENV_VAR**という名前の環境変数が "my value" という値で設定されます。

1. launch.jsonファイルを保存する:

補足

• 複数の環境変数を設定するには、envプロパティ内にカンマ区切りのキーと値のペアを追加します。
• 環境変数の値にスペースが含まれている場合は、値を二重引用符で囲む必要があります。

例

以下の例は、Node.jsアプリケーションをデバッグする場合に、launch.jsonファイルに環境変数を追加する方法を示しています。

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "My Node.js Debug Configuration",
      "type": "node",
      "script": "index.js",
      "env": {
        "NODE_ENV": "development",
        "API_KEY": "my-secret-api-key"
      }
    }
  ]
}

この例では、NODE_ENVという名前の環境変数が "development" という値で設定され、API_KEYという名前の環境変数が "my-secret-api-key" という値で設定されます。

launch.json

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "My Node.js Debug Configuration",
      "type": "node",
      "script": "index.js",
      "env": {
        "NODE_ENV": "development",
        "API_KEY": "my-secret-api-key"
      }
    }
  ]
}

index.js

const express = require('express');
const app = express();

const port = process.env.PORT || 3000;
const apiKey = process.env.API_KEY;

app.get('/', (req, res) => {
  if (apiKey !== 'my-secret-api-key') {
    res.status(401).send('Unauthorized');
    return;
  }

  res.send('Hello, World!');
});

app.listen(port, () => {
  console.log(`Server listening on port ${port}`);
});

このコードを実行するには、以下の手順を実行します。

1. 上記のコードを2つのファイル（launch.jsonとindex.js）に保存します。
2. VSCodeで、index.jsファイルを含むプロジェクトを開きます。
3. [F5] キーを押して、デバッグを開始します。

デバッガーが起動すると、index.jsファイルが実行されます。NODE_ENV環境変数が "development" に設定されているため、アプリケーションは開発モードで実行されます。API_KEY環境変数が "my-secret-api-key" に設定されているため、APIキーが正しい場合は、/ エンドポイントへのリクエストが成功します。

このサンプルコードは、launch.jsonファイルに環境変数を追加して、デバッグ時にプログラムで使用できる変数を設定する方法を示すためのものです。

Visual Studio Code の launch.json に環境変数を追加するその他の方法

ワークスペース設定を使用して、すべてのデバッグ構成に適用される環境変数を設定できます。これにより、個々の構成ごとに環境変数を設定する必要がなくなります。

手順は以下の通りです。

1. [Code] > [設定] を開きます。
2. [検索] フィールドに 「launch.json」 と入力します。
3. 「Launch JSON 構成」 設定を選択します。
4. "env" プロパティを見つけ、設定したい環境変数を追加します。
5. VSCodeを再起動します。

例:

{
  "launch.json": {
    "env": {
      "MY_ENV_VAR": "my value"
    }
  }
}

コマンドライン引数を使用する:

デバッガを起動する際に、コマンドライン引数を使用して環境変数を設定することができます。これは、一時的に環境変数を設定したい場合に役立ちます。

1. [ターミナル] を開きます。
2. 以下のコマンドを実行します。

code <path-to-project> --debug --args <env-var-name>=<env-var-value>

code c:\my-project --debug --args MY_ENV_VAR=my value

拡張機能を使用する:

launch.json ファイルに環境変数を追加するのに役立つ拡張機能がいくつかあります。これらの拡張機能は、追加の設定や機能を提供することがあります。

これらの方法は、個々のニーズや好みに合わせて使用することができます。

• 上記の方法を組み合わせることもできます。