How do I turn off colors in pp for CI pipelines?

Call pp.Default.SetColoringEnabled(false) to disable colors globally, or create a custom printer instance with mypp := pp.New() and set mypp.SetColoringEnabled(false). This ensures plain text output suitable for automated environments.

pp vs go-spew: which is better for debugging?

pp focuses on colored, readable output similar to code editors, ideal for visual inspection during development. go-spew provides detailed structural output without styling, better for logging or deep analysis. Choose pp for immediate readability and go-spew for comprehensive data dumps.

How to set up a custom color scheme in pp?

Define a pp.ColorScheme struct with fields like Integer or String, combine color flags (e.g., pp.Yellow | pp.Bold), and register it using pp.Default.SetColorScheme(scheme). Refer to the ColorScheme documentation in the README for all available options.

Does pp work with Go modules?

Yes, pp supports Go modules as indicated by the import path github.com/k0kubun/pp/v3. You can add it to your go.mod file, and it's compatible with modern Go versions, with active maintenance shown in the GitHub actions badge.

Can I use pp in Go tests for better output?

Absolutely, pp functions like Println can be called within test functions to output colored, readable data structures. It helps inspect variables during test failures, though remember to disable colors if test runners don't support them.

What are the alternatives to pp for Go pretty printing?

Common alternatives include go-spew for detailed unstyled output, fmt.Printf with custom formatting for simplicity, and libraries like pretty for basic pretty printing. pp stands out for its colored syntax highlighting, but evaluate based on your need for visuals vs. minimalism.

pp — Colored Go Pretty Printer

What is pp?

pp is a Go library that provides colored pretty printing for data structures, making debugging and development output more readable. It offers syntax highlighting similar to code editors, helping developers quickly inspect complex nested objects and maps.

Target Audience

Go developers who need to debug or inspect complex data structures like nested maps, structs, and slices during development.

Value Proposition

Developers choose pp for its visually intuitive colored output that mimics code editor syntax highlighting, combined with a familiar fmt-like API and extensive customization options for colors and printer behavior.

Colored pretty printer for Go language

Use Cases

Best For

Debugging Go applications with deeply nested or complex data structures.
Enhancing development output readability with syntax-highlighted pretty printing.
Creating isolated printer instances with custom configurations for different debugging scenarios.
Cross-platform development where consistent colored output is needed on Windows, macOS, and Linux.
Customizing color schemes to match personal preferences or specific visibility requirements.
Integrating pretty printing into existing codebases using a familiar fmt-like API (e.g., Print, Println, Sprint).

Not Ideal For

Production environments where minimal output and maximum performance are critical, as pp adds formatting overhead.
Automated logging or CI/CD pipelines that rely on plain, parseable text (e.g., JSON logs), since colors can interfere with machine readability.
Teams requiring strict adherence to Go's standard library without external dependencies, as pp is a third-party library.
Projects needing identical, unstyled output across all platforms, due to bold support limitations on Windows.

Pros & Cons

Pros

Visual Debugging Aid

Provides syntax-highlighted output similar to code editors, making complex nested structures like maps and slices immediately readable, as demonstrated in the demo images with colored strings, integers, and keys.

Configurable Printers

Supports global defaults or isolated printer instances with options like SetExportedOnly and SetOmitEmpty, allowing tailored debugging for different scenarios without affecting other code.

Fmt-Like API

Offers familiar functions such as Print, Println, Sprint, and Fprintf, enabling easy drop-in replacement for standard fmt calls in existing Go codebases.

Cross-Platform Colors

Works on Windows, macOS, and Linux with consistent colored output, though the README notes that bold styling may not function on Windows, ensuring broad usability with minor trade-offs.

Cons

Windows Bold Limitation

Explicitly states that bold styling likely won't work on Windows, reducing visual consistency and effectiveness for users on that platform, which is a documented shortcoming.

Performance Overhead

The added processing for coloring and pretty printing introduces minor performance costs compared to plain fmt output, which might impact high-frequency debugging or logging scenarios.

Customization Complexity

Defining custom color schemes requires creating a ColorScheme struct and combining flags like pp.Green | pp.Bold, which can be more involved than simple configuration for casual users seeking quick setup.

What is pp?

Target Audience

Go developers who need to debug or inspect complex data structures like nested maps, structs, and slices during development.

Value Proposition

Use Cases

Best For

Debugging Go applications with deeply nested or complex data structures.
Enhancing development output readability with syntax-highlighted pretty printing.
Creating isolated printer instances with custom configurations for different debugging scenarios.
Cross-platform development where consistent colored output is needed on Windows, macOS, and Linux.
Customizing color schemes to match personal preferences or specific visibility requirements.
Integrating pretty printing into existing codebases using a familiar fmt-like API (e.g., Print, Println, Sprint).

Not Ideal For

Production environments where minimal output and maximum performance are critical, as pp adds formatting overhead.
Automated logging or CI/CD pipelines that rely on plain, parseable text (e.g., JSON logs), since colors can interfere with machine readability.
Teams requiring strict adherence to Go's standard library without external dependencies, as pp is a third-party library.
Projects needing identical, unstyled output across all platforms, due to bold support limitations on Windows.

Pros & Cons

Pros

Visual Debugging Aid

Configurable Printers

Supports global defaults or isolated printer instances with options like SetExportedOnly and SetOmitEmpty, allowing tailored debugging for different scenarios without affecting other code.

Fmt-Like API

Offers familiar functions such as Print, Println, Sprint, and Fprintf, enabling easy drop-in replacement for standard fmt calls in existing Go codebases.

Cross-Platform Colors

Works on Windows, macOS, and Linux with consistent colored output, though the README notes that bold styling may not function on Windows, ensuring broad usability with minor trade-offs.

Cons

Windows Bold Limitation

Explicitly states that bold styling likely won't work on Windows, reducing visual consistency and effectiveness for users on that platform, which is a documented shortcoming.

Performance Overhead

The added processing for coloring and pretty printing introduces minor performance costs compared to plain fmt output, which might impact high-frequency debugging or logging scenarios.

Customization Complexity

pp

What is pp?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

pp

What is pp?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?