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

TINITA / YAML-Tidy-v0.10.1-TRIAL / lib / yamltidy.pod 

            

              
—
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

              
=head1 NAME
yamltidy - Reformat YAML files
=head1 ABSTRACT
=head1 DESCRIPTION
This script checks YAML files according to a configuration and automatically
reformats them.
It will output the formatted code on standard output, or edit the file
directly.
=head1 EXAMPLES
=over
=item Tidy a file and print to stdout
    % cat in.yaml
    ---
    a:
        b:
            c: d
    % yamltidy in.yaml
    ---
    a:
      b:
        c: d
=item Tidy content from stdin
    % echo '---
    a:
        b:
            c: d' | yamltidy -
    ---
    a:
      b:
        c: d
=item Tidy a file and save the result back
    % yamltidy --inplace in.yaml
    % cat in.yaml
    ---
    a:
      b:
        c: d
=item Process a list of files from stdin
    # Tidy all .yaml files that are in git
    % git ls-files | grep '.yaml$' | yamltidy --inplace --batch -
    # short options
    % git ls-files | grep '.yaml$' | yamltidy -i -b -
    # Only tidy modified files
    % git ls-files --modified | grep '.yaml$' | yamltidy --inplace --batch -
In the future yamltidy can take a directory as an argument and process
file name patterns from configuration.
=item Use a certain configuration file
    % yamltidy -c /path/to/yamltidy.yaml file.yaml
=item Partial formatting
From within an editor you can pass only a part of the file on stdin.
This is important for keeping the indentation of that part. Also
it won't add a C<---> header. Compare:
    % echo '
      a:
          b: c' | yamltidy -
    ---
    a:
      b: c
    % echo '
        a:
            b: c' | yamltidy --partial -
        a:
          b: c
Vim example configuration:
    # :noremap <leader>yt :%!yamltidy -<CR>
    # :vnoremap <leader>yt :!yamltidy --partial -<CR>
=back
=head2 GLOBAL OPTIONS
    --config-file -c    Config file                                                                            
    --config-data -d    Configuration as a string                                                              
    --inplace -i        Edit file inplace (flag)                                                               
    --debug             Debugging output (flag)                                                                
    --partial           Input is only a part of a YAML file (flag)                                             
    --indent            Override indentation spaces from config                                                
    --batch -b          Tidy all files - currently requires parameter "-" for filenames passed via STDIN (flag)
    --verbose           Output information (flag)                                                              
    --help -h           print usage message and exit (flag)                                                    
    --version           Print version information (flag)                                                       
=head2 SUBCOMMANDS