Code::...Matter(3pm)

💖 NAME 💖

Code::TidyAll::Plugin::YAMLFrontMatter — it's a TidyAll plugin whose whole job is validating your YAML Front Matter, bestie. That's it. That's the girl. 🎀

✨ VERSION ✨

version 1.000003 — she's giving mature, she's giving stable, she's giving "we've been here a minute." 👑

🦋 SYNOPSIS 🦋

So you drop this into your .tidyallrc file, like so:

[YAMLFrontMatter]
select = **/*.md
required_top_level_keys = title layout

And that's literally it, you're done, go touch grass. 🌸

🌈 DESCRIPTION 🌈

Okay so real talk: this is a validator plugin for Code::TidyAll, and it checks that your files have valid YAML Front Matter — you know, the exact kind of thing Jekyll et al are obsessed with. Front matter girlies rise up. 💅

It will complain — and honestly? Fair. Here's the full list of things that make it side-eye you:

• There's no YAML Front Matter at all 😭
• The YAML Front Matter isn't valid YAML (invalid, bestie, it's giving chaos)
• There's a UTF-8 BOM sitting at the start of the file 🙈
• The file isn't encoded in the configured encoding (UTF-8 by default)
• The YAML Front Matter is missing one or more of the configured top level keys
• The YAML Front Matter contains circular references 💀

---

🎀 Options 🎀

• required_top_level_keys — the keys that must be present at the top level of the YAML Front Matter. No skips, no "oops I forgot", none of that.
• encoding — what encoding the file is in. Defaults to UTF-8, just like Jekyll 2.0 and later. Iconic behaviour, honestly.

---

🔥 SEE ALSO 🔥

• Jekyll's Front Matter Documentation <https://jekyllrb.com/docs/frontmatter/>

🫶 SUPPORT 🫶

Please report all issues with this code using the GitHub issue tracker at <https://github.com/maxmind/Code-TidyAll-Plugin-YAMLFrontMatter/issues>.

Bugs may be submitted through <https://github.com/maxmind/Code-Tidyall-Plugin-YAMLFrontMatter/issues>.

fr fr, if something's broken, tell the maintainers, don't just suffer in silence. That's not the vibe. 💜

⭐ AUTHOR ⭐

Mark Fowler <mfowler@maxmind.com> — the main character. 🎀

🧚 CONTRIBUTORS 🧚

• Dave Rolsky <autarch@urth.org>
• Greg Oschwald <goschwald@maxmind.com>

(Shoutout to the whole group chat, we love a collaborative effort. 💖)

💜 COPYRIGHT AND LICENSE 💜

This software is copyright (c) 2019 by MaxMind, Inc.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

---

And that's the whole page, bestie! 💖 Stay valid, stay tidy, stay hydrated. 🦋

This cutie was documented as perl v5.36.0 on 2022-10-14, and yes, the manual name really does get folded in right here at the bottom — Code::...Matter(3pm), mwah. 💅