v0.1.0 Release

compat/builder.go

@@ -7,22 +7,22 @@ import (
 	"github.com/lixenwraith/log"
 )
 
-// Builder provides a flexible way to create configured logger adapters for gnet and fasthttp.
-// It can use an existing *log.Logger instance or create a new one from a *log.Config.
+// Builder provides a flexible way to create configured logger adapters for gnet and fasthttp
+// It can use an existing *log.Logger instance or create a new one from a *log.Config
 type Builder struct {
 	logger *log.Logger
 	logCfg *log.Config
 	err    error
 }
 
-// NewBuilder creates a new adapter builder.
+// NewBuilder creates a new adapter builder
 func NewBuilder() *Builder {
 	return &Builder{}
 }
 
-// WithLogger specifies an existing logger to use for the adapters. This is the recommended
-// approach for applications that already have a central logger instance.
-// If this is set, any configuration passed via WithConfig is ignored.
+// WithLogger specifies an existing logger to use for the adapters
+// Recommended for applications that already have a central logger instance
+// If this is set WithConfig is ignored
 func (b *Builder) WithLogger(l *log.Logger) *Builder {
 	if l == nil {
 		b.err = fmt.Errorf("log/compat: provided logger cannot be nil")
@@ -32,46 +32,45 @@ func (b *Builder) WithLogger(l *log.Logger) *Builder {
 	return b
 }
 
-// WithConfig provides a configuration for a new logger instance.
-// This is used only if an existing logger is NOT provided via WithLogger.
-// If neither WithLogger nor WithConfig is used, a default logger will be created.
+// WithConfig provides a configuration for a new logger instance
+// This is used only if an existing logger is NOT provided via WithLogger
+// If neither WithLogger nor WithConfig is used, a default logger will be created
 func (b *Builder) WithConfig(cfg *log.Config) *Builder {
 	b.logCfg = cfg
 	return b
 }
 
-// getLogger resolves the logger to be used, creating one if necessary.
-// It's called internally by the build methods.
+// getLogger resolves the logger to be used, creating one if necessary
 func (b *Builder) getLogger() (*log.Logger, error) {
 	if b.err != nil {
 		return nil, b.err
 	}
 
-	// An existing logger was provided, so we use it.
+	// An existing logger was provided, so we use it
 	if b.logger != nil {
 		return b.logger, nil
 	}
 
-	// Create a new logger instance.
+	// Create a new logger instance
 	l := log.NewLogger()
 	cfg := b.logCfg
 	if cfg == nil {
-		// If no config was provided, use the default.
+		// If no config was provided, use the default
 		cfg = log.DefaultConfig()
 	}
 
-	// Apply the configuration.
+	// Apply the configuration
 	if err := l.ApplyConfig(cfg); err != nil {
 		return nil, err
 	}
 
-	// Cache the newly created logger for subsequent builds with this builder.
+	// Cache the newly created logger for subsequent builds with this builder
 	b.logger = l
 	return l, nil
 }
 
-// BuildGnet creates a gnet adapter.
-// It can be used for servers that require a standard gnet logger.
+// BuildGnet creates a gnet adapter
+// It can be used for servers that require a standard gnet logger
 func (b *Builder) BuildGnet(opts ...GnetOption) (*GnetAdapter, error) {
 	l, err := b.getLogger()
 	if err != nil {
@@ -81,7 +80,7 @@ func (b *Builder) BuildGnet(opts ...GnetOption) (*GnetAdapter, error) {
 }
 
 // BuildStructuredGnet creates a gnet adapter that attempts to extract structured
-// fields from log messages for richer, queryable logs.
+// fields from log messages for richer, queryable logs
 func (b *Builder) BuildStructuredGnet(opts ...GnetOption) (*StructuredGnetAdapter, error) {
 	l, err := b.getLogger()
 	if err != nil {
@@ -90,7 +89,7 @@ func (b *Builder) BuildStructuredGnet(opts ...GnetOption) (*StructuredGnetAdapte
 	return NewStructuredGnetAdapter(l, opts...), nil
 }
 
-// BuildFastHTTP creates a fasthttp adapter.
+// BuildFastHTTP creates a fasthttp adapter
 func (b *Builder) BuildFastHTTP(opts ...FastHTTPOption) (*FastHTTPAdapter, error) {
 	l, err := b.getLogger()
 	if err != nil {
@@ -99,8 +98,8 @@ func (b *Builder) BuildFastHTTP(opts ...FastHTTPOption) (*FastHTTPAdapter, error
 	return NewFastHTTPAdapter(l, opts...), nil
 }
 
-// GetLogger returns the underlying *log.Logger instance.
-// If a logger has not been provided or created yet, it will be initialized.
+// GetLogger returns the underlying *log.Logger instance
+// If a logger has not been provided or created yet, it will be initialized
 func (b *Builder) GetLogger() (*log.Logger, error) {
 	return b.getLogger()
 }
@@ -108,9 +107,9 @@ func (b *Builder) GetLogger() (*log.Logger, error) {
 // --- Example Usage ---
 //
 // The following demonstrates how to integrate lixenwraith/log with gnet and fasthttp
-// using a single, shared logger instance.
+// using a single, shared logger instance
 //
-//	// 1. Create and configure your application's main logger.
+//	// 1. Create and configure application's main logger
 //	appLogger := log.NewLogger()
 //	logCfg := log.DefaultConfig()
 //	logCfg.Level = log.LevelDebug
@@ -118,25 +117,25 @@ func (b *Builder) GetLogger() (*log.Logger, error) {
 //		panic(fmt.Sprintf("failed to configure logger: %v", err))
 //	}
 //
-//	// 2. Create a builder and provide the existing logger.
+//	// 2. Create a builder and provide the existing logger
 //	builder := compat.NewBuilder().WithLogger(appLogger)
 //
-//	// 3. Build the required adapters.
+//	// 3. Build the required adapters
 //	gnetLogger, err := builder.BuildGnet()
 //	if err != nil { /* handle error */ }
 //
 //	fasthttpLogger, err := builder.BuildFastHTTP()
 //	if err != nil { /* handle error */ }
 //
-//	// 4. Configure your servers with the adapters.
+//	// 4. Configure your servers with the adapters
 //
 //	// For gnet:
 //	var events gnet.EventHandler // your-event-handler
-//	// The adapter is passed directly into the gnet options.
+//	// The adapter is passed directly into the gnet options
 //	go gnet.Run(events, "tcp://:9000", gnet.WithLogger(gnetLogger))
 //
 //	// For fasthttp:
-//	// The adapter is assigned directly to the server's Logger field.
+//	// The adapter is assigned directly to the server's Logger field
 //	server := &fasthttp.Server{
 //		Handler: func(ctx *fasthttp.RequestCtx) {
 //			ctx.WriteString("Hello, world!")