NLog.Extensions.ThisClass by Trym Pet

NuGet / site data
Details
Original Readme
How to use
Useful

NuGet / site data

Details

Info

info

Name: NLog.Extensions.ThisClass

Create class loggers using source generators powered by Roslyn.

Author: Trym Pet

NuGet: https://www.nuget.org/packages/NLog.Extensions.ThisClass/

You can find more details at https://github.com/trympet/ThisClass

Source: https://github.com/trympet/ThisClass

Author

note

Trym Pet Alt text

Original Readme

note

ThisClass

Exposes class and type information as constants in the ThisClass class using source generators powered by Roslyn, inspired by ThisAssembly.

ThisClass

Add the ThisClassAttribute to generate type information for a class.

[ThisClass]
partial class Demo
{
    public Demo()
    {
        Logger.Info($"Hello from {ThisClass.FullName}"); // SampleApp.Demo
    }
}

NLog.Extensions.ThisClass

Create class loggers without using reflection.

using SomeNamespace;

namespace SampleApp.NLog
{
    ...
    namespace AnotherNamespace
    {
        using SomeOtherNamespace;
        [ClassLoggerLazy]
        partial class Demo2<T> : SomeInterface<T> where T : SomeOtherInterface
        {
            public static void SayHello()
            {
                Logger.Info("Hello");
            }

            [ClassLogger]
            internal partial class NestedClass : SomeInterface<SomeOtherInterface>
            {
            }
        }
    }
}

Looks like this behind the scenes

// <auto-generated/>
#nullable enable
namespace SampleApp.NLog
{
    partial class Demo1
    {
        public static partial class ThisClass
        {
            /// <summary>
            /// Gets the fully qualified name of the parent class, including the namespace but not the assembly.
            /// </summary>
            public const string FullName = "SampleApp.NLog.Demo1";
        }
    }
}

// <auto-generated/>
#nullable enable
namespace SampleApp.NLog
{
    namespace AnotherNamespace
    {
        using SomeOtherNamespace;

        partial class Demo2<T> : global::SomeNamespace.SomeInterface<T> where T : global::SomeOtherNamespace.SomeOtherInterface
        {
            public static partial class ThisClass
            {
                /// <summary>
                /// Gets the fully qualified name of the parent class, including the namespace but not the assembly.
                /// </summary>
                public const string FullName = "SampleApp.NLog.AnotherNamespace.Demo2";
            }

            private static global::NLog.Logger? __loggerLazy;
            private static global::NLog.Logger Logger => __loggerLazy ??= global::NLog.LogManager.GetLogger(ThisClass.FullName);
        }
    }
}

// <auto-generated/>
#nullable enable
namespace SampleApp.NLog
{
    namespace AnotherNamespace
    {
        using SomeOtherNamespace;

        partial class Demo2<T> : global::SomeNamespace.SomeInterface<T> where T : global::SomeOtherNamespace.SomeOtherInterface
        {
            partial class NestedClass : global::SomeNamespace.SomeInterface<global::SomeOtherNamespace.SomeOtherInterface>
            {
                public static partial class ThisClass
                {
                    /// <summary>
                    /// Gets the fully qualified name of the parent class, including the namespace but not the assembly.
                    /// </summary>
                    public const string FullName = "SampleApp.NLog.AnotherNamespace.Demo2.NestedClass";
                }

                private static readonly global::NLog.Logger Logger = global::NLog.LogManager.GetLogger(ThisClass.FullName);
            }
        }
    }
}

About

note

Generates a strongly-typed NLog Logger property per class at compile time — no manual LogManager.GetCurrentClassLogger() boilerplate.

How to use

Mark a partial class with [ClassLoggerLazy]:

 [ClassLoggerLazy]

 partial class Person

 {

     public string Name()

     {

         Logger.Error("This is an error message from the Name method.");

         return $"{FirstName} {LastName}";

     }

 }

The generated Logger is lazily initialized and scoped to the class — use it directly:

 var person = new Person \{ FirstName = "Andrei", LastName = "Ignat" };

 Console.WriteLine(person.Name()); // logs error, returns "Andrei Ignat"

You can use for Auto-wiring NLog class loggers at compile time with zero boilerplate.

How to use

Example (source csproj, source files)

CSharp Project
Program.cs
Person.cs

This is the CSharp Project that references NLog.Extensions.ThisClass

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net10.0</TargetFramework>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="NLog" Version="6.1.2" />
	  <PackageReference Include="NLog.Extensions.Logging" Version="6.1.2" />
    <PackageReference Include="NLog.Extensions.ThisClass" Version="1.6.7" />
  </ItemGroup>

  <ItemGroup>
    <None Update="NLog.config">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </None>
  </ItemGroup>

	<PropertyGroup>
		<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
		<CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)\GX</CompilerGeneratedFilesOutputPath>
	</PropertyGroup>
</Project>

This is the use of NLog.Extensions.ThisClass in Program.cs

using LogDemo;

Console.WriteLine("Hello, World!");
var person = new Person() \{ FirstName = "Andrei", LastName = "Ignat" };
Console.WriteLine(person.Name());

This is the use of NLog.Extensions.ThisClass in Person.cs

using System;
using System.Collections.Generic;
using System.Text;

namespace LogDemo;

[ClassLoggerLazy]
partial class Person
{
    public string FirstName \{ get; set; }= string.Empty;
    public string LastName \{ get; set; \} = string.Empty;

    public string Name()
    {
        Logger.Error("This is an error message from the Name method.");
        return $"{FirstName} {LastName}";
    }

}

Generated Files

Those are taken from $(BaseIntermediateOutputPath)\GX

ClassLoggerAttribute.g.cs
ClassLoggerLazyAttribute.g.cs
Person_ClassLoggerLazy.g.cs

// <auto-generated/>

using System;
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = true)]
sealed class ClassLoggerAttribute : Attribute
{
}

// <auto-generated/>

using System;
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = true)]
sealed class ClassLoggerLazyAttribute : Attribute
{
}

// <auto-generated/>
#pragma warning disable CS0108, CS1591, CS1573, CS0465, CS0649, CS8019, CS1570, CS1584, CS1658, CS0436, CS8981
#nullable enable
namespace LogDemo;
partial class Person
{
    public static partial class ThisClass
    {
        /// <summary>
        /// Gets the fully qualified name of the parent class, including the namespace but not the assembly.
        /// </summary>
        public const string FullName = "LogDemo.Person";
    }

    private static global::NLog.Logger? __loggerLazy;
    private static global::NLog.Logger Logger => __loggerLazy ??= global::NLog.LogManager.GetLogger(ThisClass.FullName);
}