Git Hooks для .NET

Введение

При работе в больших командах бывает трудно поддерживать единый стиль кодовой базы, у каждого свои предпочтения и, возможно, IDE настроена по-разному. Это может привести к несогласованности кода во всей кодовой базе в зависимости от того, кто над ней работал. В дополнение к этому убедиться, что весь выкладываемый код находится в состоянии, в котором он может быть развернут или любой может проверить ветку с уверенностью, что она будет работать без ошибок, бывает непросто. Здесь на помощь приходят githooks. Мы можем настроить их так, чтобы весь код, который фиксируется, был выполнен в едином стиле и проверен на пригодность к сборке до того, как он будет размещен на удаленном сервере.

В экосистеме javascript есть много инструментов, которые люди создали для управления этим, например, Husky и eslint. Но что насчет dotnet?

Необходимые условия

  • Git
  • dotnet-format
  • Проект .NET Core.

EditorConfig

EditorConfig позволяет настроить стили кодирования, используемые в кодовой базе. Это поддерживается многими IDE, включая Visual Studio и Rider. Ниже приведен базовый пример, предоставленный Microsoft. Он должен быть сохранен как .editorconfig в корне вашего решения вместе с файлом .sln.

https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/code-style-rule-options

###############################
# Core EditorConfig Options #
###############################
root = true
# All files
[*]
indent_style = space

# XML project files
[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}]
indent_size = 2

# XML config files
[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct}]
indent_size = 2

# Code files
[*.{cs,csx,vb,vbx}]
indent_size = 4
insert_final_newline = true
charset = utf-8-bom
###############################
# .NET Coding Conventions #
###############################
[*.{cs,vb}]
# Organize usings
dotnet_sort_system_directives_first = true
# this. preferences
dotnet_style_qualification_for_field = false:silent
dotnet_style_qualification_for_property = false:silent
dotnet_style_qualification_for_method = false:silent
dotnet_style_qualification_for_event = false:silent
# Language keywords vs BCL types preferences
dotnet_style_predefined_type_for_locals_parameters_members = true:silent
dotnet_style_predefined_type_for_member_access = true:silent
# Parentheses preferences
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
# Modifier preferences
dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
dotnet_style_readonly_field = true:suggestion
# Expression-level preferences
dotnet_style_object_initializer = true:suggestion
dotnet_style_collection_initializer = true:suggestion
dotnet_style_explicit_tuple_names = true:suggestion
dotnet_style_null_propagation = true:suggestion
dotnet_style_coalesce_expression = true:suggestion
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:silent
dotnet_style_prefer_inferred_tuple_names = true:suggestion
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
dotnet_style_prefer_auto_properties = true:silent
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
dotnet_style_prefer_conditional_expression_over_return = true:silent
###############################
# Naming Conventions #
###############################
# Style Definitions
dotnet_naming_style.pascal_case_style.capitalization = pascal_case
# Use PascalCase for constant fields  
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
dotnet_naming_symbols.constant_fields.applicable_kinds = field
dotnet_naming_symbols.constant_fields.applicable_accessibilities = *
dotnet_naming_symbols.constant_fields.required_modifiers = const
###############################
# C# Coding Conventions #
###############################
[*.cs]
# var preferences
csharp_style_var_for_built_in_types = true:silent
csharp_style_var_when_type_is_apparent = true:silent
csharp_style_var_elsewhere = true:silent
# Expression-bodied members
csharp_style_expression_bodied_methods = false:silent
csharp_style_expression_bodied_constructors = false:silent
csharp_style_expression_bodied_operators = false:silent
csharp_style_expression_bodied_properties = true:silent
csharp_style_expression_bodied_indexers = true:silent
csharp_style_expression_bodied_accessors = true:silent
# Pattern matching preferences
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
# Null-checking preferences
csharp_style_throw_expression = true:suggestion
csharp_style_conditional_delegate_call = true:suggestion
# Modifier preferences
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
# Expression-level preferences
csharp_prefer_braces = true:silent
csharp_style_deconstructed_variable_declaration = true:suggestion
csharp_prefer_simple_default_expression = true:suggestion
csharp_style_pattern_local_over_anonymous_function = true:suggestion
csharp_style_inlined_variable_declaration = true:suggestion
###############################
# C# Formatting Rules #
###############################
# New line preferences
csharp_new_line_before_open_brace = all
csharp_new_line_before_else = true
csharp_new_line_before_catch = true
csharp_new_line_before_finally = true
csharp_new_line_before_members_in_object_initializers = true
csharp_new_line_before_members_in_anonymous_types = true
csharp_new_line_between_query_expression_clauses = true
# Indentation preferences
csharp_indent_case_contents = true
csharp_indent_switch_labels = true
csharp_indent_labels = flush_left
# Space preferences
csharp_space_after_cast = false
csharp_space_after_keywords_in_control_flow_statements = true
csharp_space_between_method_call_parameter_list_parentheses = false
csharp_space_between_method_declaration_parameter_list_parentheses = false
csharp_space_between_parentheses = false
csharp_space_before_colon_in_inheritance_clause = true
csharp_space_after_colon_in_inheritance_clause = true
csharp_space_around_binary_operators = before_and_after
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
csharp_space_between_method_call_name_and_opening_parenthesis = false
csharp_space_between_method_call_empty_parameter_list_parentheses = false
# Wrapping preferences
csharp_preserve_single_line_statements = true
csharp_preserve_single_line_blocks = true
###############################
# VB Coding Conventions #
###############################
[*.vb]
# Modifier preferences
visual_basic_preferred_modifier_order = Partial,Default,Private,Protected,Public,Friend,NotOverridable,Overridable,MustOverride,Overloads,Overrides,MustInherit,NotInheritable,Static,Shared,Shadows,ReadOnly,WriteOnly,Dim,Const,WithEvents,Widening,Narrowing,Custom,Async:suggestion
Вход в полноэкранный режим Выход из полноэкранного режима

