The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

PERLANCAR / Data-Format-Pretty-YAML-0.08 / lib / Data / Format / Pretty / YAML.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
—
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

              
package Data::Format::Pretty::YAML;
our $DATE = '2014-12-10'; # DATE
our $VERSION = '0.08'; # VERSION
use 5.010001;
use strict;
use warnings;
require Exporter;
our @ISA = qw(Exporter);
our @EXPORT_OK = qw(format_pretty);
sub content_type { "text/yaml" }
sub format_pretty {
    my ($data, $opts) = @_;
    $opts //= {};
    my $interactive = (-t STDOUT);
    my $pretty = $opts->{pretty} // 1;
    my $color  = $opts->{color} // $ENV{COLOR} // $interactive //
        $opts->{pretty};
    my $linum  = $opts->{linum} // $ENV{LINUM} // 0;
    if ($color) {
        require YAML::Tiny::Color;
        local $YAML::Tiny::Color::LineNumber = $linum;
        YAML::Tiny::Color::Dump($data);
    } else {
        require YAML::Syck;
        local $YAML::Syck::ImplicitTyping = 1;
        local $YAML::Syck::SortKeys       = 1;
        local $YAML::Syck::Headless       = 1;
        if ($linum) {
            require String::LineNumber;
            String::LineNumber::linenum(YAML::Syck::Dump($data));
        } else {
            YAML::Syck::Dump($data);
        }
    }
}
1;
# ABSTRACT: Pretty-print data structure as YAML
__END__
=pod
=encoding UTF-8
=head1 NAME
Data::Format::Pretty::YAML - Pretty-print data structure as YAML
=head1 VERSION
This document describes version 0.08 of Data::Format::Pretty::YAML (from Perl distribution Data-Format-Pretty-YAML), released on 2014-12-10.
=head1 SYNOPSIS
 use Data::Format::Pretty::YAML qw(format_pretty);
 print format_pretty($data);
Some example output:
=over 4
=item * format_pretty({a=>1, b=>2})
  a: 1
  b: 2
=back
=head1 DESCRIPTION
This module uses L<YAML::Syck> to encode data as YAML.
=head1 FUNCTIONS
=head2 format_pretty($data, \%opts)
Return formatted data structure as YAML. Currently there are no known options.
YAML::Syck's settings are optimized for prettiness, currently as follows:
 $YAML::Syck::ImplicitTyping = 1;
 $YAML::Syck::SortKeys       = 1;
 $YAML::Syck::Headless       = 1;
Options:
=over
=item * color => BOOL (default: from env or 1)
Whether to enable coloring. The default is the enable only when running
interactively.
=item * pretty => BOOL (default: 1)
Whether to focus on prettyness. If set to 0, will focus on producing valid YAML
instead of prettiness.
=item * linum => BOOL (default: from env or 0)
Whether to enable line numbering.
=back
=head2 content_type() => STR
Return C<text/yaml>.
=head1 ENVIRONMENT
=head2 COLOR => BOOL
Set C<color> option (if unset).
=head2 LINUM => BOOL
Set C<linum> option (if unset).
=head1 FAQ
=head1 SEE ALSO
L<Data::Format::Pretty>
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/Data-Format-Pretty-YAML>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-Data-Format-Pretty-YAML>.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=Data-Format-Pretty-YAML>
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.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2014 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.
=cut