Rename package to slogdedup

README.md

@@ -40,10 +40,16 @@ With this in mind, this repo was created with several different ways of deduplic
 ## Install
 `go get github.com/veqryn/slog-dedup`
 
+```go
+import (
+	slogdedup "github.com/veqryn/slog-dedup"
+)
+```
+
 ## Usage
 ### Overwrite Older Duplicates Handler
 ```go
-logger := slog.New(dedup.NewOverwriteHandler(slog.NewJSONHandler(os.Stdout, nil), nil))
+logger := slog.New(slogdedup.NewOverwriteHandler(slog.NewJSONHandler(os.Stdout, nil), nil))
 logger.Info("this is the dedup overwrite handler",
     slog.String("duplicated", "zero"),
     slog.String("duplicated", "one"),
@@ -62,7 +68,7 @@ Outputs:
 
 ### Ignore Newer Duplicates Handler
 ```go
-logger := slog.New(dedup.NewIgnoreHandler(slog.NewJSONHandler(os.Stdout, nil), nil))
+logger := slog.New(slogdedup.NewIgnoreHandler(slog.NewJSONHandler(os.Stdout, nil), nil))
 logger.Info("this is the dedup ignore handler",
     slog.String("duplicated", "zero"),
     slog.String("duplicated", "one"),
@@ -81,7 +87,7 @@ Outputs:
 
 ### Increment Newer Duplicate Key Names Handler
 ```go
-logger := slog.New(dedup.NewIncrementHandler(slog.NewJSONHandler(os.Stdout, nil), nil))
+logger := slog.New(slogdedup.NewIncrementHandler(slog.NewJSONHandler(os.Stdout, nil), nil))
 logger.Info("this is the dedup incrementer handler",
     slog.String("duplicated", "zero"),
     slog.String("duplicated", "one"),
@@ -102,7 +108,7 @@ Outputs:
 
 ### Append Duplicates Together in an Array Handler
 ```go
-logger := slog.New(dedup.NewAppendHandler(slog.NewJSONHandler(os.Stdout, nil), nil))
+logger := slog.New(slogdedup.NewAppendHandler(slog.NewJSONHandler(os.Stdout, nil), nil))
 logger.Info("this is the dedup appender handler",
     slog.String("duplicated", "zero"),
     slog.String("duplicated", "one"),
@@ -131,12 +137,12 @@ import (
 	"log/slog"
 	"os"
 
-	dedup "github.com/veqryn/slog-dedup"
+	slogdedup "github.com/veqryn/slog-dedup"
 )
 
 func main() {
 	// OverwriteHandler
-	overwriter := dedup.NewOverwriteHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
+	overwriter := slogdedup.NewOverwriteHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
 	slog.SetDefault(slog.New(overwriter))
 
 	/*
@@ -154,7 +160,7 @@ func main() {
 	)
 
 	// IgnoreHandler
-	ignorer := dedup.NewIgnoreHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
+	ignorer := slogdedup.NewIgnoreHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
 	slog.SetDefault(slog.New(ignorer))
 
 	/*
@@ -172,7 +178,7 @@ func main() {
 	)
 
 	// IncrementHandler
-	incrementer := dedup.NewIncrementHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
+	incrementer := slogdedup.NewIncrementHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
 	slog.SetDefault(slog.New(incrementer))
 
 	/*
@@ -192,7 +198,7 @@ func main() {
 	)
 
 	// AppendHandler
-	appender := dedup.NewAppendHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
+	appender := slogdedup.NewAppendHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
 	slog.SetDefault(slog.New(appender))
 
 	/*
@@ -215,6 +221,21 @@ func main() {
 }
 ```
 
+## Breaking Changes
+### O.1.0 -> 0.2.0
+Package renamed from `dedup` to `slogdedup`.
+To fix, change this:
+```go
+import "github.com/veqryn/slog-dedup"
+var overwriter = dedup.NewOverwriteHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
+```
+To this:
+```go
+import "github.com/veqryn/slog-dedup"
+var overwriter = slogdedup.NewOverwriteHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
+```
+Named imports are unaffected.
+
 ## Other Details
 ### Overwrite Handler
 Using an overwrite handler allows a slightly different style of logging that is less verbose. As an application moves deeper into domain functions, it is common that additional details or knowledge is uncovered. By overwriting keys with better and more explanatory values as you go, the final log lines are often easier to read and more informative.

append_handler.go

@@ -1,4 +1,4 @@
-package dedup
+package slogdedup
 
 import (
 	"context"

append_handler_test.go

@@ -1,4 +1,4 @@
-package dedup
+package slogdedup
 
 import (
 	"log/slog"

doc.go

@@ -1,5 +1,5 @@
 /*
-Package dedup provides structured logging (slog) deduplication for use with json logging
+Package slogdedup provides structured logging (slog) deduplication for use with json logging
 (or any other format where duplicates are not appreciated).
 The main impetus behind this package is because most JSON tools do not like duplicate keys for their member
 properties/fields. Some of them will give errors or fail to parse the log line, and some may even crash.
@@ -8,7 +8,7 @@ Unfortunately the default behavior of the stdlib slog handlers is to allow dupli
 Usage:
 
 	// OverwriteHandler
-	overwriter := dedup.NewOverwriteHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
+	overwriter := slogdedup.NewOverwriteHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
 	slog.SetDefault(slog.New(overwriter))
 
 	// {
@@ -24,7 +24,7 @@ Usage:
 	)
 
 	// IgnoreHandler
-	ignorer := dedup.NewIgnoreHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
+	ignorer := slogdedup.NewIgnoreHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
 	slog.SetDefault(slog.New(ignorer))
 
 	// {
@@ -40,7 +40,7 @@ Usage:
 	)
 
 	// IncrementHandler
-	incrementer := dedup.NewIncrementHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
+	incrementer := slogdedup.NewIncrementHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
 	slog.SetDefault(slog.New(incrementer))
 
 	// {
@@ -58,7 +58,7 @@ Usage:
 	)
 
 	// AppendHandler
-	appender := dedup.NewAppendHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
+	appender := slogdedup.NewAppendHandler(slog.NewJSONHandler(os.Stdout, nil), nil)
 	slog.SetDefault(slog.New(appender))
 
 	// {
@@ -77,4 +77,4 @@ Usage:
 		slog.String("duplicated", "two"),
 	)
 */
-package dedup
+package slogdedup

helpers.go

@@ -1,4 +1,4 @@
-package dedup
+package slogdedup
 
 import (
 	"fmt"

helpers_test.go

@@ -1,4 +1,4 @@
-package dedup
+package slogdedup
 
 import (
 	"bytes"

ignore_handler.go

@@ -1,4 +1,4 @@
-package dedup
+package slogdedup
 
 import (
 	"context"

ignore_handler_test.go

@@ -1,4 +1,4 @@
-package dedup
+package slogdedup
 
 import (
 	"strings"

increment_handler.go

@@ -1,4 +1,4 @@
-package dedup
+package slogdedup
 
 import (
 	"context"

increment_handler_test.go

@@ -1,4 +1,4 @@
-package dedup
+package slogdedup
 
 import (
 	"strings"

overwrite_handler.go

@@ -1,4 +1,4 @@
-package dedup
+package slogdedup
 
 import (
 	"context"

overwrite_handler_test.go

@@ -1,4 +1,4 @@
-package dedup
+package slogdedup
 
 import (
 	"log/slog"