‫ساخت MSBuild SDK سفارشی در دات‌نت: خداحافظی با کدهای تکراری!

• پیکربندی پویا: بر اساس اینکه پروژه شما Web است یا Test، پکیج‌های خاصی را تزریق کند (مثلاً xUnit برای تست‌ها و OpenTelemetry برای وب).
• کنترل کامل: قبل از اینکه پروژه حتی لود شود، تنظیمات پیش‌فرض را اعمال کند.
• تمیزی فایل پروژه: صدها خط کد پیکربندی (Boilerplate) را به یک خط کاهش دهد.

• فایل Sdk.props را در ابتدای فایل پروژه ایمپورت می‌کند.
• فایل Sdk.targets را در انتهای فایل پروژه ایمپورت می‌کند.
• محتوای پروژه شما در بین این دو قرار می‌گیرد.

MyAwesome.Sdk/
├── Sdk/
│   ├── Sdk.props      ← اول اجرا می‌شود (تنظیمات پیش‌فرض)
│   └── Sdk.targets    ← آخر اجرا می‌شود (منطق بیلد)
└── MyAwesome.Sdk.csproj

نکته مهم: نام پوشه Sdk باید دقیقاً به همین شکل (حروف، بزرگ و کوچک) باشد، وگرنه MSBuild آن را پیدا نمی‌کند.

<Project>
  <PropertyGroup>
    <TargetFramework Condition="'$(TargetFramework)' == ''">net8.0</TargetFramework>
    <ImplicitUsings Condition="'$(ImplicitUsings)' == ''">enable</ImplicitUsings>

    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
  </PropertyGroup>
</Project>

<Project>
  <ItemGroup Condition="'$(EnableDefaultItems)' != 'false'">
    <None Include="**/*.config" />
  </ItemGroup>

  <Target Name="ValidateStuff" BeforeTargets="BeforeBuild">
    <Warning Condition="'$(MyRequiredProp)' == ''" 
             Text="لطفا مقدار MyRequiredProp را مشخص کنید." />
  </Target>
</Project>

<Project>
  <Import Project="Sdk.props" Sdk="Microsoft.NET.Sdk" />
  <PropertyGroup>
    <MyCustomRule>true</MyCustomRule>
  </PropertyGroup>
</Project>

<Project>
  <ItemGroup>
    <PackageReference Include="Meziantou.Analyzer" Version="2.0.0" />
  </ItemGroup>
  <Import Project="Sdk.targets" Sdk="Microsoft.NET.Sdk" />
</Project>

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
    <PackageType>MSBuildSdk</PackageType> 
    <PackageId>MyCompany.Net.Sdk</PackageId>
    <Version>1.0.0</Version>
    <IncludeBuildOutput>false</IncludeBuildOutput>
    <SuppressDependenciesWhenPacking>true</SuppressDependenciesWhenPacking>
  </PropertyGroup>

  <ItemGroup>
    <None Include="Sdk\**" Pack="true" PackagePath="Sdk" />
  </ItemGroup>
</Project>

<ItemGroup Condition="'$(IsTestProject)' == 'true'">
  <PackageReference Include="Microsoft.NET.Test.Sdk" Version="..." />
  <PackageReference Include="xunit" Version="..." />
  <PackageReference Include="coverlet.collector" Version="..." />
  
  <PackageReference Include="GitHubActionsTestLogger" Version="..." Condition="'$(GITHUB_ACTIONS)' == 'true'" />
</ItemGroup>

• راه رسمی: پکیج را با dotnet pack بسازید، یک فولدر لوکال به عنوان NuGet Source تعریف کنید و پکیج را آنجا کپی کنید. (نکته: کش NuGet دیوانه‌کننده است! هر بار ورژن را تغییر دهید، یا کش را با dotnet nuget locals all --clear پاک کنید).
• راه میانبر (توصیه شده برای توسعه): در پروژه تستی که می‌خواهید SDK را روی آن امتحان کنید، به‌جای ارجاع به پکیج، فایل‌ها را مستقیماً ایمپورت کنید:

<Project>
  <Import Project="..\..\MySdk\Sdk\Sdk.props" />
</Project>

{
  "msbuild-sdks": {
    "MyCompany.Net.Sdk": "1.0.0"
  }
}

<Project Sdk="MyCompany.Net.Sdk">
  </Project>

• Syntax شرط‌ها: همیشه در Condition از تک‌کوتیشن استفاده کنید: Condition="'$(Prop)' == ''". فراموش کردن این مورد خطای رایجی است.
• ترتیب Import: اگر تنظیمی کار نمی‌کند، احتمالاً جای اشتباهی ایمپورت شده است. پراپرتی‌ها باید قبل از استفاده تعریف شوند.
• کش NuGet: اگر تغییراتی دادید و اعمال نشد، ۹۹٪ مشکل از کش شدن پکیج قبلی توسط NuGet است.

• Creating a custom MSBuild SDK to reduce boilerplate in .NET projects
• Creating Your Own MSBuild SDK - It's Easier Than You Think!