Kanject.Core.Packages.Annotations.Attributes 3.13.0

Kanject.Core.Packages.Annotations.Attributes

The attribute types for the Kanject package manager: [Package], [PackageProvider], [PackageResolverKey], [DefaultPackageProvider], [ProviderAggregator] and friends, plus the PackageLifetime enum. It contains marker types only, with no behavior. The source generator in Kanject.Core.Packages.Annotations reads these attributes and emits package managers, resolvers, and keyed DI registrations from them.

Most projects never reference this package directly. It is a dependency of Kanject.Core.Packages.Annotations, so installing the generator brings it in.

Installation

Usually you install the generator and get this package transitively:

<ItemGroup>
  <PackageReference Include="Kanject.Core.Packages" />
  <PackageReference Include="Kanject.Core.Packages.Annotations" PrivateAssets="all" />
</ItemGroup>

dotnet add package Kanject.Core.Packages.Annotations writes an IncludeAssets line that omits compile. Delete that line (keep PrivateAssets="all") — otherwise the attribute types from this package can be stripped from compilation.

Reference it directly when you want the attribute types compile-visible no matter how the generator is referenced:

dotnet add package Kanject.Core.Packages.Annotations.Attributes

Targets netstandard2.0, .NET 8, .NET 9 and .NET 10. The netstandard2.0 build is what the Roslyn generator loads; your application uses the .NET 8+ builds.

Attributes

All attributes are in the Kanject.Core.Packages.Annotations.Attributes namespace.

PackageLifetime (namespace Kanject.Core.Packages.Annotations.Attributes.Enums) has Scoped (default), Singleton, and Transient. It mirrors ServiceLifetime so this package stays dependency-free.

Example

using Kanject.Core.Packages.Annotations.Attributes;
using Kanject.Core.Packages.Annotations.Attributes.Enums;

[Package(id: "payment.gateway")]
[PackageDescription("Process order payments through third-party gateways")]
public interface IPaymentGateway
{
    Task<ChargeResult> ChargeAsync(ChargeRequest request, CancellationToken cancellationToken);
}

[Package<IPaymentGateway>]
[PackageProvider(id: "stripe.payment.gateway", version: 2, Lifetime = PackageLifetime.Singleton)]
[PackageProviderOwner("Payments team")]
[PackageResolverKey("stripe")]
[DefaultPackageProvider]
public sealed partial class StripePaymentGatewayV2 : IPaymentGateway
{
    public Task<ChargeResult> ChargeAsync(ChargeRequest request, CancellationToken cancellationToken)
        => throw new NotImplementedException();
}

The attributes do nothing on their own. The generator in Kanject.Core.Packages.Annotations turns them into code, and its analyzers check that they are used consistently. Declare [Package] interfaces in a project that runs the generator, because that project is where the manager and resolver are generated.

Related packages

License

Licensed under the Kanject Code Libraries License Agreement (KCLLA); the full text ships in this package as LICENSE.md. Organizations whose trailing-twelve-month gross revenue and total funding raised are each below US$250,000 may use it at no cost under the Free Tier. At or above either threshold a commercial license is required — contact commercial@kanjectbusiness.com.