awesome-print/awesome_print
Awesome Print
Awesome Print ist ein Ruby-Pretty-Printer und Objekt-Inspektor, der darauf ausgelegt ist, Datenstrukturen durch Einrückung und ANSI-Farben zu visualisieren. Er dient als Formatierer für interaktive Shells und als Dienstprogramm zur Analyse interner Objektzustände.
Das Projekt bietet ein Plugin-System zur Definition benutzerdefinierter Formatierungsregeln für spezifische Objekttypen und unterstützt das Laden globaler Präferenzen über eine Konfigurationsdatei im Home-Verzeichnis. Es kann formatierte ASCII-Strings zurückgeben, anstatt direkt in die Konsole zu drucken.
Die Funktionen erstrecken sich auf das Rendern formatierter Objektstrukturen innerhalb von Web-Templates und das Schreiben farbiger Objektdarstellungen in System-Logs. Das Tool integriert sich in REPL-Umgebungen, um zurückgegebene Werte automatisch zu formatieren.
Features
- Data Structure Visualizers - Visualizes internal Ruby object states by printing data structures with indentation, colors, and configurable layouts.
- Object Visualizers - Visualizes complex Ruby data structures using indentation and ANSI colors to make internal object states easier to analyze.
- Object Formatting Plugins - Provides a plugin system to create custom formatting rules for specific object types.
- Interactive Debug Consoles - Integrates with interactive shells to automatically format and visualize returned values for easier variable and state inspection.
- REPL Configuration - Configures REPL environments to use the library as the default output handler for improved readability.
- Interactive Shells - Sets the output formatter for interactive shells to automatically pretty-print all console data.
- Runtime Object Inspectors - Provides a configurable utility for analyzing the internal state of live Ruby objects through structured text output.
- ANSI Color Rendering - Implements ANSI terminal escape sequences to provide color and styling for object visualization in the console.
- Object Data Formatters - Acts as an output handler for interactive shells to automatically format data structures into readable layouts.
- Type-Based Formatting Dispatchers - Routes Ruby objects to specialized formatting methods based on their specific class or data type.
- Object Traversal Utilities - Walks through nested data structures recursively to apply consistent indentation and formatting based on object depth.
- User-Defined Type Formatters - Allows users to define custom formatting rules for specific object types through a registration plugin system.
- REPL Output Overrides - Integrates with REPL environments to override the default inspector and automatically format returned values.
- Object Pretty-Printers - Formats Ruby class instances into human-readable output highlighting nested structures and attribute values.
- Application Debug Logging - Provides methods to write pretty-printed and colorized object representations directly to system logs for troubleshooting.
- Formatted String Generation - Provides the ability to return formatted object representations as ASCII strings instead of printing directly to the console.
- CLI Config File Readers - Loads persistent formatting and color preferences from a home directory configuration file to set global defaults.
- Formatted String Conversion - Returns an ASCII encoded string of the formatted object instead of printing directly to the console.
- Configuration Defaults - Supports centralized management of default formatting and color settings via a configuration file.
- Terminal Text Coloring - Offers convenience methods to apply specific colors to string values for highlighted console output.
