ANcpLua.NET.Sdk 1.2.4

ANcpLua.NET.Sdk

MSBuild SDK with opinionated defaults for .NET projects. Inspired by Meziantou.NET.Sdk.

SDKs

Installation

Replace your SDK reference:

<Project Sdk="ANcpLua.NET.Sdk/1.2.0"></Project>


<Project Sdk="ANcpLua.NET.Sdk.Web/1.2.0"></Project>

Or use global.json for centralized version management:

{
  "msbuild-sdks": {
    "ANcpLua.NET.Sdk": "1.2.0",
    "ANcpLua.NET.Sdk.Web": "1.2.0"
  }
}

Then reference without version:

<Project Sdk="ANcpLua.NET.Sdk"></Project>

Working Features

Banned API Analyzer (RS0030)

Enforces best practices via BannedSymbols.txt:

ANcpLua.Analyzers (Bundled)

See ANcpLua.Analyzers for all 13 rules.

Extensions (Auto-Enabled by Default)

Extensions (Opt-in)

<details> <summary><b>SourceGen Helpers</b> - what's included</summary>

• EquatableArray<T> - IEquatable wrapper for ImmutableArray (incremental generator caching)
• DiagnosticInfo / DiagnosticsExtensions - Simplified diagnostic creation
• SymbolExtensions - HasAttribute, GetAttribute, IsOrInheritsFrom, ImplementsInterface, GetMethod, GetProperty
• SyntaxExtensions - GetMethodName, GetIdentifierName, HasModifier
• SemanticModelExtensions - IsConstant, AllConstant, GetConstantValueOrDefault
• CompilationExtensions - IsCSharp9OrGreater, IsCSharp10OrGreater, IsCSharp11OrGreater
• SyntaxValueProvider helpers - ForClassesWithAttribute, ForMethodsWithAttribute
• EnumerableExtensions - SelectManyOrEmpty, OrEmpty, ToImmutableArrayOrEmpty, HasDuplicates
• FileExtensions - WriteIfChangedAsync (avoid unnecessary file writes)
• LocationInfo, EquatableMessageArgs - Equatable records for caching

Note: For analyzers, CLI tools, or test projects, use ANcpLua.Roslyn.Utilities NuGet package instead. The embedded source approach is specifically for source generators which cannot easily reference NuGet packages.

</details>

Polyfills (Opt-in for Legacy TFMs)

C# 14 Extension Member Polyfills

Modern throw helpers using C# 14 extension(Type) syntax. Available on all targets:

// .NET 6+ style APIs - work everywhere!
ArgumentNullException.ThrowIfNull(myArg);
ArgumentException.ThrowIfNullOrEmpty(myString);
ArgumentException.ThrowIfNullOrWhiteSpace(myString);
ArgumentOutOfRangeException.ThrowIfNegative(count);
ArgumentOutOfRangeException.ThrowIfZero(count);
ArgumentOutOfRangeException.ThrowIfNegativeOrZero(count);
ArgumentOutOfRangeException.ThrowIfGreaterThan(value, max);
ArgumentOutOfRangeException.ThrowIfLessThan(value, min);
ObjectDisposedException.ThrowIf(isDisposed, this);

Configuration

Web Service Defaults (Auto-Registered for Web Projects)

When using Microsoft.NET.Sdk.Web, the SDK automatically adds Aspire 13.0-compatible service defaults:

Opt-out: <AutoRegisterServiceDefaults>false</AutoRegisterServiceDefaults>

Running Tests Correctly

The test suite simulates an environment where the SDK is packed and consumed. To avoid performance issues caused by parallel tests trying to repack the SDK simultaneously, use the following command:

# 1. Ensure artifacts are built (if running for the first time)
# Note: The test fixture will auto-build if artifacts/nuget is empty,
# but for optimal performance, set up the environment variables.

# 2. Run tests pointing to the artifacts directory
export CI=true
export NUGET_DIRECTORY="$(pwd)/artifacts"
dotnet test tests/ANcpLua.Sdk.Tests

License

MIT

Credits

• Inspired by Meziantou.NET.Sdk by Gérald Barré
• ServiceDefaults pattern from .NET Aspire