VsEditorConfig

Visual Studio EditorConfig

について

インターネット上のほとんどのソースでは、 package.jsonやNuget.configファイルと同様に、 .editorconfigファイルをすべてのリポジトリにチェックインすることを推奨しています。これは、複数の開発者が異なる個人的なコーディング スタイルで共同作業するチーム プロジェクトやオープンソース プロジェクトに間違いなく有効です。ただし、あなた自身の個人/プライベート プロジェクト/リポジトリのすべてに同じ品質/スタイル設定を使用する可能性があります。したがって、これらの設定がすべての新しいリポジトリに重複することを避けるために (品質やスタイルの設定が変更された場合に更新するのは悪夢です)、独自のリポジトリに 1 つの.editorconfigファイルを作成し、さまざまなリポジトリでそのファイルを利用することができます。基本的に、その.editorconfig 、独自の個人的なコーディング環境を定義する多くの「ドットファイル」の 1 つになります。

このリポジトリには、そのような.editorconfigが含まれています。これは自分のプロジェクト用に開発しましたが、私のスタイル設定が一般的で、どのリポジトリの Visual Studio プロジェクトでも使用できることを願っています。そうでない場合は、おそらくこのリポジトリが独自の.editorconfig作成するための参照点として機能するでしょう。

使用法

次のディレクトリ構造があるとします。

root-directory
    VisualStudioEditorConfig
        .editorconfig
    Repo1
    Repo2
    RepoGroup
        Repo3
        Repo4
    ...

すべてのリポジトリ (Repo1、Repo2、Repo3、Repo4 など) で同じスタイル設定を使用したい場合は、.editorconfig ファイルを「ルート ディレクトリ」フォルダに置く必要があります。残念ながら、.editorconfig ファイルはサブフォルダー「VsEditorConfig」に複製されました。ファイルをルート ディレクトリにコピーすることもできますが、スタイル設定が変更されるたびにファイルを再コピーする必要があります。解決策は、バージョン管理された .editorconfig へのシンボリック リンクをルート ディレクトリに作成することです。

Windows では、管理者特権のコマンド プロンプトで次のコマンドを実行します。管理者特権でのコマンド プロンプト (つまり、「管理者として実行」で開かれたコマンド プロンプト) を使用しない場合、 You do not have sufficient privilege to perform this operation.

 MKLINK " root-directory.editorconfig " " root-directoryVsEditorConfig.editorconfig "

MacOS/Linux では、次のコマンドを実行します。

ln -s " root-directory/VsEditorConfig/.editorconfig " " root-directory/.editorconfig "

上記のパスを、特定のディレクトリ構造に必要なパスに置き換えます (絶対パスが最適です)。リンクが作成されると、通常どおりgit pullを使用して.editorconfig更新できるようになり、最新のスタイル設定がすべてのリポジトリで利用できるようになります (Visual Studio の再起動後)。

私のスタイル/書式設定のいずれかが気に入らない場合は、私の.editorconfigフォークして開始点として使用し、特定の規則に合わせて変更するか、個別の.editorconfigをオーバーライドした個別の .editorconfig を追加することができます。これらのオーバーライドが必要なリポジトリ。