VS Codeで環境変数を設定する方法
VS Code（Visual Studio Code）で開発を進める上で、環境変数の設定は非常に重要です。プロジェクトごとに異なる設定や、機密情報（APIキーなど）をコードに直接埋め込まずに管理するために、環境変数は不可欠な存在となります。VS Codeでは、いくつかの方法で環境変数を設定することができ、それぞれの状況に応じて最適な方法を選択することが可能です。
VS Codeで環境変数を設定する基本的な考え方
環境変数とは、プログラムの実行環境に依存する設定値を外部から与えるための仕組みです。これにより、コードを変更することなく、異なる環境（開発環境、ステージング環境、本番環境など）で異なる設定を適用できます。VS Codeで環境変数を設定する主な目的は以下の通りです。
- APIキーやデータベース接続情報などの機密情報を安全に管理する
- 開発環境と本番環境で異なる設定（例: デバッグモードのON/OFF、ログレベル）を切り替える
- ビルドプロセスやスクリプトの振る舞いを制御する
launch.json を利用した環境変数の設定
VS Codeでデバッグを行う際に最も一般的に利用されるのが、launch.json ファイルを通じた環境変数の設定です。このファイルは、デバッグ構成を定義するために使用され、各デバッグ構成に個別の環境変数を割り当てることができます。
launch.json の作成と編集
launch.json ファイルは、VS Codeのデバッグビュー（左側のアクティビティバーにある虫のアイコン）から「launch.json を作成」を選択することで生成できます。環境に応じて Node.js、Python、JavaScript など、適切な実行環境を選択してください。
生成された launch.json ファイルは、プロジェクトのルートディレクトリにある .vscode フォルダ内に配置されます。このファイルはJSON形式で記述されており、configurations という配列の中に、個々のデバッグ構成を定義します。
launch.json での環境変数設定
各デバッグ構成オブジェクトには、env というプロパティを追加することで、その構成に固有の環境変数を設定できます。env プロパティはキーと値のペアを持つオブジェクトです。
{
"version": "0.2.0",
"configurations": [
{
"name": "Launch Program",
"type": "node",
"request": "launch",
"program": "${workspaceFolder}/app.js",
"env": {
"NODE_ENV": "development",
"API_KEY": "your_development_api_key",
"DATABASE_URL": "mongodb://localhost:27017/myapp_dev"
}
},
{
"name": "Launch Program (Production)",
"type": "node",
"request": "launch",
"program": "${workspaceFolder}/app.js",
"env": {
"NODE_ENV": "production",
"API_KEY": "your_production_api_key",
"DATABASE_URL": "mongodb://your_production_db_host/myapp_prod"
}
}
]
}
上記の例では、2つのデバッグ構成が定義されており、それぞれ異なる環境変数（NODE_ENV、API_KEY、DATABASE_URL）が設定されています。これにより、デバッグ時にそれぞれの環境に合わせた設定でプログラムを実行できます。
${workspaceFolder} 変数
launch.json では、${workspaceFolder} のようなVS Codeの変数を活用できます。これは、VS Codeで開いているフォルダの絶対パスを表します。これにより、プロジェクトの構造が変わってもパスが自動的に解決されるため、移植性が高まります。
.env ファイルを利用した環境変数の設定
launch.json 以外に、.env ファイルを利用して環境変数を管理する方法も一般的です。特に、Node.js環境でdotenvのようなライブラリを使用する場合に強力な手段となります。
.env ファイルとは
.env ファイルは、プロジェクトのルートディレクトリに配置されるテキストファイルで、キーと値のペアで環境変数を定義します。通常、.gitignore ファイルに.env を追加し、バージョン管理システムに含めないようにします。
例：.env ファイル
NODE_ENV=development
API_KEY=your_local_api_key
DATABASE_URL=mongodb://localhost:27017/myapp_local
dotenv ライブラリの利用
Node.jsプロジェクトでは、dotenv というnpmパッケージをインストールして利用するのが一般的です。
npm install dotenv --save
そして、アプリケーションのエントリポイント（通常はindex.jsやapp.js）の冒頭でdotenvを読み込みます。
require('dotenv').config();
// これ以降、process.env.NODE_ENV や process.env.API_KEY で .env ファイルの値にアクセスできます。
console.log('NODE_ENV:', process.env.NODE_ENV);
console.log('API_KEY:', process.env.API_KEY);
dotenv は、.env ファイルのキーと値のペアを process.env オブジェクトに読み込みます。これにより、コードを変更することなく、.env ファイルを編集するだけで環境変数を切り替えることができます。
VS Codeでの.env ファイルのサポート
VS Code自体も .env ファイルを認識し、シンタックスハイライトやオートコンプリートなどの機能を提供します。また、VS Codeの拡張機能を利用することで、.env ファイルの管理がさらに便利になります。例えば、「dotenv」という名前の拡張機能は、.env ファイルの環境変数をVS Codeのデバッグセッションで自動的に読み込む機能などを提供します。
VS Codeの設定ファイル (settings.json) での環境変数設定
launch.json はデバッグ実行時の環境変数設定に特化していますが、VS Codeのグローバルまたはワークスペース固有の設定ファイル（settings.json）でも、一部の拡張機能などが利用する環境変数を設定することができます。ただし、これはプログラム実行時の環境変数として直接渡されるというよりは、VS Codeの挙動や特定の拡張機能の設定に影響を与える場合が多いです。
settings.json の場所
- グローバル設定：
Ctrl+,(Windows/Linux) またはCmd+,(Mac) で設定画面を開き、「設定」の右上にあるファイルアイコンをクリックしてsettings.jsonを開きます。 - ワークスペース設定：プロジェクトのルートディレクトリにある
.vscode/settings.jsonファイルに記述します。
settings.json での環境変数設定の例
多くの拡張機能は、settings.json を通じて設定を受け取ります。例えば、特定のリンターやフォーマッターのルール、またはVS Codeの組み込み機能の設定などに環境変数のような値を指定することがあります。
直接的なプログラム実行環境変数というよりは、VS Codeの内部的な設定や、特定の拡張機能に渡すための設定として利用されることが多いです。
{
"terminal.integrated.env.linux": {
"MY_VSCODE_SETTING": "some_value"
},
"editor.formatOnSave": true,
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
}
上記の例では、Linux環境の統合ターミナルで MY_VSCODE_SETTING という環境変数が設定されます。これは、launch.json で設定するようなアプリケーション実行時の環境変数とは異なります。
環境変数の管理におけるベストプラクティス
VS Codeで環境変数を効果的に管理するためには、いくつかのベストプラクティスがあります。
- 機密情報はバージョン管理に含めない: APIキー、パスワード、データベース接続文字列などの機密情報は、
.envファイルを利用し、.gitignoreに追加して、誤って公開リポジトリにコミットしないように厳重に管理してください。 - 環境ごとの設定を明確にする: 開発、ステージング、本番など、各環境で必要な設定を明確にし、
launch.jsonや.envファイルで適切に分離します。 - 一貫した命名規則を使用する: 環境変数名には、大文字とアンダースコア（例:
API_KEY,DATABASE_URL）のような一貫した命名規則を使用すると、可読性が向上します。 - VS Codeの拡張機能を活用する:
dotenvなどの拡張機能は、環境変数の管理を容易にし、開発効率を高めます。 - デフォルト値の設定:
.envファイルが存在しない場合や、特定の環境変数が未定義の場合に、プログラムがクラッシュしないように、コード内でデフォルト値を設定することも検討しましょう。
まとめ
VS Codeで環境変数を設定する方法は複数あり、launch.json を使ったデバッグ時の設定、.env ファイルと dotenv ライブラリを使ったアプリケーション実行時の設定、そして settings.json を使ったVS Code自体の設定などがあります。それぞれの目的に応じて適切な方法を選択し、ベストプラクティスに従って管理することで、安全かつ効率的な開発環境を構築することができます。