Настройки IDE

В вашей IDE вы можете настроить форматирование документов при сохранении. Это гарантирует, что при редактировании новых или существующих файлов они будут форматироваться в соответствии с .editorconfig при сохранении файла.

Rider: Файл > Настройки > Инструменты > Переформатировать и очистить код.

Visual Studio (2022): Инструменты > Параметры > Текстовый редактор > Очистка кода > Запускать профиль очистки кода при сохранении.

dotnet-format

dotnet-format — это инструмент cli, который мы можем использовать для форматирования кода как часть githook. Стилевые предпочтения будут считываться из файла .editorconfig. https://github.com/dotnet/format

Установка:

dotnet tool install -g dotnet-format

Githooks

В корне репозитория будет находиться папка .git. В ней находится папка для хуков и файл конфигурации. Идея заключается в том, чтобы разделить хуки между командой. Мы будем запускать хуки из папки .hooks в корне репозитория. Это нужно будет установить для каждого пользователя в его локальной конфигурации git. Это можно сделать с помощью:

git config --local core.hooksPath .hooks
Войти в полноэкранный режим Выйти из полноэкранного режима

После этого папка hooks может существовать в исходном коде.

pre-commit

.hooks/pre-commit

#!/bin/sh

FILES=$(git diff --cached --name-only --diff-filter=ACM "*.cs")
if [-n "$FILES"]
then
    dotnet format ./path/to/project.sln --include $FILES
    echo "$FILES" | xargs git add
fi
Войти в полноэкранный режим Выйти из полноэкранного режима

Эта команда запускается при каждом коммите и выполняет следующее:

  • Получает список staged файлов, расширение файла которых .cs.
  • Если такие файлы есть, запустите dotnet format с путем к решению и передайте список файлов.
  • повторно размещает отформатированные файлы, готовые к фиксации.

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

pre-push

.hooks/pre-push

#!/bin/sh

dotnet build "./path/to/project.sln"
dotnet test "./path/to/project.sln" --filter "Category!=Integration"
Вход в полноэкранный режим Выйти из полноэкранного режима

Эта команда будет запущена во время push и выполнит следующее:

  • Запускает полную сборку решения.
  • Запускает модульные тесты для решения, если категория не Integration.

Интеграционные тесты могут выполняться очень долго и их лучше избегать во время выполнения git-команд. Любые ошибки сборки или сбой тестов приведут к тому, что push будет отклонен. Еще раз убедитесь, что путь к проекту и имя файла верны.

Готово

Вот и все настройки. Стоит заметить, что всем, кто впервые запустит кодовую базу, придется обновить локальный gitconfig, чтобы он указывал на папку hooks. Есть способы автоматизировать это как сценарий сборки или как часть .csproj Build targets, но это для другого поста :).

Оставьте комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *