Browse Source

Breaking: Rename functions in `Printf` format

master
IamTheFij 3 months ago
parent
commit
eb305d5e40
  1. 5
      .pre-commit-config.yaml
  2. 42
      README.md
  3. 41
      slog.go

5
.pre-commit-config.yaml

@ -1,7 +1,7 @@
---
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v2.4.0
rev: v3.4.0
hooks:
- id: check-added-large-files
- id: trailing-whitespace
@ -12,5 +12,4 @@ repos:
hooks:
- id: go-fmt
- id: go-imports
# - id: gometalinter
# - id: golangci-lint
- id: golangci-lint

42
README.md

@ -35,29 +35,32 @@ Also provided are a few simple methods for handling returned `error` variables,
FUNCTIONS
func Debug(format string, v ...interface{})
Debug will log with a DEBUG prefix if DebugLevel is se
func Debugf(format string, v ...interface{})
Debugf will log with a DEBUG prefix if DebugLevel is se
func Error(format string, v ...interface{})
Error will log with a ERROR prefix
func Errorf(format string, v ...interface{})
Errorf will log with a ERROR prefix
func Fatal(format string, v ...interface{})
Fatal will log with a ERROR prefix followed by exit(1)
func Fatalf(format string, v ...interface{})
Fatalf will log with a ERROR prefix followed by exit(1)
func FatalOnErr(err error, format string, v ...interface{})
FatalOnErr if error provided, will log out details of an error and exi
func Infof(format string, v ...interface{})
Infof formats logs with an INFO prefix
func Info(format string, v ...interface{})
Info formats logs with an INFO prefix
func Logf(format string, v ...interface{})
Logf formats logs directly to the main logger
func Log(format string, v ...interface{})
Log formats logs directly to the main logger
func OnErrFatalf(err error, format string, v ...interface{})
OnErrFatalf if error provided, will log out details of an error and exi
func Panic(format string, v ...interface{})
Panic will log with a ERROR prefix followed by panic()
func OnErrPanicf(err error, format string, v ...interface{})
OnErrPanicf if error provided, will log out details of an error and exi
func PanicOnErr(err error, format string, v ...interface{})
PanicOnErr if error provided, will log out details of an error and exi
func OnErrWarnf(err error, format string, v ...interface{})
OnErrWarnf if error provided, will provide a warning if an error is provided
func Panicf(format string, v ...interface{})
Panicf will log with a ERROR prefix followed by panic()
func SetFlags(flag int)
SetFlags allows changing the logger flags using flags found in `log`
@ -65,8 +68,5 @@ Also provided are a few simple methods for handling returned `error` variables,
func SetOutput(w io.Writer)
SetOutput allows changing the output of all loggers
func WarnOnErr(err error, format string, v ...interface{})
WarnOnErr if error provided, will provide a warning if an error is provided
func Warning(format string, v ...interface{})
Warning will log with a WARNING prefix
func Warningf(format string, v ...interface{})
Warningf will log with a WARNING prefix

41
slog.go

@ -49,62 +49,63 @@ func SetOutput(w io.Writer) {
}
}
// Log formats logs directly to the main logger
func Log(format string, v ...interface{}) {
// Logf formats logs directly to the main logger
func Logf(format string, v ...interface{}) {
log.Printf(format, v...)
}
// Debug will log with a DEBUG prefix if DebugLevel is set
func Debug(format string, v ...interface{}) {
// Debugf will log with a DEBUG prefix if DebugLevel is set
func Debugf(format string, v ...interface{}) {
if !DebugLevel {
return
}
LoggerDebug.Printf(format, v...)
}
// Info formats logs with an INFO prefix
func Info(format string, v ...interface{}) {
// Infof formats logs with an INFO prefix
func Infof(format string, v ...interface{}) {
LoggerInfo.Printf(format, v...)
}
// Warning will log with a WARNING prefix
func Warning(format string, v ...interface{}) {
// Warningf will log with a WARNING prefix
func Warningf(format string, v ...interface{}) {
LoggerWarning.Printf(format, v...)
}
// Error will log with a ERROR prefix
func Error(format string, v ...interface{}) {
// Errorf will log with a ERROR prefix
func Errorf(format string, v ...interface{}) {
LoggerError.Printf(format, v...)
}
// Fatal will log with a ERROR prefix followed by exit(1)
func Fatal(format string, v ...interface{}) {
// Fatalf will log with a ERROR prefix followed by exit(1)
func Fatalf(format string, v ...interface{}) {
LoggerError.Fatalf(format, v...)
}
// Panic will log with a ERROR prefix followed by panic()
func Panic(format string, v ...interface{}) {
// Panicf will log with a ERROR prefix followed by panic()
func Panicf(format string, v ...interface{}) {
LoggerError.Panicf(format, v...)
}
// WarnOnErr if error provided, will provide a warning if an error is provided
func WarnOnErr(err error, format string, v ...interface{}) {
// OnErrWarnf if error provided, will provide a warning if an error is provided
func OnErrWarnf(err error, format string, v ...interface{}) {
if err != nil {
LoggerWarning.Printf(format, v...)
LoggerError.Print(err)
}
}
// FatalOnErr if error provided, will log out details of an error and exit
func FatalOnErr(err error, format string, v ...interface{}) {
// OnErrFatalf if error provided, will log out details of an error and exit
func OnErrFatalf(err error, format string, v ...interface{}) {
if err != nil {
LoggerError.Printf(format, v...)
LoggerError.Fatal(err)
}
}
// PanicOnErr if error provided, will log out details of an error and exit
func PanicOnErr(err error, format string, v ...interface{}) {
// OnErrPanicf if error provided, will log out details of an error and exit
func OnErrPanicf(err error, format string, v ...interface{}) {
if err != nil {
LoggerError.Printf(format, v...)
LoggerError.Panic(err)

Loading…
Cancel
Save