feat: Add support to disable stringer

godump.go

@@ -29,11 +29,12 @@ const (
 
 // Default configuration values for the Dumper.
 const (
-	defaultMaxDepth      = 15
-	defaultMaxItems      = 100
-	defaultMaxStringLen  = 100000
-	defaultMaxStackDepth = 10
-	initialCallerSkip    = 2
+	defaultDisableStringer = false
+	defaultMaxDepth        = 15
+	defaultMaxItems        = 100
+	defaultMaxStringLen    = 100000
+	defaultMaxStackDepth   = 10
+	initialCallerSkip      = 2
 )
 
 // defaultDumper is the default Dumper instance used by Dump and DumpStr functions.
@@ -90,6 +91,7 @@ type Dumper struct {
 	maxStringLen       int
 	writer             io.Writer
 	skippedStackFrames int
+	disableStringer    bool
 
 	// callerFn is used to get the caller information.
 	// It defaults to [runtime.Caller], it is here to be overridden for testing purposes.
@@ -156,16 +158,26 @@ func WithSkipStackFrames(n int) Option {
 	}
 }
 
+// WithDisableStringer will determine if the stringer value for types that
+// implement the stringer interface should be render instead of the actual type.
+func WithDisableStringer(b bool) Option {
+	return func(d *Dumper) *Dumper {
+		d.disableStringer = b
+		return d
+	}
+}
+
 // NewDumper creates a new Dumper with the given options applied.
 // Defaults are used for any setting not overridden.
 func NewDumper(opts ...Option) *Dumper {
 	d := &Dumper{
-		maxDepth:     defaultMaxDepth,
-		maxItems:     defaultMaxItems,
-		maxStringLen: defaultMaxStringLen,
-		writer:       os.Stdout,
-		colorizer:    nil, // ensure no detection is made if we don't need it
-		callerFn:     runtime.Caller,
+		maxDepth:        defaultMaxDepth,
+		maxItems:        defaultMaxItems,
+		maxStringLen:    defaultMaxStringLen,
+		disableStringer: defaultDisableStringer,
+		writer:          os.Stdout,
+		colorizer:       nil, // ensure no detection is made if we don't need it
+		callerFn:        runtime.Caller,
 	}
 	for _, opt := range opts {
 		d = opt(d)
@@ -472,11 +484,7 @@ func (d *Dumper) printValue(w io.Writer, v reflect.Value, indent int, visited ma
 			}
 			indentPrint(w, indent+1, d.colorize(colorYellow, symbol)+field.Name)
 			fmt.Fprint(w, "	=> ")
-			if s := d.asStringer(fieldVal); s != "" {
-				fmt.Fprint(w, s)
-			} else {
-				d.printValue(w, fieldVal, indent+1, visited)
-			}
+			d.printValue(w, fieldVal, indent+1, visited)
 			fmt.Fprintln(w)
 		}
 		indentPrint(w, indent, "")
@@ -553,6 +561,10 @@ func (d *Dumper) printValue(w io.Writer, v reflect.Value, indent int, visited ma
 
 // asStringer checks if the value implements fmt.Stringer and returns its string representation.
 func (d *Dumper) asStringer(v reflect.Value) string {
+	if d.disableStringer {
+		return ""
+	}
+
 	val := v
 	if !val.CanInterface() {
 		val = forceExported(val)

godump_test.go

@@ -663,7 +663,6 @@ func TestTheKitchenSink(t *testing.T) {
 	// Ensure no panic occurred and a sane dump was produced
 	assert.Contains(t, out, "#")          // loosest
 	assert.Contains(t, out, "Everything") // middle-ground
-
 }
 
 func TestForceExportedFallback(t *testing.T) {
@@ -1047,5 +1046,16 @@ func TestDumpJSON(t *testing.T) {
 
 		assert.Equal(t, []any{"foo", float64(123), true}, got)
 	})
+}
+
+func TestDisableStringer(t *testing.T) {
+	data := hidden{secret: "not so secret"}
+
+	d := newDumperT(t, WithDisableStringer(true))
+	v := d.DumpStr(data)
+	require.Contains(t, v, `-secret => "not so secret"`)
 
+	d = newDumperT(t)
+	v = d.DumpStr(data)
+	assert.Contains(t, v, `-secret => 👻 hidden stringer`)
 }