CFC-Servers/gm_logger
1
0
Fork 0
mirror of https://github.com/CFC-Servers/gm_logger.git synced 2025-03-04 03:03:01 -05:00
Code Issues Releases Activity

CFCLogger -> Logger

Browse Source
This commit is contained in:
Brandon Sturgeon 2021-08-16 19:54:30 -07:00
parent 3f8060e3cb
commit 95fa518ad6
3 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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" )

2
moon/autorun/cfclogger_init.moon
View File

@ -1 +1 @@
AddCSLuaFile "includes/modules/cfclogger.lua"
AddCSLuaFile "includes/modules/logger.lua"

8
moon/includes/modules/cfclogger.moon → moon/includes/modules/logger.moon
View File

@ -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!"