GINKGO(1)

📦
version 2.28.1 · 2 versions
, in debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ NAME ✨

ginkgo — the ginkgo CLI compiler 💅 (it lives in the General Commands Manual, section 1, iykyk)

🌸 SYNOPSIS 🌸

ginkgo flags packages -- pass-throughs

ginkgo COMMAND options

🦋 DESCRIPTION 🦋

Okay bestie, so Ginkgo is a BDD-style Golang testing framework, and it exists to help you write tests that are expressive and comprehensive without losing your whole entire mind. It's giving "tests but make them cute." ✨

This page is all about the ginkgo CLI, which comes with a bunch of conveniences on top of what go test gives you right out of the box. Using it is recommended... but not, like, necessary. No pressure. Do what feels right. 🫶

🎀 OPTIONS 🎀

  • ginkgo or ginkgo run flags packages -- pass-throughs — Run the tests in packages (or the package in the current directory).

Any arguments after -- get passed straight through to the test. And if you want the full rundown of every valid flag, just run ginkgo help run. 👑

  • ginkgo watch flags packages -- pass-throughs — Watches the files in packages and re-runs your tests whenever changes happen. It's the "not me refreshing manually every five seconds" option. 🙈
  • ginkgo bootstrap flags — Bootstrap a test suite for the current package. Main character energy for your test setup. 💖
  • ginkgo generate filenames — Generate a test file named filename_test.go.

If the optional filenames argument is omitted, a file named after the package in the current directory will be created. Slay, it just does it for you. ✨

  • ginkgo labels flags packages — List labels detected in the passed-in packages (or the package in the current directory). Vibe check on your labels fr fr. 🏷️
  • ginkgo outline filename — Create an outline of Ginkgo symbols for a file. Literally a little map of your Ginkgo situation. 🗺️
  • ginkgo unfocus — Recursively unfocuses any focused tests under the current directory. Yes queen, clean up that focus. 🧚
Heads up bestie: this page only covers these commands at a high level — the flags belong to each subcommand, so peek at ginkgo help run for the full flag list. 🫶

👑 AUTHOR 👑

ginkgo was written by Onsi Fakhouri.

This man page was written by Martín Ferrari for the Debian project. 💜

Okay that's the whole thing, bestie — this was ginkgo from the General Commands Manual, source/version ginkgo, dated Aug 2023. Periodt. 💅🎀🦋

📦 where this page comes from