-
-
24 Jun 2021 00:32:45 UTC
- Distribution: Data-Dump-Color
- Module version: 0.248
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues (0)
- Testers (787 / 18 / 0)
- Kwalitee
Bus factor: 1- 52.04% Coverage
- License: perl_5
- Perl: v5.10.1
- Activity
24 month- Tools
- Download (209.03KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
- NAME
- VERSION
- SYNOPSIS
- DESCRIPTION
- RESULTS
- VARIABLES
- FUNCTIONS
- FAQ
- ENVIRONMENT
- HOMEPAGE
- SOURCE
- BUGS
- SEE ALSO
- AUTHOR
- CONTRIBUTORS
- COPYRIGHT AND LICENSE
NAME
Data::Dump::Color - Like Data::Dump, but with color
VERSION
This document describes version 0.248 of Data::Dump::Color (from Perl distribution Data-Dump-Color), released on 2021-06-24.
SYNOPSIS
Use it like you would Data::Dump, e.g.:
use Data::Dump::Color; dd localtime;
DESCRIPTION
Sample screenshot:
This module aims to be a drop-in replacement for Data::Dump. It adds colors to dumps. It also adds various visual aids in the comments, e.g. array/hash index, depth indicator, and so on.
For more information, see Data::Dump. This documentation explains what's different between this module and Data::Dump.
RESULTS
By default Data::Dump::Color shows array index or hash pair sequence in comments for visual aid, e.g.:
[ "this", # [0] "is", # [1] "a", # [2] "5-element", # [3] "array", # [4] { 0 => "with", # .{0} 1 => "an", # .{1} 2 => "extra", # .{2} 3 => "hash", # .{3} 4 => "at", # .{4} 5 => "the", # .{5} 16 => "end", # .{6} }, # [5] ]
[]
and{}
brackets will indicate whether they are indexes to an array or a hash. The dot prefixes will mark depth level.To turn this off, set
$INDEX
to 0:[ "this", "is", "a", "5-element", "array", { 0 => "with", 1 => "an", 2 => "extra", 3 => "hash", 4 => "at", 5 => "the", 16 => "end", }, ]
VARIABLES
$Data::Dump::*
package variables from Data::Dump, like$Data::Dump::TRY_BASE64
, etc are now in theData::Dump::Color
namespace, e.g.$Data::Dump::Color::TRY_BASE64
, etc.Additional variables include:
- $COLOR => BOOL (default: undef)
-
Whether to force-enable or disable color. If unset, color output will be determined from "NO_COLOR", "COLOR" environment variables, or whether running in interactive terminal (when
-t STDOUT
is true). - $COLOR_THEME => str
-
Select a color theme, which is a module under
ColorTheme::Data::Dump::Color::
orColorTheme::
namespace (with/without the namespace prefix). For example:Default256
,Bright
. - $INDEX => BOOL (default: 1)
-
Whether to add array/hash index visual aid.
- $LENTHRESHOLD => int (default: 500)
-
Add string length visual aid for hash key/hash value/array element if length is at least this value.
FUNCTIONS
Only "dd" and "ddx" are exported by default.
dd
ddx
dump
FAQ
How do I turn off index comments?
Set
$Data::Dump::Color::INDEX
to 0.How do I turn off colors?
Well, colors is sort of the point of this module. But if you want to turn it off, you can set environment COLOR to 0, or
$Data::Dump::Color::COLOR
to 0.How do I customize colors?
Create a color theme and give it a name under
ColorTheme::Data::Dump::Color::*
. See an existing color theme for example, e.g. ColorTheme::Data::Dump::Color::Default256.ENVIRONMENT
DATA_DUMP_COLOR_THEME
Set color theme. Name will be searched under
ColorTheme::Data::Dump::Color::*
orColorTheme::*
.NO_COLOR
Can be used to disable color. Takes precedence over the
COLOR
environment. See https://no-color.org for more details.COLOR
If set, then will force color output on or off. By default, will only output color when in interactive terminal. This is consulted when
$COLOR
is not set.HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Data-Dump-Color.
SOURCE
Source repository is at https://github.com/perlancar/perl-Data-Dump-Color.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Data-Dump-Color
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
SEE ALSO
Data::Dump, JSON::Color, YAML::Tiny::Color
AUTHOR
perlancar <perlancar@cpan.org>
CONTRIBUTORS
Scott Baker <bakerscot@cpan.org>
Steven Haryanto <sharyanto@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2021, 2018, 2014, 2013, 2012 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
Module Install Instructions
To install Data::Dump::Color, copy and paste the appropriate command in to your terminal.
cpanm Data::Dump::Color
perl -MCPAN -e shell install Data::Dump::Color
For more information on module installation, please visit the detailed CPAN module installation guide.