Reo.Core.CodeGeneratorTesting 10.0.229

Reo.Core.CodeGeneratorTesting

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

Пакет Reo.Core.CodeGeneratorTesting предоставляет набор утилит для тестирования генераторов кода на основе Roslyn. Он позволяет создавать и настраивать тестовые среды для проверки работы генераторов кода, включая добавление дополнительных файлов, построение компиляций и настройку драйверов генераторов.

Какую проблему решает

Пакет решает проблему сложности тестирования генераторов кода в изолированных условиях. Он позволяет:

• Добавлять пользовательские файлы в процесс генерации.
• Создавать виртуальные компиляции для проверки результатов генерации.
• Настраивать драйверы генераторов с поддержкой дополнительных данных.

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

1. TestingGeneratorDriverBuilder

Назначение: Построитель драйвера генератора кода с поддержкой дополнительных текстовых файлов. Функции:

• Добавляет дополнительные текстовые файлы в процесс генерации.
• Создаёт драйвер генератора с настроенными параметрами.

2. TestingAdditionalText

Назначение: Реализация интерфейса AdditionalText для предоставления пользовательских файлов в процессе генерации. Функции:

• Читает содержимое файла из указанного пути.
• Возвращает текст в формате SourceText для использования в Roslyn.

3. TestingCompilationBuilder

Назначение: Построитель виртуальной компиляции для тестирования генераторов кода. Функции:

• Добавляет синтаксические деревья (.cs файлы) в компиляцию.
• Добавляет метаданные (например, ссылки на сборки).
• Создаёт компиляцию для тестирования генератора.

Требования

• .NET версия: net8.0
• Зависимости:
  • Microsoft.CodeAnalysis.Common
  • Microsoft.CodeAnalysis.CSharp

Установка

Через NuGet Package Manager:

Install-Package Reo.Core.CodeGeneratorTesting

Через .NET CLI:

dotnet add package Reo.Core.CodeGeneratorTesting

Настройка

DI-контейнер: N/A Пакет не требует регистрации в DI-контейнере, так как предоставляет утилиты для тестирования, а не сервисы приложения.

Конфигурационные параметры: N/A Пакет не требует настройки через конфигурационные файлы.

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

Пример 1: Создание драйвера генератора с дополнительным файлом

var driver = new TestingGeneratorDriverBuilder()
 .WithAdditionalText("path/to/additional/file.txt")
 .Build<MyCustomGenerator>();

Пример 2: Построение виртуальной компиляции

var compilation = new TestingCompilationBuilder()
 .AddSyntaxTree(SourceText.From("class Test { }"))
 .AddMetadataReferenceFromType(typeof(object))
 .Build();

Пример 3: Использование в тесте генератора

var driver = new TestingGeneratorDriverBuilder()
 .WithAdditionalText("path/to/template.cs")
 .Build<MyCustomGenerator>();

var result = driver.RunGenerators(compilation);

Лицензия

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