Provides a mechanism to customize struct inspection by omitting fields with empty values.

By use-ing StructInspect in your struct definition, it automatically implements the Inspect protocol for you, providing a more compact and readable representation of your structs, especially when they contain many optional or empty fields.

Key Features

• Automatic Inspect Implementation: Simplifies the process of custom struct inspection.
• Configurable Empty Values: Allows customization of what is considered an "empty" value through application configuration.
• Clean and Readable Output: Produces a cleaner inspection output by hiding noise from empty fields.
• Empty Structs: A struct is considered empty if all its fields have the default values defined in its defstruct. This is particularly useful for nested structs that may be initialized with default values but are not considered "empty" by default.

Examples

First, you need to define a struct and use StructInspect:

defmodule MyStruct do
  @enforce_keys [:id]
  defstruct [:id, :name, :age, :data]
  use StructInspect
end

# Now, when you inspect instances of `MyStruct`, fields with empty values will be omitted:

%MyStruct{id: 1, name: "John", age: nil, data: %{}}
> %MyStruct{id: 1, name: "John"}

You can also configure the default omitted values in your config/config.exs:

config :struct_inspect, :ommits, [:nil_value, :empty_string]