Reo.Core.Analyzers 10.0.360

Reo.Core.Analyzers

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

Reo.Core.Analyzers — это набор Roslyn-анализаторов для C#, предназначенный для улучшения качества кода, обеспечения соблюдения стандартов и выявления потенциальных проблем в проектах на .NET. Пакет включает в себя анализаторы, которые проверяют:

• Соблюдение соглашений о коде (например, использование атрибутов ExcludeFromCodeCoverage).
• Корректное применение расширений (например, замена Task.WhenAll на WhenAllAsync).
• Использование интерфейсов для аудита и даты (например, ICreateAuditSecure, IUpdateDate).
• Производительность (например, вынесение вызовов методов из циклов).
• Правильное применение LINQ и коллекций (например, использование Any() вместо проверки длины).

Пакет помогает разработчикам избегать распространённых ошибок, улучшать читаемость кода и соответствовать внутренним стандартам проекта.

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

Установка

Установите пакет через NuGet Package Manager или .NET CLI:

Install-Package Reo.Core.Analyzers

dotnet add package Reo.Core.Analyzers

Настройка

Начиная с версии *.0.31277, код фиксы и анализаторы, поставляемые в составе пакетов Reo.Core, получили поддержку использования настроек, задающих правила изменения программного кода. Данные настройки передаются по средствам дополнительного файла, задаваемого в файле *.csproj, и должен иметь имя Reo.Analyzers.json.

Для того, чтобы задать файл настроек, следует добавить в файл проекта следующие строки:

<ItemGroup>
	<AdditionalFiles Include="Reo.Analyzers.json"/>
</ItemGroup>

Пример актуального файла Reo.Analyzers.json

Общие параметры секций конфигурации Все нижепредставленные секции (исключая XmlDoc и UsedImplicitly) конфигурации имеют следующие общие свойства:

{
	"Annotations": {
		"CaseInsensitiveAllowedCategories": [
			"resharper"
		]
	},
	"XmlDoc": {
		"Types": {
			"CancellationToken": "Токен отмены операции",
			"System.TimeProvider": "Сервис работы с датой и временем"
		},
		"PropertiesOrParameters": {
			"inn": "ИНН",
			"kpp": "КПП",
			"id": "Идентификатор",
			"ids": "Идентификаторы",
			"name": "Наименование",
			"names": "Наименования"
		},
		"Methods": {},
		"InheritdocIgnoreTypes": [
			"IEnumerable",
			"IDisposable",
			"IAsyncDisposable",
			"IEntityGuidId"
		],
		"InheritdocIgnoreNamespaces": [
			"Reo.Core.BaseDomainModels",
			"MassTransit"
		]
	},
	"PerformanceLoopAnalyzerConfig": {
		"Types": [
			"HttpClient",
			"IReoHttpClient",
			"ICryptographicMessageSyntaxV1",
			"IMongoDatabase",
			"IMongoCollection",
			"ISequenceGeneratorClient",
			"ITessaClientApi"
		],
		"Namespaces": [
			"Reo.Core.Elastic",
			"Reo.Clients.FileStorage",
			"Reo.Core.NoSql"
		]
	},
	"DDD": {
		"ModelTypes": [
			"IReoDomainModel",
			"IReoValueObject"
		],
		"IgnoreTypes": [
			"ReoAggregateRoot"
		],
		"ValueObjectType": "IReoValueObject"
	},
	"DateTime": {
		"IgnoreBaseTypes": [
			"AutoMapper.Profile"
		]
	},
	"UsedImplicitly": {
		"BaseTypes": [
			"IAsyncMessageHandler"
		]
	},
	"CancellationTokenParameter": {
		"IgnoreTypes": [
			"EnumerableExtensions"
		]
	},
	"CodeStyle": {
		"IgnoreBaseTypes": [
			"AutoMapper.Profile"
		]
	},
	"Controllers": {
		"AuthorizationAnnotationsAndNamespaces": {
			"Authorize": "Microsoft.AspNetCore.Authorization",
			"AllowAnonymous": "Microsoft.AspNetCore.Authorization",
			"AllAuthorizePolicyFrom": "Reo.Core.Auth.Attributes",
			"AnyAuthorizePolicyFrom": "Reo.Core.Auth.Attributes"
		}
	},
	"Testing": {
		"Replace": [
			{
				"From": "UserInfo.Create",
				"To": "TestingUserInfoFactory.CreateUserInfo"
			}
		]
	},
	"ObsoleteMigrator": {
		"Replace": [
			{
				"From": {
					"FullNameClass": "System.DateTime",
					"MemberName": "Now"
				},
				"To": {
					"FullNameClass": "System.TimeProvider",
					"MemberName": "GetUtcNow"
				},
				"Result": "%INJECTED_OBJECT%.%MEMBER%()"
			}
		]
	}
}

