ISTANBUL(1)

💖 ISTANBUL(1) 💖

okay bestie, welcome to istanbul — a JS code coverage tool written in JS ✨ (yes she's a JS tool written in JS, she contains multitudes, she's self-referential like that 🪞💅). She lives in your General Commands Manual, section 1, and she is so ready to tell you exactly which lines of your code your tests are ghosting. 👻

✨ SYNOPSIS ✨

istanbul help config | <command>

so it's giving: either you're asking her for help about config 🎀, or you're handing her a <command> and letting her cook 🔥

🦋 DESCRIPTION 🦋

here's the roster, bestie — these are the commands she serves 💖

• check-coverage — this one checks your overall coverage and your per-file coverage against thresholds that come from coverage JSON files 📊✨. Exits 1 if the thresholds are not met, 0 otherwise. so she's a bouncer at the club and your coverage is the fit check 🚪💀
• cover — transparently adds coverage information to a node command 🧚‍♀️ like she slides it in there with zero drama. Saves coverage.json and reports at the end of execution. main character behaviour honestly 👑
• help — shows help 🫶. she's helpful, she's generous, she wants you to thrive 💜
• instrument — instruments a file or a directory tree 🌳 and writes the instrumented code to the desired output location 📁✨ (not her making it weird, that's literally the word for it)
• report — writes reports for coverage JSON objects produced in a previous run 📝🌈. past-you did the work, present-you gets the receipts 💅
• test — cover a node command only when npm_config_coverage is set 🎀. Use in an npm test script for conditional coverage. so she only shows up when she's invited, and that's iconic boundaries energy ✨

lowkey crucial detail bestie: Command names can be abbreviated as long as the abbreviation is unambiguous 👀 so like, shorthand is allowed, but don't get cute and ambiguous about it or she won't know who you mean 😭

🌸 SEE ALSO 🌸

• tap(1) 🍓

and that's the whole page, no notes 💖 she's dated June 2018 and she comes from the a JS code coverage tool written... source/version era, which is honestly such a vibe 🎀 go forth, cover your code, meet your thresholds, and remember: unambiguous abbreviations only 👑✨💅