From 95fa518ad621988bdfe3674163e19986f2a233f1 Mon Sep 17 00:00:00 2001 From: Brandon Sturgeon Date: Mon, 16 Aug 2021 19:54:30 -0700 Subject: [PATCH] CFCLogger -> Logger --- README.md | 16 ++++++++-------- moon/autorun/cfclogger_init.moon | 2 +- .../modules/{cfclogger.moon => logger.moon} | 8 ++++---- 3 files changed, 13 insertions(+), 13 deletions(-) rename moon/includes/modules/{cfclogger.moon => logger.moon} (91%) diff --git a/README.md b/README.md index 3ee45d2..4137971 100644 --- a/README.md +++ b/README.md @@ -26,13 +26,13 @@ git clone --single-branch --branch lua git@github.com:CFC-Servers/cfc_logger.git Assuming you can get the project cloned (some hosting interfaces may not support this), any auto-updater software should work just fine. ## Usage -CFCLogger lets you create and configure your own logging object to be used in your project. +Logger lets you create and configure your own logging object to be used in your project. Barebones usage example: ```lua -require( "cfclogger" ) +require( "logger" ) -local logger = CFCLogger( "MyProjectName" ) +local logger = Logger( "MyProjectName" ) logger:trace( "This is an trace message!" ) logger:debug( "This is an debug message!" ) @@ -63,7 +63,7 @@ As an example, if you set the default log level to `"error"`, then only `"error" ```lua require( "cfclogger" ) -local logger = CFCLogger( "MyProjectName", "error" ) +local logger = Logger( "MyProjectName", "error" ) logger:trace( "This is an trace message!" ) logger:debug( "This is an debug message!" ) @@ -85,7 +85,7 @@ For example, ```lua require( "cfclogger" ) -local logger = CFCLogger( "MyProjectName", "error" ) +local logger = Logger( "MyProjectName", "error" ) print( logger.logLevel ) @@ -121,7 +121,7 @@ local function forwardFatalToDiscord( message ) print( "Sending fatal message to discord! ( " .. message .. ")" ) end -local logger = CFCLogger( "MyProjectName" ) +local logger = Logger( "MyProjectName" ) logger:on( "fatal" ):call( forwardFatalToDiscord ) logger:fatal( "Major oof!" ) @@ -141,7 +141,7 @@ As an example: ```lua require( "cfclogger" ) -local logger = CFCLogger( "MyProject", "fatal" ) +local logger = Logger( "MyProject", "fatal" ) logger:on( "warn" ):call(function(message) print("I'm a 'warn' callback!") end) logger:warn("This is a test!") @@ -155,7 +155,7 @@ If you have a project consisting of many modules, you can easily "extend" a Logg e.g. ```lua local MyProject = {} -MyProject.Logger = CFCLogger( "MyProject" ) +MyProject.Logger = Logger( "MyProject" ) MyProject.Storage = {} MyProject.Storage.Logger = MyProject.Logger:scope( "Storage" ) diff --git a/moon/autorun/cfclogger_init.moon b/moon/autorun/cfclogger_init.moon index 95c1073..82a0c9b 100644 --- a/moon/autorun/cfclogger_init.moon +++ b/moon/autorun/cfclogger_init.moon @@ -1 +1 @@ -AddCSLuaFile "includes/modules/cfclogger.lua" +AddCSLuaFile "includes/modules/logger.lua" diff --git a/moon/includes/modules/cfclogger.moon b/moon/includes/modules/logger.moon similarity index 91% rename from moon/includes/modules/cfclogger.moon rename to moon/includes/modules/logger.moon index 83784ab..eaf662e 100644 --- a/moon/includes/modules/cfclogger.moon +++ b/moon/includes/modules/logger.moon @@ -1,14 +1,14 @@ import insert, concat, ToString from table import istable, pairs, print, tostring from _G -LOG_LEVEL_OVERRIDE = CreateConVar "cfc_logger_forced_level", "" +LOG_LEVEL_OVERRIDE = CreateConVar "logger_forced_level", "" forcedLogLevel = -> level = LOG_LEVEL_OVERRIDE\GetString! return nil if level == "" return level -export class CFCLogger +export class Logger @@severities = trace: 0 debug: 1 @@ -29,7 +29,7 @@ export class CFCLogger @_log(severity, ...) scope: (scope, logLevel=@logLevel) => - CFCLogger scope, logLevel, self + Logger scope, logLevel, self addCallbackFor: (severity, callback) => insert @callbacks[severity], callback @@ -66,4 +66,4 @@ export class CFCLogger @runCallbacksFor severity, message -CFCLogger("CFC Logger")\info "Loaded!" +Logger("CFC Logger")\info "Loaded!"