環境変数ファイル（.env）を整列する

.envファイルのフォーマット

環境変数ファイル（一般的に.env、.env.local、.env.productionという名前）は、イコール記号で区切られたキーと値のペアを格納します。プロジェクトが成長すると、これらのファイルには長さの異なるキーを持つ数十のエントリが含まれ、一目で値をスキャンすることが困難になります。

変換前

DB_HOST=localhost
DB_PORT=5432
DB_NAME=myapp_production
DB_USER=admin
DB_PASSWORD=s3cret!Key
DATABASE_CONNECTION_POOL_SIZE=10
REDIS_URL=redis://localhost:6379
SESSION_SECRET=a1b2c3d4e5f6

変換後

DB_HOST                      =localhost
DB_PORT                      =5432
DB_NAME                      =myapp_production
DB_USER                      =admin
DB_PASSWORD                  =s3cret!Key
DATABASE_CONNECTION_POOL_SIZE=10
REDIS_URL                    =redis://localhost:6379
SESSION_SECRET               =a1b2c3d4e5f6

設定

1. 入力区切り文字として**Equals =**を選択します。
2. 出力区切り文字はSame as Inputのまま。
3. Trim whitespaceを有効にします。
4. 最初のカラム（キー）はデフォルトで左揃えで、これが理想的です。

なぜenvファイルを整列するのか

整列された環境ファイルは、レビュアーがどの値がどのキーに属するかを即座に確認できるため、コードレビューが速くなります。また、複数の開発者がエントリを追加する際のバージョン管理でのマージ競合も削減されます。

注意

実際のシークレットを含む整列された.envファイルをパブリックリポジトリにコミットしないよう注意してください。このツールはすべてをローカルで処理するのでシークレットがブラウザから外に出ることはありませんが、機密ファイルを除外するために常に.gitignoreを使用してください。