ソースコードの変数宣言を整列する
ソースコードの変数宣言、代入、型アノテーションを整列し、読みやすさを改善します。
Code Formatting
詳細な説明
コード宣言の整列
多くのスタイルガイドでは、関連する変数宣言、構造体フィールド、定数定義を整列して、型、名前、値がきれいなカラムを形成することを推奨しています。一部のコードフォーマッターはこれを自動的に処理しますが、多くは対応していません。
変換前(Go構造体)
Name string
Age int
Email string
IsActive bool
CreatedAt time.Time
変換後
Name string
Age int
Email string
IsActive bool
CreatedAt time.Time
変換前(JavaScript定数)
const API_URL = "https://api.example.com";
const TIMEOUT = 5000;
const MAX_RETRIES = 3;
const DEBUG = false;
変換後(=で整列)
const API_URL = "https://api.example.com";
const TIMEOUT = 5000;
const MAX_RETRIES = 3;
const DEBUG = false;
テクニック
- 型アノテーション言語(Go、Rust、C)では、名前と型の間のギャップで分割するために**Spaces (2+)**を区切り文字として使用します。
- 代入の整列(JavaScript、Python)では、**Equals =**を区切り文字として使用します。
- コードが構文的に有効なままになるよう、出力区切り文字はSame as Inputのままにします。
- 両方のカラムを左揃えにします。
コードを整列するタイミング
コードの整列はスタイルの選択です。関連する宣言のグループのスキャン性を改善しますが、新しい長い名前が追加されると(すべての行のパディングが変わるため)ノイズの多いdiffを作成する可能性があります。定数定義、構造体フィールド、設定マップなど、安定してめったに変更されないブロックに整列を使用してください。
ユースケース
Go開発者がコミット前に大きな構造体定義の構造体フィールド名と型を整列したい場合。