Ling.Audit 2.0.0

.NET 5.0 This package targets .NET 5.0. The package is compatible with this framework or higher. .NET Core 3.1 This package targets .NET Core 3.1. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package Ling.Audit --version 2.0.0                

                    
                

            
NuGet\Install-Package Ling.Audit -Version 2.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Ling.Audit" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Ling.Audit --version 2.0.0                

                    
                

            
#r "nuget: Ling.Audit, 2.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Ling.Audit as a Cake Addin
#addin nuget:?package=Ling.Audit&version=2.0.0

// Install Ling.Audit as a Cake Tool
#tool nuget:?package=Ling.Audit&version=2.0.0

Ling.Audit

A source generator for automatically implementing audit properties in C# classes.

Basic Usage

// Implement the interface you need
public partial class Post : ICreationAudited<int?>
{
    public string Title { get; set; }
}

// Properties are automatically generated
partial class Post
{
    public int? CreatedBy { get; set; }
    public DateTimeOffset CreatedAt { get; set; }
}

Available Interfaces

Basic Interfaces

Interface Properties Description
IHasCreator<TKey> CreatedBy Records who created the entity
IHasCreationTime CreatedAt Records when the entity was created
IHasModifier<TKey> LastModifiedBy Records who last modified the entity
IHasModificationTime LastModifiedAt Records when the entity was last modified
ISoftDelete IsDeleted Marks if the entity is soft deleted
IHasDeleter<TKey> DeletedBy Records who deleted the entity
IHasDeletionTime DeletedAt Records when the entity was deleted

Composite Interfaces

Interface Properties Description
ICreationAudited<TKey> CreatedBy, CreatedAt Full creation auditing
IModificationAudited<TKey> LastModifiedBy, LastModifiedAt Full modification auditing
IDeletionAudited<TKey> IsDeleted, DeletedBy, DeletedAt Full deletion auditing
IFullAudited<TKey> All above Complete auditing support

Advanced Usage

Using Multiple Basic Interfaces

public partial class Post :
    IHasCreator<int?>,      // Adds CreatedBy
    IHasCreationTime        // Adds CreatedAt
{
}

💡 Tip: Use ICreationAudited<TKey> instead for better maintainability.

Sealed Classes

public sealed partial class Post : ICreationAudited<int?>
{
    // Generated properties won't be virtual
}

Generic Types

public partial class Post<TKey> : ICreationAudited<TKey>
    where TKey : struct
{
}

Nested Types

public partial class Blog
{
    public partial class Post : ICreationAudited<int?>
    {
    }
}

Best Practices

  1. Use composite interfaces instead of basic ones
  2. Make your classes partial
  3. Use consistent key types across your entities
  4. Consider using nullable reference types
  5. Follow the analyzer suggestions

API Reference

For detailed API documentation, visit our GitHub repository.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 is compatible. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • .NETCoreApp 3.1

    • No dependencies.

  • .NETStandard 2.0

    • No dependencies.

  • net5.0

    • No dependencies.

  • net6.0

    • No dependencies.

  • net7.0

    • No dependencies.

  • net8.0

    • No dependencies.

  • net9.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

https://github.com/ling921/ling-audit/releases