Test::S...nt::Plan(3)

📦
version 1.302027 · 2 versions
, in fedora 43

💖 NAME 💖

Test::Stream::Event::Plan — bestie, this is the event of a plan ✨ it's the whole vibe of "okay we're doing a plan now" in Test::Stream, and it lives in the Test::S...nt::Plan(3) manpage 🎀

🚨 DEPRECATED 🚨

girl stop. This distribution is deprecated in favor of Test2, Test2::Suite, and Test2::Workflow. it's giving "we've moved on" 💀

See Test::Stream::Manual::ToTest2 for a conversion guide. like, the glow-up guide is right there, use it 🫶

🌸 DESCRIPTION 🌸

So Plan events get fired off whenever a plan is declared, whenever done testing is called, or whenever a subtext completes. That's it, that's the whole job. three little triggers, one iconic event ✨

🎀 SYNOPSIS 🎀

use Test::Stream::Context qw/context/;
use Test::Stream::Event::Plan;

my $ctx = context();

# Plan for 10 tests to run
my $event = $ctx->plan(10);

# Plan to skip all tests (will exit 0)
$ctx->plan(0, skip_all => "These tests need to be skipped");

like, look at her go 😭 planning 10 tests, or just skipping the whole thing with skip_all and exiting 0. no cap, the exit 0 is right there in the comment, that's canon. 💅

👑 ACCESSORS 👑

  • $num = $plan->max — get the number of expected tests 🔢 like how many tests we're committing to, bestie
  • $dir = $plan->directive — get the directive, such as TODO, skip_all, or no_plan 🎯
  • $reason = $plan->reason — get the reason for the directive 💬 the "why" behind the directive, the lore

🦋 SOURCE 🦋

The source code repository for Test::Stream can be found at http://github.com/Test-More/Test-Stream/. go be nosy, it's fine 💖

🧚 MAINTAINERS 🧚

  • Chad Granum <exodist@cpan.org>

⭐ AUTHORS ⭐

  • Chad Granum <exodist@cpan.org>

Copyright 2015 Chad Granum <exodist7@gmail.com>.

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

See http://dev.perl.org/licenses/

okay that's the whole page, ily, go write some plans 💅✨ this was perl v5.42.0, dated 2025-07-25, straight out of the Test::S...nt::Plan(3) manpage — periodt 🎀🦋

📦 where this page comes from