Reo.Core.CodeConventions 10.0.10

Reo.Core.CodeConventions

Описание пакета

Пакет Reo.Core.CodeConventions предоставляет стандартные соглашения о коде, которые помогают поддерживать единый стиль и качество в проектах на C#. Он включает в себя:

• Файл .editorconfig, который определяет правила форматирования и стиля кода (например, нейминг, отступы, комментарии).
• Скрипты сборки, которые автоматически копируют .editorconfig в корневую директорию проекта при сборке, обеспечивая согласованность между разработчиками и CI/CD-системами.

Этот пакет решает проблему несоответствия стиля кода в разных проектах, обеспечивая автоматизированный контроль за соблюдением стандартов.

Основные компоненты

• .editorconfig Файл, который определяет правила форматирования кода (например, dotnet_style_qualification_for_event = false, indentation_width = 4).

• build\Reo.Core.CodeConventions.props Скрипт MSBuild, который копирует .editorconfig в корневую директорию проекта при сборке.

• IPackageExistMarkerType.cs Маркерный интерфейс, используемый для проверки наличия пакета в проекте (не является частью публичного API, но используется в инфраструктуре).

Требования

• .NET версии: .NET Standard 2.0 и выше.
• Зависимости: Нет внешних зависимостей.

Установка

Используйте следующие команды для установки пакета:

• NuGet Package Manager:

  Install-Package Reo.Core.CodeConventions
  

• .NET CLI:

  dotnet add package Reo.Core.CodeConventions
  

Настройка

1. Добавьте .editorconfig в проект После установки пакета, файл .editorconfig будет автоматически скопирован в корневую директорию проекта при сборке. Убедитесь, что он включен в .gitignore или .hgignore, если не хотите, чтобы он попадал в контроль версий.

2. Настройка MSBuild Если вы хотите изменить поведение копирования .editorconfig, отредактируйте файл build\Reo.Core.CodeConventions.props и настройте параметры Copy в таргете CopyEditorConfig.

Конфигурационных параметров в пакете нет.

Использование

Пример 1: Использование .editorconfig в проекте

После установки пакета, .editorconfig будет автоматически скопирован в корневую директорию проекта. Пример содержимого файла:

# .editorconfig
root = true

[*.cs]
dotnet_style_qualification_for_event = false
indentation_width = 4

Этот файл обеспечивает единый стиль кода для всех разработчиков.

Пример 2: Использование скрипта сборки

Файл build\Reo.Core.CodeConventions.props копирует .editorconfig в корневую директорию проекта при сборке. Это гарантирует, что .editorconfig присутствует в каждом проекте, который использует этот пакет.

Лицензия

Данный пакет распространяется под лицензией MIT.