CSharp-Logger 1.0.1

.NET Core 3.1 This package targets .NET Core 3.1. The package is compatible with this framework or higher. 
dotnet add package CSharp-Logger --version 1.0.1
                    


                    

                
NuGet\Install-Package CSharp-Logger -Version 1.0.1
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="CSharp-Logger" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="CSharp-Logger" Version="1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="CSharp-Logger" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add CSharp-Logger --version 1.0.1
                    


                    

                
#r "nuget: CSharp-Logger, 1.0.1"
#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. 
#:package CSharp-Logger@1.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=CSharp-Logger&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=CSharp-Logger&version=1.0.1
                    


                            Install as a Cake Tool

CSharp-Logger

A simple logging package that replicates python's logging library.

NuGet Package: soon

Installation

Just install the DLL from whatever version you choose and add it as a reference

Usage

The api is accessed via the CSharp_Logger namespace. You'll mostly be working with Logger and LogFilter when using this.

For example, say you want to write only debug and warning messages to your log file (note that the file extension must be .log)

Logger logger = new Logger();
logger.SetConfiguration(@"...\my_log.log", LogFilter.Debug | LogFilter.Warning); // A directory path is also valid and will create a file named 'cs-log.log' by default

logger.Debug("Hello world!");
logger.Error("Oh no!");
logger.Warning("Just so you know...");

Hello world! and Just so you know... would be appended to your log file. Oh no would be ignored because it is not specified in your LogFilter bitmask.

You can also attatch a method to writer calls.

Loger logger = new Logger();

logger.CatchLog += MyLogCatcher;

CatchLog has two required parameters, (Logger logger, CatchLogEvent args) CatchLogEvent exposes the type of log and message.

Other stuff

You can use LogFilterFactory to generate LogFilters cleanly

The Logger class exposes a method, ValidateFilePath, which you can use to check whether or not a path is a valid log file.

The InvalidLogFileException is called when ValidateFilePath would otherwise return null. It is also called when you attempt to use a writer method (i.e, logger.Debug()) without first setting a log file.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 was computed.  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 was computed.  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 was computed.  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.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp3.1 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • .NETCoreApp 3.1

    • 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.

Version Downloads Last Updated
1.0.1 614 7/2/2021

Changes some minor internal code