Українська
Спільні налаштування збирання
Крок 1. Одне місце для налаштувань збирання
Навіщо. Кожен .csproj, створений за шаблоном, повторює ті самі властивості: цільову платформу, nullable-посилання, неявні using. Із сімома проєктами (три зараз, чотири тестові пізніше) зміна одного налаштування означала б правку семи файлів і сподівання, що жоден не забули.
MSBuild, рушій збирання .NET, автоматично імпортує файл із назвою Directory.Build.props з папки проєкту або будь-якої папки вище. Тому файл у корені репозиторію діє на кожен проєкт репозиторію.
Що зробити. Створіть файл у корені репозиторію:
xml
<Project>
<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<LangVersion>14</LangVersion>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
<!-- .NET analyzers at the recommended level, plus the IDE style rules from .editorconfig, checked on build. -->
<AnalysisLevel>latest-recommended</AnalysisLevel>
<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
<!-- Restore checks direct and transitive packages against known advisories; with warnings as errors a
vulnerable package fails the build, in CI and in the deploy. -->
<NuGetAudit>true</NuGetAudit>
<NuGetAuditMode>all</NuGetAuditMode>
</PropertyGroup>
<PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true'">
<ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
</PropertyGroup>
</Project>Що робить кожне налаштування:
TargetFrameworknet10.0– проєкти працюють на .NET 10.LangVersion14фіксує версію C#, тож новіший SDK непомітно не вмикає новіші можливості мови.Nullableenable– компілятор стежить, які посилання можуть бутиnull.stringозначає «ніколи не null»,string?– «може бути null», а використанняstring?без перевірки дає попередження. БільшістьNullReferenceExceptionстають попередженнями на етапі компіляції.ImplicitUsingsenable– поширені простори імен (System,System.Linq,System.Threading.Tasks, ...) імпортуються в кожен файл автоматично.TreatWarningsAsErrorstrue– кожне попередження провалює збирання. Це звучить суворо, але лише так можна втримати нуль попереджень: попередження, що нічого не провалює, ігнорують, потім їх стає п’ятдесят, і важливе п’ятдесят перше губиться серед них.AnalysisLevellatest-recommended– вмикає рекомендований набір аналізаторів коду .NET (правилаCA…): неправильне використанняasync, відсутнійCancellationToken, порівняння рядків, що залежить від культури, та багато іншого.EnforceCodeStyleInBuildтакож перевіряє правила стилю (IDE…) з.editorconfigпід час збирання, а не лише в IDE.NuGetAuditзNuGetAuditModeall– під час відновлення NuGet перевіряє кожен пакет, разом із пакетами, від яких вони залежать, за базою відомих вразливостей. Із попередженнями як помилками вразливий пакет провалює збирання.ContinuousIntegrationBuild– лише в GitHub Actions (там зміннаGITHUB_ACTIONSдорівнюєtrue): робить результат збирання детермінованим, незалежним від папки, у якій його зібрано (тема 22).
Тепер проєктам не потрібні власні копії. Видаліть елемент <PropertyGroup> з TargetFramework, ImplicitUsings і Nullable із кожного з трьох файлів .csproj. Лишаються SDK і посилання:
xml
<Project Sdk="Microsoft.NET.Sdk">
</Project>xml
<Project Sdk="Microsoft.NET.Sdk">
<ItemGroup>
<ProjectReference Include="..\Chatex.Data\Chatex.Data.csproj" />
</ItemGroup>
</Project>xml
<Project Sdk="Microsoft.NET.Sdk.Web">
<ItemGroup>
<ProjectReference Include="..\Chatex.Core\Chatex.Core.csproj" />
</ItemGroup>
</Project>Перевірка
dotnet build закінчується рядками Build succeeded, 0 Warning(s), 0 Error(s). Тепер зламайте його навмисно: додайте ці два рядки на початок Source/Chatex.Api/Program.cs:
cs
string? name = null;
Console.WriteLine(name.Length);Збирання падає з error CS8602: Dereference of a possibly null reference. Без спільних налаштувань це було б попередження, яке легко пропустити, і NullReferenceException під час виконання. Знову видаліть ці два рядки.
Крок 2. Правила стилю коду
Навіщо. Аналізаторам і IDE потрібно знати стиль проєкту: чотири пробіли чи табуляції, var чи явні типи, просторів імен у файловій формі чи блоками, які правила іменування діють. Стандартне місце для цих налаштувань – .editorconfig у корені репозиторію; його читають Visual Studio, Rider, VS Code і команда dotnet format, тож кожен розробник форматує код однаково.
Що зробити. .editorconfig у Chatex має понад 400 рядків, більшість із яких – значення за замовчуванням, виписані шаблоном dotnet new editorconfig. Завантажте його:
powershell
Invoke-WebRequest https://raw.githubusercontent.com/musicvano/Chatex/27c83c6932b902c8d8dcef01e30a3dd32c5be05f/.editorconfig -OutFile .editorconfigВідкрийте його й знайдіть частини, що відрізняються від шаблону. Спершу йдуть загальні правила: пробіли, кінці рядків LF, два пробіли у файлах XML і JSON:
ini
root = true
# All files
[*]
indent_style = space
end_of_line = lf
# Xml files
[*.xml]
indent_size = 2
# ...Наприкінці кілька правил аналізаторів навмисно вимкнено, кожне з поясненням:
ini
# EF Core migrations are generated; analyzers skip them.
[Source/Chatex.Data/Migrations/**.cs]
generated_code = true
# Analyzer rules turned off on purpose (AnalysisLevel latest-recommended in Directory.Build.props).
[*.cs]
# CA1716: Error and Result are C#-only types; VB keyword clashes do not matter here.
dotnet_diagnostic.CA1716.severity = none
# CA1000: Result<T> exposes static factory members and implicit conversions by design.
dotnet_diagnostic.CA1000.severity = none
# Test names read as sentences (Login_locks_the_account_after_five_wrong_passwords).
[Tests/**.cs]
dotnet_diagnostic.CA1707.severity = noneВимкнення правила – це рішення, тому його записано з причиною в єдиному місці, де його бачать усі. Ніколи не вимикайте попередження лише для того, щоб збирання пройшло, не розібравшись у ньому.
У Windows шаблони dotnet new записали свої файли з кінцями рядків CR LF, які нове правило end_of_line = lf відхиляє. Дозвольте dotnet format один раз привести код до стилю .editorconfig:
powershell
dotnet format Chatex.slnxПеревірка
powershell
dotnet format Chatex.slnx --verify-no-changesКоманда завершується без виводу: код відповідає стилю. Без попередньої команди вона б повідомила error ENDOFLINE: Fix end of line marker для кожного рядка Program.cs. CI виконує ту саму перевірку на кожен пуш (тема 22), а dotnet format Chatex.slnx – команда, яку слід виконати щоразу, коли вона скаржиться.
Інші файли з CR LF
dotnet format виправляє лише файли C#. Файли .csproj і JSON, створені шаблонами, у вашій папці досі мають CR LF, але .gitattributes зберігає їх із LF, коли ви їх додаєте (git add попереджає, що «CRLF will be replaced by LF»), тож репозиторій узгоджений.
Крок 3. Централізоване керування пакетами
Навіщо. Chatex використовує близько 25 пакетів NuGet. Якщо кожен проєкт записує версію кожного свого пакета, версії розходяться: рівень даних використовує EF Core 10.0.14, а тестовий проєкт – 10.0.12, і вони конфліктують під час виконання. Централізоване керування пакетами (Central Package Management, CPM) переносить усі версії в один файл – Directory.Packages.props у корені репозиторію; проєкт тоді посилається на пакет лише за назвою.
Що зробити. Створіть файл із версіями кожного пакета, який використовує підручник. Більшість із них поки не потрібні; версія, на яку жоден проєкт не посилається, нічого не робить, а перелік їх зараз позбавляє від пошуків відповідної версії згодом.
xml
<Project>
<PropertyGroup>
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
</PropertyGroup>
<ItemGroup>
<PackageVersion Include="EFCore.NamingConventions" Version="10.0.1" />
<PackageVersion Include="FluentValidation" Version="12.2.0" />
<PackageVersion Include="FluentValidation.DependencyInjectionExtensions" Version="12.2.0" />
<PackageVersion Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="10.0.14" />
<PackageVersion Include="Microsoft.AspNetCore.Identity.EntityFrameworkCore" Version="10.0.14" />
<PackageVersion Include="Microsoft.AspNetCore.Mvc.Testing" Version="10.0.14" />
<PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="10.0.14" />
<PackageVersion Include="Microsoft.AspNetCore.SignalR.Client" Version="10.0.14" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.Design" Version="10.0.14" />
<PackageVersion Include="Microsoft.Extensions.Configuration" Version="10.0.14" />
<PackageVersion Include="Microsoft.Extensions.Diagnostics.HealthChecks" Version="10.0.14" />
<PackageVersion Include="Microsoft.Extensions.Configuration.Abstractions" Version="10.0.14" />
<PackageVersion Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="10.0.14" />
<PackageVersion Include="Microsoft.Extensions.Options.DataAnnotations" Version="10.0.14" />
<PackageVersion Include="Microsoft.Extensions.TimeProvider.Testing" Version="10.11.0" />
<PackageVersion Include="Microsoft.IdentityModel.JsonWebTokens" Version="8.23.0" />
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.11.0" />
<PackageVersion Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="10.0.3" />
<PackageVersion Include="Respawn" Version="7.0.0" />
<PackageVersion Include="Scalar.AspNetCore" Version="2.18.7" />
<PackageVersion Include="Shouldly" Version="4.3.0" />
<PackageVersion Include="Testcontainers.PostgreSql" Version="4.16.0" />
<PackageVersion Include="xunit.runner.visualstudio" Version="4.0.1" />
<PackageVersion Include="xunit.v3" Version="4.0.2" />
<PackageVersion Include="xunit.v3.extensibility.core" Version="4.0.2" />
</ItemGroup>
</Project>Відтепер пакет додають до проєкту звичайною командою, наприклад dotnet add Source/Chatex.Data package Npgsql.EntityFrameworkCore.PostgreSQL. Оскільки версія вже є в Directory.Packages.props, команда записує в проєкт <PackageReference> без атрибута Version. Оновлення пакета – це зміна одного рядка в одному файлі.
Не оновлюйте версії в цьому підручнику
Лістинги, тести та знімки екрана підручника відповідають саме цим версіям. Використовуйте їх як є; оновлення пакетів – окреме завдання з власним тестуванням (вправа в контрольній точці теми 22 показує, як із цим допомагає CI).
Перевірка
dotnet build і далі закінчується Build succeeded та нулем попереджень.