TidySmith

TidySmith を選ぶ理由

機能

• クラス、ファイル、またはソリューション エクスプローラーで選択したファイルのメンバーを並べ替え。移動する内容をプレビューできます。
• エディター内のヒント: 整理できる箇所に灰色の点、修正は電球 (Ctrl+.) から。
• ルールに従ったリージョン: メンバー グループごと、アクセスレベルごと、またはその両方で、独自のリージョン名を付けて。リージョンなしにもできます。
• 収まるコメント: // と /// のコメントを行の長さで折り返し、短い行は結合します。
• 保存時に整理: C# ファイルの保存時に、選んだ手順を実行します。既定ではオフです。
• 構造ウィンドウ: ファイルのメンバー、メソッドのサイズと複雑度、ドラッグで並べ替え。
• 小さなヘルパー: 関連ファイルへの切り替え、行の並べ替えと結合、ソリューション エクスプローラーでのファイル検索、リージョンだけの折りたたみと展開。

すべてのコマンドは 編集 › TidySmith とコード エディターのコンテキスト メニュー (右クリック › TidySmith) にあります。Order Members はソリューション エクスプローラーのファイル、フォルダー、プロジェクトのコンテキスト メニューにもあります。

メンバーを並べ替える

Order Members… はクラスのメンバーを種類 (定数、フィールド、コンストラクター、プロパティ、メソッド…)、アクセスレベル (public が先)、静的メンバーをインスタンス メンバーより先に、必要なら名前の順に並べ替えます。順序はオプション ページまたは .editorconfig で設定したとおりです。

• まずプレビュー: 移動する内容の差分を表示します。適用 は 1 回の編集なので、1 回の元に戻すですべて取り消せます。「今後確認しない」でプレビューをオフにできます。
• 対象: キャレットのあるクラスかファイル全体 (プレビューで選択)、またはソリューション エクスプローラーで選択したすべての C# ファイル (ファイル、フォルダー、プロジェクト)。
• メンバーと一緒に移動するもの: そのコメント、ドキュメント、属性。空行は元のまま保たれ、グループ間には空行が 1 行入ります。
• 決して触れないもの: #if または #region 内のメンバーはそのブロック内でのみ並べ替えられます。中かっこと同じ行にメンバーがあるクラス、1 行に 2 つのメンバーがあるクラス、構文エラーのあるクラスはそのままです。生成されたファイル (*.g.cs、*.Designer.cs) はスキップされます。

開始用のプリセット: TidySmith (オーバーロードとインターフェイスの実装をまとめる)、StyleCop (SA1201、SA1202、SA1204 — 厳密にアクセスレベル順)、CodeMaid (CodeMaid の既定。CodeMaid から移行するチーム向け)。

エディター内のヒント

TidySmith が役立つ箇所では、名前の下に灰色の点が 3 つ表示されます。Visual Studio が自身の提案を示すのと同じ方法です。ポインターを合わせると内容がわかり、Ctrl+. で変更のプレビュー付きの修正が提示されます。

点が表示されるのは、順序が乱れたクラス、行の長さを超えるコメント、ルールと異なるリージョンだけです。点と電球のアクションには別々のスイッチがあります。「自分が変更したファイルのみ」をオンにすると、古いコードには何も表示されません。

ルールに従ったリージョン

Add Regions to This File… は、プレビューの後、ルールが指定する場所に #region 行を入れます。リージョンはチームで決めることなので、既定はリージョンなしです。選ぶまで、コマンドは設定を開きます。

