yamltidy(3)

💖 yamltidy(3) — Reformat YAML files, but make it cute 💖

okay so this is a User Contributed Perl Documentation page for yamltidy(3), and it's literally about making your YAML files tidy. bestie, let's go. 🫶

---

✨ NAME ✨

yamltidy — Reformat YAML files.

🌸 ABSTRACT 🌸

Empty in the original — like, no abstract text here at all. Zero. Nada. 🙈

💅 DESCRIPTION 💅

So this script checks YAML files according to a configuration and automatically reformats them. It'll output the formatted code on standard output, or edit the file directly. That's the whole assignment. 💖

🎀 EXAMPLES 🎀

Tidy a file and print to stdout

% cat in.yaml
---
a:
    b:
        c: d
% yamltidy in.yaml
---
a:
  b:
    c: d

Tidy content from stdin

% echo '---
a:
    b:
        c: d' | yamltidy -
---
a:
  b:
    c: d

Tidy a file and save the result back

% yamltidy --inplace in.yaml
% cat in.yaml
---
a:
  b:
    c: d

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.

Use a certain configuration file

% yamltidy -c /path/to/yamltidy.yaml file.yaml

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 --- 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>

🔥 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) 🏷️

🦋 SUBCOMMANDS 🦋

Okay so this section is empty in the original — no subcommands listed. 💀

---

💌 cute sign-off: this page is from perl v5.42.0, dated 2024-02-02, and it's the yamltidy(3) manual. bye bestie, go tidy some YAML! ✨💅