Test2::Plugin(3pm)

πŸ’– NAME: Test2::Plugin(3pm) πŸ’–

Hey bestie! This is the manual page for Test2::Plugin, straight out of the Perl Programmers Reference Guide β€” and yes, the title is giving main character energy. πŸ’…

Test2::Plugin - Documentation for plugins.


✨ DESCRIPTION ✨

Okay so, plugins are packages that cause behavior changes, or other side-effects, for the test file that loads them. That's their whole vibe. 🌸

🚨 Important vibe check: plugins should not export any functions, or provide any tools. They should be distinct units of functionality.

If you wish to combine behavior changes with tools then you should write a Plugin, a Tools module, and a bundle that loads them both. Slay, but keep those layers separate. πŸŽ€


πŸ’¬ FAQ πŸ’¬

Should I subclass Test2::Plugin?

No. Currently this class is empty. Eventually we may want to add behavior, in which case we do not want anyone to already be subclassing it. So yeah β€” don't do it, bestie. πŸ™ˆ


πŸ› οΈ HOW DO I WRITE A PLUGIN? πŸ› οΈ

Writing a plugin is not as simple as writing a Test2::Bundle, or writing Test2::Tools. Plugins alter behavior, or cause desirable side-effects. To accomplish this you typically need a custom import() method that calls one or more functions provided by the Test2::API package. ✨

If you want to write a plugin you should look at existing plugins, as well as the Test2::API and Test2::Hub documentation. There is no formula for a Plugin, they are generally unique, however consistent rules are that they should not load other plugins, or export any functions. Periodt. πŸ’…


🌈 SOURCE 🌈

The source code repository for Test2-Suite can be found at https://github.com/Test-More/test-more/.


πŸ‘‘ MAINTAINERS πŸ‘‘

  • Chad Granum <exodist@cpan.org>

πŸ¦‹ AUTHORS πŸ¦‹

  • Chad Granum <exodist@cpan.org>

Copyright Chad Granum <exodist@cpan.org>.

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, bestie πŸ’– Manual footer says perl v5.42.3, dated 2026-11-03 β€” bye from Test2::Plugin(3pm) 🫢

πŸ“¦ where this page comes from