Add godoc documentation to exported types and methods
Add proper godoc comments to exported items in: - internal/globals: Appname, Version, Commit variables; Globals type; New function - internal/log: LogLevel type; level constants; Config type; Initialize, Fatal, Error, Warn, Notice, Info, Debug functions and variants; TTYHandler type and methods; Module variable; LogOptions type
This commit is contained in:
@@ -12,19 +12,25 @@ import (
|
||||
"golang.org/x/term"
|
||||
)
|
||||
|
||||
// LogLevel represents the logging level
|
||||
// LogLevel represents the logging level.
|
||||
type LogLevel int
|
||||
|
||||
const (
|
||||
// LevelFatal represents a fatal error level that will exit the program.
|
||||
LevelFatal LogLevel = iota
|
||||
// LevelError represents an error level.
|
||||
LevelError
|
||||
// LevelWarn represents a warning level.
|
||||
LevelWarn
|
||||
// LevelNotice represents a notice level (mapped to Info in slog).
|
||||
LevelNotice
|
||||
// LevelInfo represents an informational level.
|
||||
LevelInfo
|
||||
// LevelDebug represents a debug level.
|
||||
LevelDebug
|
||||
)
|
||||
|
||||
// Logger configuration
|
||||
// Config holds logger configuration.
|
||||
type Config struct {
|
||||
Verbose bool
|
||||
Debug bool
|
||||
@@ -33,7 +39,7 @@ type Config struct {
|
||||
|
||||
var logger *slog.Logger
|
||||
|
||||
// Initialize sets up the global logger based on the provided configuration
|
||||
// Initialize sets up the global logger based on the provided configuration.
|
||||
func Initialize(cfg Config) {
|
||||
// Determine log level based on configuration
|
||||
var level slog.Level
|
||||
@@ -76,7 +82,7 @@ func getCaller(skip int) string {
|
||||
return fmt.Sprintf("%s:%d", filepath.Base(file), line)
|
||||
}
|
||||
|
||||
// Fatal logs a fatal error and exits
|
||||
// Fatal logs a fatal error message and exits the program with code 1.
|
||||
func Fatal(msg string, args ...any) {
|
||||
if logger != nil {
|
||||
// Add caller info to args
|
||||
@@ -86,12 +92,12 @@ func Fatal(msg string, args ...any) {
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
// Fatalf logs a formatted fatal error and exits
|
||||
// Fatalf logs a formatted fatal error message and exits the program with code 1.
|
||||
func Fatalf(format string, args ...any) {
|
||||
Fatal(fmt.Sprintf(format, args...))
|
||||
}
|
||||
|
||||
// Error logs an error
|
||||
// Error logs an error message.
|
||||
func Error(msg string, args ...any) {
|
||||
if logger != nil {
|
||||
args = append(args, "caller", getCaller(2))
|
||||
@@ -99,12 +105,12 @@ func Error(msg string, args ...any) {
|
||||
}
|
||||
}
|
||||
|
||||
// Errorf logs a formatted error
|
||||
// Errorf logs a formatted error message.
|
||||
func Errorf(format string, args ...any) {
|
||||
Error(fmt.Sprintf(format, args...))
|
||||
}
|
||||
|
||||
// Warn logs a warning
|
||||
// Warn logs a warning message.
|
||||
func Warn(msg string, args ...any) {
|
||||
if logger != nil {
|
||||
args = append(args, "caller", getCaller(2))
|
||||
@@ -112,12 +118,12 @@ func Warn(msg string, args ...any) {
|
||||
}
|
||||
}
|
||||
|
||||
// Warnf logs a formatted warning
|
||||
// Warnf logs a formatted warning message.
|
||||
func Warnf(format string, args ...any) {
|
||||
Warn(fmt.Sprintf(format, args...))
|
||||
}
|
||||
|
||||
// Notice logs a notice (mapped to Info level)
|
||||
// Notice logs a notice message (mapped to Info level).
|
||||
func Notice(msg string, args ...any) {
|
||||
if logger != nil {
|
||||
args = append(args, "caller", getCaller(2))
|
||||
@@ -125,12 +131,12 @@ func Notice(msg string, args ...any) {
|
||||
}
|
||||
}
|
||||
|
||||
// Noticef logs a formatted notice
|
||||
// Noticef logs a formatted notice message.
|
||||
func Noticef(format string, args ...any) {
|
||||
Notice(fmt.Sprintf(format, args...))
|
||||
}
|
||||
|
||||
// Info logs an info message
|
||||
// Info logs an informational message.
|
||||
func Info(msg string, args ...any) {
|
||||
if logger != nil {
|
||||
args = append(args, "caller", getCaller(2))
|
||||
@@ -138,12 +144,12 @@ func Info(msg string, args ...any) {
|
||||
}
|
||||
}
|
||||
|
||||
// Infof logs a formatted info message
|
||||
// Infof logs a formatted informational message.
|
||||
func Infof(format string, args ...any) {
|
||||
Info(fmt.Sprintf(format, args...))
|
||||
}
|
||||
|
||||
// Debug logs a debug message
|
||||
// Debug logs a debug message.
|
||||
func Debug(msg string, args ...any) {
|
||||
if logger != nil {
|
||||
args = append(args, "caller", getCaller(2))
|
||||
@@ -151,12 +157,12 @@ func Debug(msg string, args ...any) {
|
||||
}
|
||||
}
|
||||
|
||||
// Debugf logs a formatted debug message
|
||||
// Debugf logs a formatted debug message.
|
||||
func Debugf(format string, args ...any) {
|
||||
Debug(fmt.Sprintf(format, args...))
|
||||
}
|
||||
|
||||
// With returns a logger with additional context
|
||||
// With returns a logger with additional context attributes.
|
||||
func With(args ...any) *slog.Logger {
|
||||
if logger != nil {
|
||||
return logger.With(args...)
|
||||
@@ -164,12 +170,12 @@ func With(args ...any) *slog.Logger {
|
||||
return slog.Default()
|
||||
}
|
||||
|
||||
// WithContext returns a logger with context
|
||||
// WithContext returns a logger with the provided context.
|
||||
func WithContext(ctx context.Context) *slog.Logger {
|
||||
return logger
|
||||
}
|
||||
|
||||
// Logger returns the underlying slog.Logger
|
||||
// Logger returns the underlying slog.Logger instance.
|
||||
func Logger() *slog.Logger {
|
||||
return logger
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user