Visual Studio 2017の最初のRC(Release Candidate)に含まれた機能のひとつに,EditorConfig規格のサポートがある。この規格に準拠することにより,一度定義したコーディングスタイルが,他のエディタのスタイルとして簡単に再利用できるようになった。もうひとつの大きなメリットは,EditorConfigファイルで定義されたスタイルをソース管理システムに保管することで,特定のエディタのダイアログボックスやコンフィギュレーションによる紛失を防ぐことが可能になる点だ。VS2017ではC#,Visual Basic,C++,JavaScript,F#,TypeScriptなどの言語でEditorConfig機能の使用がサポートされるようになる。
MicrosoftのKasey Uhlenhuth氏が説明しているように,EditorConfigのメリットのひとつとして,複数のEditorConfigファイルを使用してプロジェクトないし特定の標準を直接的に定義することにより,幅広い規格をソリューション全体で定義可能だという点がある。このような追加ファイルを使えば,コードフォーマットルールとコードスタイルルールの両方を定義することが可能になる。VS2017RCでは現在,次の5つのフォーマットルールをサポートしている。
- indent_style
- indent_size
- tab_width
- end_of_line
- charset
あと2つの一般的なルールであるtrim_trailing_whitespace
とinsert_final_newline
はまだサポートされていない。コードスタイルルールも定義可能で,この機能が完全に実装された時点では,重要度(なし/提案/警告/エラー)に準じてビルドが中断されるようになる(現在のVS2017RCではビルドが継続される)。Microsoftによると,Visual StudioのEditorConfigサポートはVS2017 RTM以降にアップデートが予定されており,目標はこのアップデートでEditorConfigの完全準拠を提供することだ。
既存のソースツリーに対して適用したいCode FormattingおよびCode Styleルールを定義した場合や,EditorConfigファイルを変更した場合は,開いているファイルをすべてクローズした上で再オープンする必要がある。Uhlenhuth氏が,新しいルールを簡単に適用するためのキーボードショートカットをいくつか教えてくれた。
- エディタでオープンしているひとつのファイルの更新 – Format Document CTRL-K, D
- プロジェクト/ソリューションの全ファイルに変更を適用 – Quick Actionメニュー CTRL +(コントロールとプラス)。
EditorConfigファイルで定義したルールは,Visual StudioのTools | Options
メニューでの定義によって上書きされる点には注意が必要だ。VS2017でEditorConfigファイルの編集時にエディタの支援を望むならば,Mads Kristensen氏がオープンソースのEditorConfig言語サービスプラグインを用意している。現時点でCode FormattingおよびCode Styleを使用するにはVS2017RCが必要だが,この機能をビルドシステムとのインテグレーション用に可能とするNuGetパッケージが現在開発中である。
2017年1月10日,言語サポートに関する情報と今後のアップデートの入手可能性を追記した。
この記事を評価
- 編集者評
- 編集長アクション