設定ファイルのキーと値のペアを整列する
設定ファイル(INI、TOML、properties)のキーと値のペアを整列し、きれいで整理された外観にします。
Configuration Files
詳細な説明
設定ファイルのフォーマット
さまざまな形式の設定ファイル — INI、TOML、Javaプロパティ、NGINX設定 — はキーと値の間に異なる区切り文字を使用しますが、適切な整列による読みやすさの恩恵は共通しています。
INIスタイル(イコール記号)
[database]
host=localhost
port=5432
name=production_db
user=app_user
password=encrypted_value
pool_size=25
max_idle=5
connection_timeout=10
変換後
[database]
host =localhost
port =5432
name =production_db
user =app_user
password =encrypted_value
pool_size =25
max_idle =5
connection_timeout =10
セクションヘッダーの処理
INIファイルでは、[database]のようなセクションヘッダーには区切り文字が含まれず、単一カラムの行として扱われます。ツールはこれを適切に処理し、ヘッダー行はそのまま通過し、その下のキーと値の行が整列されます。
複数セクションのファイル
設定ファイルに複数のセクションがある場合、ファイル全体を一度に整列できます。各セクションのキーはファイル全体で同じ最大幅にパディングされます。セクションごとの整列が望ましい場合は、各セクションを別々の整列パスに分割してください。
コメントの保持
#や;(一般的なコメントマーカー)で始まる行で区切り文字を含まないものは、単一カラムの行としてそのまま通過します。変更されないため、コメントはそのまま残ります。
形式固有の注意事項
- TOML — キーと値の間に
=を使用;整列は純粋に装飾的でパースに影響しません。 - Java .properties —
=または:を使用可能;適切な区切り文字を選択してください。 - NGINX — ディレクティブと値の間にスペースを使用;**Spaces (2+)**を使用してください。
ユースケース
バックエンド開発者が50以上の設定を持つ大規模なアプリケーション設定ファイルを整理し、ピアレビューのためのきれいでスキャン可能なレイアウトを求めている場合。