REO04005

Анализатор замены выражений согласно правилам, определенным в конфигурационном файле Описание: Анализирует вызовы каждого метода или выражения доступа к свойству объекта, проверяя наличие соответствующего ему правила в конфигурационном файле.

Код диагностики: REO04005

Сообщение: Выражение %ИсходноеВыражение% следует заменить на выражение %ЦелевоеВыражение%

Исправление: Производит замену выражения, согласно найденному в конфигурации правилу.

Описание правил замены выражений

Правила замены описываются в коллекции Replace, специальной секции конфигурационного файла ObsoleteMigrator.

{
	"ObsoleteMigrator": {
		"Replace": [
			{
				"From": {
					"FullNameClass": "Microsoft.Extensions.DependencyInjection.IServiceCollection",
					"MemberName": "AddInitializeDatabase"
				},
				"To": {
					"FullNameClass": "Reo.Core.Database.DataBaseExtensions",
					"MemberName": "AddReoDatabase<MyDbContext>"
				},
				"Result": "%OBJECT%.%MEMBER%($configuration, $configuration.GetConnectionString(TODO))"
			}
		]
	}
}

Шаблон результирующего выражения

Представляет собой произвольную строку, описывающую, каким образом должно выглядеть результирующее выражение, посредствам значений специальных зарезервированных слов.

Применительно к вызовам методов, также может быть осуществлена подстановка аргументов исходного метода.

Зарезервированные слова

Могут быть использованы в произвольном месте строки шаблона результирующего выражения.

Подстановка аргументов из заменяемого вызова

При построении результирующего выражения вызова, была предусмотрена возможность переноса аргументов из вызова заменяемого метода. Для этого строится соответствие между именами параметров заменяемого метода и передаваемых ему аргументов. При задании в шаблоне результирующего выражения вызова имени параметра вида $ИмяПараметра, в результирующий вызов будет подставлен аргумент, передаваемый в качестве этого параметра.

Проиллюстрируем это на примере.

Пусть необходимо произвести замену следующего вызова метода:

serviceCollection.AddInitializeDatabase<MyDbContext>(configuration, builder => builder.EnableDetailedErrors(), ServiceLifetime.Singleton);

Сигнатура этого метода выглядит следующим образом:

public static IServiceCollection AddInitializeDatabase<TDbContext>(
		this IServiceCollection services,
		IConfiguration configuration,
		[NotNull] Action<DbContextOptionsBuilder> optionsAction,
		ServiceLifetime contextLifetime = ServiceLifetime.Scoped)

Тогда, в данном случае, список доступных для использования в шаблоне параметров будет таким:

Псевдонимы типов

Используются для задания произвольного имени типа, объект которого требуется поместить в результирующий вызов. В шаблоне результирующего вызова псевдонимы типов имеют запись вида #ПсевдонимТипа.

Когда найдена такая запись, алгоритм ищет первый параметр, тип которого совпадает с псевдонимом метода, где находится заменяемый вызов.

Если же такой параметр не был найден, он будет добавлен в список параметров этого метода.

Найденный или добавленный параметр будет использован в шаблоне, на месте использования псевдонима типа.

Пример

До замены:

services.AddInitializeDatabase<MyDbContext>(configuration, builder => builder.EnableDetailedErrors(), ServiceLifetime.Singleton);

После замены:

services.AddReoDatabase<MyDbContext>(configuration, configuration.GetConnectionString(TODO));

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

Пример 1: Использование метода расширения вместо логического выражения

Проблемный код:

if (collection == null || collection.Count == 0)
{
    // ...
}

Рекомендация:

if (collection.IsNullOrEmpty())
{
    // ...
}

Анализатор EnumerableCheckDiagnosticId предложит заменить проверку на IsNullOrEmpty().

Пример 2: Замена Task.WhenAll на WhenAllAsync

Проблемный код:

await Task.WhenAll(tasks);

Рекомендация:

await tasks.WhenAllAsync();

Анализатор WhenAllAsyncExtensionMethodInvocationExpectedDiagnosticId предложит использовать метод расширения WhenAllAsync().

Пример 3: Использование Any() вместо проверки длины

Проблемный код:

if (collection.Count > 0)
{
    // ...
}

Рекомендация:

if (collection.Any())
{
    // ...
}

Анализатор EnumerableLengthCheckDiagnosticId предложит заменить проверку на Any().

Лицензия

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