VsEditorConfig

Конфигурация редактора Visual Studio

О

Большинство источников в Интернете рекомендуют проверять файл .editorconfig в каждом репозитории, подобно файлу package.json или Nuget.config . Это определенно справедливо для командных проектов или проектов с открытым исходным кодом, где несколько разработчиков сотрудничают с разными личными стилями кодирования. Однако вы, скорее всего, будете использовать одни и те же настройки качества/стиля для всех своих личных/частных проектов/репозиториев. Поэтому, чтобы избежать дублирования этих настроек в каждом новом репозитории (кошмар для обновления, если ваши предпочтения качества/стиля когда-либо изменятся), вы можете создать один файл .editorconfig в отдельном репозитории и использовать его в различных репозиториях. По сути, этот .editorconfig становится одним из многих «точечных файлов», определяющих вашу личную среду кодирования.

Этот репозиторий содержит такой .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 "

Замените указанные выше пути на те, которые необходимы для вашей конкретной структуры каталогов (лучше всего подходят абсолютные пути). После создания ссылки вы сможете обновить .editorconfig с помощью git pull как обычно, и последние настройки стиля будут доступны для всех ваших репозиториев (после перезапуска Visual Studio).

Если вам не нравятся какие-либо из моих предпочтений в стиле/форматировании, вы можете либо разветвить мой .editorconfig , чтобы использовать его в качестве отправной точки и изменить его в соответствии с вашими конкретными соглашениями, либо добавить отдельный .editorconfig со своими переопределениями к отдельному файлу. репозитории, которым нужны эти переопределения.