metadata-json-lint(1)

📦
version 5.0.0 · 2 versions
, in ubuntu resolute, ubuntu stonking

💖 metadata-json-lint — the manual, but make it cute 💖

okay bestie, welcome to metadata-json-lint(1), from the General Commands Manual section. yes this is a real manual page, no I did not make it up, and yes we're gonna get through it together. grab a snack 🍓

✨ NAME ✨

metadata-json-lint — validate and lint metadata.json files in Puppet modules. it's giving "your Puppet module's vibe check" fr fr 💅

🎀 SYNOPSIS 🎀

metadata-json-lint [options] <path>

that's it. that's the whole shape of it. options first, path at the end. iconic. 👑

🦋 DESCRIPTION 🦋

so the tea is: metadata-json-lint validates and lints the metadata.json files inside your Puppet modules. it checks them against the style guidelines from the Puppet Forge module metadata recommendations. it's like a bestie who reads your homework and is like "honey… this part? no." 😭 but in a helpful way!!

and here's the fun part — you can run it as a binary command (the way we're doing here), or you can use it as a rake task. the rake task instructions live in the project's README.md file. go read it, it's right there. 📖

🌸 OPTIONS 🌸

one bullet per option, all of them, no skips, we do not leave the group chat on read:

  • [no-]strict-dependencies — whether to fail if your module version dependencies are open-ended. defaults to false. so like, by default it's chill about it, but you can make it strict.
  • [no-]strict-license — whether to fail on the strict license check. defaults to true. yeah bestie, this one's already on. 💀
  • [no-]fail-on-warnings — whether to fail on warnings. defaults to true. a warning is basically a soft fail here, periodt.
  • [no-]strict-puppet-version — whether to fail if your Puppet version requirements are open-ended or no longer supported. defaults to false. off by default, turn it on if you're feeling brave ✨

🔥 EXAMPLES 🔥

test a metadata.json file. that's the whole move:

$ metadata-json-lint /path/to/metadata.json

see? path in, vibes checked, done. 🫶

👑 SEE ALSO 👑

go here for the actual Puppet docs about writing a metadata.json file:

https://docs.puppet.com/puppet/latest/modules_publishing.html#write-a-metadatajson-file
heads up, in the original it's line-wrapped across two lines, but it's one single URL. don't come for me 💅

🧚 AUTHOR 🧚

Gabriel Filion wrote this. thank you Gabriel, we appreciate you, no cap 🌈

that's the page, bestie!! it's from 2020, and it belongs to the metadata-json-lint(1) manual. main character energy, honestly. go lint something and slay 💖✨🎀🦋🌸

📦 where this page comes from