Skip to content

Latest commit

 

History

History
284 lines (178 loc) · 7.74 KB

CHANGELOG.md

File metadata and controls

284 lines (178 loc) · 7.74 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.6.0 - 2024-08-21

This release is largely centered around a refactoring of the Config type and the way that a Printer is configured. It should not affect most users, but does introduce some breaking changes for filter authors.

Added

  • Added Annotator, Config.Annotators and WithAnnotator, to add user-defined text annotations to rendered values.
  • Added NewPrinter() function, that accepts the following functional options:
    • WithFilter()
    • WithDefaultFilters()
    • WithAnnotator()
    • WithUnexportedStructFields()
    • WithPackagePaths()

Changed

  • [BC] Replaced Config.OmitUnexportedFields with RenderUnexportedStructFields, note the logic is inverted.
  • [BC] Replaced Config.OmitPackagePaths with RenderPackagePaths, note the logic is inverted.
  • Bumped the minimum supported Go version to 1.21.

Removed

  • [BC] Removed DefaultPrinter, use NewPrinter() instead.
  • [BC] Removed Config.Indent and DefaultIndent constant.
  • [BC] Removed Config.RecursionMarker and DefaultRecursionMarker constant.
  • [BC] Removed Config.ZeroValueMarker and DefaultZeroValueMarker constant.

Fixed

  • Renderer.Config() and Renderer.WithModifiedConfig() now properly clone the slices within Config.

0.5.3 - 2024-04-08

Fixed

  • Fixed rendering of named types that was accidentally removed in 0.5.2.

0.5.2 - 2024-04-08

Changed

  • interface{} is now rendered as any.
  • Zero-valued arrays are now rendered with the "zero value marker", similarly to structs.

Fixed

  • Fixed inconsistent rendering of "element" type names within pointers, channels, maps, slices and functions.

0.5.1 - 2024-03-04

Changed

  • Use zero-allocation natural sorting algorithm from dogmatiq/jumble.

0.5.0 - 2023-07-26

This release includes several changes to the experimental Filter system in preparation for unification of built-in and custom rendering behavior.

Added

  • Added Renderer interface.
  • Added ErrorFilter. Output for types that implement error now include the error message.
  • Added Is(), AsConcrete() and AsImplementationOf() helpers for use in Filter implementations.

Changed

  • [BC] The signature of Filter has changed to accept a Renderer and Value.
  • [BC] Renamed ReflectTypeFilter to ReflectFilter, it now applies to the entire reflect package.
  • [BC] Renamed ProtobufFilter to ProtoFilter.
  • [BC] Changed Config.Indent to a string.

Removed

  • [BC] Removed DurationFilter. TimeFilter now applies to the entire time package.
  • Removed dependency on Iago

Fixed

  • Fixed duplicate application of Filter that apply to specific interfaces when when T and *T both implement the interface.

0.4.6 - 2023-02-27

Fixed

  • Fix rendering of sync.RWMutex under Go v1.20

0.4.5 - 2022-08-07

Fixed

  • StringerFilter now takes precedence over all other filters
  • FilterPrinter.Fallback() now only skips the filter it was called from

0.4.4 - 2022-08-07

Added

  • Add dapper.Stringer interface for types that produce their own dapper representation

Changed

  • Rendering of Protocol Buffers messages is now consistent with other types

0.4.3 - 2021-04-28

Added

  • Improved rendering of Protocol Buffers messages (thanks @mrubiosan)

0.4.2 - 2021-04-22

Added

  • Add OmitUnexportedFields option (thanks @mrubiosan)

0.4.1 - 2020-11-21

Added

  • Add DefaultPrinter, the printer used by Write(), Format() and Print()

0.4.0 - 2020-05-05

Added

  • Add Config to enscapsulate the configuration of a Printer

Changed

  • [BC] Change DefaultIndent from string constant to []byte
  • [BC] The Filter function signature now accepts a Config and FilterPrinter
  • Zero-value structs are now collapsed to StructName{<zero>}

Removed

  • [BC] Remove Printer.Filters, Indent and RecursionMarker
  • [BC] Remove Value.TypeName()

Fixed

  • Add mutex lock around writes to stdout to prevent fragmented output (#45, thanks @ilmanzo)

0.3.5 - 2019-11-06

Changed

  • Print() now accepts multiple arguments (#23)

Fixed

  • Fix panic when rendering unexported time.Time values (#24)

0.3.4 - 2019-11-05

Changed

  • Byte slices and arrays are now rendered in hexdump format (#15)
  • Improved rendering of sync.Mutex, RWMutex and Once (#14)
  • Improved rendering of time.Time and Duration (#8)

0.3.3 - 2019-04-23

Fixed

  • Render reflect.Type names when obtained from unexported struct fields (#9)

0.3.2 - 2019-02-06

Changed

  • Bump Iago to v0.4.0

Fixed

  • Printer() now includes the name of user-defined string and bool types (#6)
  • iago.Print() now prints a trailing newline (#7)

0.3.1 - 2019-01-29

Changed

  • Bump Iago to v0.3.0

0.3.0 - 2019-01-20

Added

  • Added support for filters, allowing custom rendering on a per-value basis
  • Added a built-in filter for reflect.Type

Fixed

  • Fixed a bug whereby IO errors were not propagated to the caller

0.2.0 - 2019-01-19

Added

  • Added Print(), which prints directly to os.Stdout

Fixed

  • Fixed support for formatting of structs with unexported fields

0.1.1 - 2019-01-16

Changed

  • Use Iago for indentation, etc

0.1.0 - 2019-01-16

  • Initial release