QTEST(1)

💖 NAME 💖

qtest — Inline (Unit) Tests for OCaml, bestie ✨

🌸 DESCRIPTION 🌸

okay so, real talk: qtest is the girl who writes your unit tests inside your own code and then goes and extracts them for you. It's giving "inline tests, but make it a whole workflow." 🎀

Here's how you actually call her:

USAGE: qtest [options] extract <file.mli?>...

yes the ? on <file.mli?> is real and it is intentional, don't come for her 💅

✨ OPTIONS ✨

• -o, --output <path> — (default: standard output) Opens or creates a file for output, and the resulting file is an OCaml source file containing all the tests. no cap. 🫶
• -p, --preamble <string> — (default: empty) Adds code to the tests preamble. typically this is gonna be an instruction of the form 'open Module' — iconic move, honestly. 💖
• --preamble-file <path> — Adds the contents of the given file to the tests preamble. same vibe as --preamble but she reads it off the disk instead. 📂
• --run-only <function name> — Only generates tests pertaining to this function, as indicated by the test header. very "I only have energy for one of you today" energy 🙈
• --shuffle — (default: turned off) Toggles test execution order randomisation. > heads up bestie: submodules using injection are not shuffled, so don't @ me when they come out in the same order every time 😭
• -help — Display this list of options 👑
• --help — Display this list of options 👑

lowkey the two help flags do the exact same thing and that's just the vibe, periodt ✨

and that's the whole page, babe — go write some inline tests, they're literally about to eat 💅

this was qtest version 2.9, dated September 2018 — yes she's a little vintage and yes she still slays 🎀✨ bye bestie, mwah 🫶