• 分け方: メンバー グループごとに 1 つのリージョン (Fields、Methods…)、アクセスレベルごと (Public、Private…)、またはその両方 (Public methods)。
• 独自の名前: 各グループにリージョン名があります。同じ名前のグループは 1 つのリージョンを共有し、オフのグループはリージョンの外に置かれます。インターフェイスの実装には、インターフェイス名のリージョン (IDisposable) を付けられます。
• ノイズなし: メンバーが最小数 (既定は 2) 未満ならリージョンは作られません。コンストラクター 1 つを囲むリージョンは誰の役にも立ちません。
• 何度でも実行できます: クラス内のリージョンは入れ子にならず、再構築されます。先にメンバーが並べ替えられるので、各グループはひとまとまりになります。
• 手動で: Add Region Around Selection (キャレットは #region の後で名前の入力を待ちます)、Remove Region at Caret、Remove Regions in This File。削除されるのは #region と #endregion の行だけで、コードは残ります。

StyleCop のルール SA1124 はリージョンを禁止しています。そのため既定はリージョンなしで、この設定では保存時の整理がリージョンを削除します。

収まるコメント

Format Comment は、キャレット位置の // または /// コメント (またはファイルのすべてのコメント) を行の長さ (.editorconfig の max_line_length、または 120) で折り返します。長い行は分割し、短い行は結合し、長い <summary> は独立した行にします。コード サンプル (<code>)、リスト、区切り線、コメントアウトされたコードはそのままです。

保存時に整理

C# ファイルの保存時に、TidySmith はメンバーの並べ替え、ルールに従ったリージョンの設定、コメントの折り返し、行末の空白と余分な空行の削除を行えます。各手順には個別のスイッチがあります。対象は保存するファイルだけで、生成されたファイルは対象外です。変更内容はステータス バーに表示され、Ctrl+Z で元に戻せます。Tidy This File は同じ手順を必要なときに実行します。

既定ではオフです。Order Members がチームの望む結果を出せるようになってからオンにしてください。そうしないと、古いファイルを初めて保存したときに全体が並べ替えられます。

構造ウィンドウ

表示 › その他のウィンドウ › TidySmith Structure: アクティブな C# ファイルの型とメンバーを表示します。キャレットに追従し、クリックでメンバーへ移動、検索で絞り込み、メンバーを別のメンバーの上にドラッグするとそこへ移動します (Order Members と同じ安全な移動)。メソッドには長さとサイクロマティック複雑度が表示され、オプション ページの上限を超えるとオレンジ色になります。

小さなヘルパー

CodeMaid にあって恋しくなるコマンドを、編集 › TidySmith とエディターのコンテキスト メニューに。

Switch File

現在のファイルに対応するファイル (マークアップとそのコード、リソース ファイルとそのデザイナー、コードとそのテスト) を、ソリューション エクスプローラーで探さずに開きます。

メニューには切り替え先の名前 (「Switch to OrderServiceTests.cs」) が表示され、移動先がないときは無効になります。独自のショートカット キーを割り当てると便利です (下記参照)。

Sort Selected Lines

using、列挙型のメンバー、リストの項目を並べ替えます。コンマはリストに必要な位置に残ります。並べ替えるのはフラットなリスト (1 行に 1 項目、同じインデント、空行なし、ステートメントなし) だけなので、誤ってメソッドやファイル全体を選択しても崩れることはありません。理由はステータス バーに表示されます。

Join Lines

選択した行を 1 行に結合します。選択がない場合は、キャレットのある行を次の行と結合します。

Find This File in Solution Explorer

エディターのファイルをソリューション エクスプローラーで選択します。

Collapse All Regions と Expand All Regions

#region ブロックだけを折りたたむか展開します。メソッドはそのままです。Ctrl+M, Ctrl+O (メソッドも折りたたむ) や Ctrl+M, Ctrl+L (すべて) とは異なります。

既定ではショートカットを割り当てません。Visual Studio のキーはそのままです。ツール › オプション › 環境 › キーボード で任意のコマンドに割り当てられます。「以下の文字列を含むコマンドを表示」に TidySmith. と入力してください。

設定

ツール → オプション → SmithWorks → TidySmith。各オプションに説明があります。

オプション	既定値
電球 (Ctrl+.) の TidySmith のアクション	オン
整理できる箇所の灰色の点	オン
メンバーの順序	TidySmith プリセット
並べ替える前のプレビュー	オン
リージョン	リージョンなし
コメントの行の長さ	120
保存時に整理	オフ
長いメソッド (行数) · 複雑なメソッド	60 · 10
Marketplace での評価をお願いする	オン

設定は %LocalAppData%\TidySmith に保存されます。.editorconfig に値がある場合はそちらが優先されます。

リポジトリごと: .editorconfig

ルールをコードの隣に置けば、チーム全員が同じ結果を得られます。.editorconfig の値はオプション ページより優先されます (「.editorconfig の順序を使用する」がオフの場合を除く)。

[*.cs]
tidysmith_member_order = stylecop
tidysmith_regions = kind
tidysmith_region_min = 2
max_line_length = 120

よくある質問

変更履歴

1.0.2

• 拡張機能が役に立った後に一度だけ、Marketplace での評価をお願いします。[後で] と [今後表示しない] があり、オプションでオフにもできます。

1.0.1

• Order Members と Structure ウィンドウを、ほかの SmithWorks 拡張機能と共通の SmithWorks ツール バーに追加しました (表示 › ツール バー › SmithWorks)。

1.0.0

• 最初の公開リリース。