Test::...s::ONLY(3pm)

💖 NAME 💖

okay so the page you just opened is Test::...s::ONLY(3pm) (the header abbreviates it, it's giving mystery 💀), and the module inside is Test::Effects::ONLY — it lexically sets Test::Effects verbosity. that's the whole vibe check, bestie. ✨

---

🌸 VERSION 🌸

this doc is describing Test::Effects::ONLY version 0.000001. tiny number, big energy. 👑

---

🦋 SYNOPSIS 🦋

{
    use Test::Effects::ONLY;
    # Test::Effects defaults to only testing specified effects in this scope

    {
        no Test::Effects::ONLY;
        # Test::Effects defaults to testing all effects in this scope
    }

    # Test::Effects still only testing specified effects here

}
# Test::Effects reverts to original behaviour here

---

✨ DESCRIPTION ✨

so like. dropping use Test::Effects::ONLY in changes the default behaviour of Test::Effects's effects_ok() test. that's the tea. 🫖

normally that test tests all the side-effects — even the ones you didn't specify — unless you explicitly told it otherwise with ONLY(). but if you use this module inside a code block, then for the rest of that block's lexical scope, effects_ok() defaults to only running the tests you actually specified. lowkey iconic, no cap. 💅

heads up though bestie: an explicit ONLY => $boolean option in any call to effects_ok() overrides this lexical default. the explicit one always wins, periodt.

---

💜 INTERFACE 💜

use Test::Effects::ONLY;

within the rest of the current lexical scope, effects_ok defaults to only running the tests you specified. slay. ✨

no Test::Effects::ONLY;

within the rest of the current lexical scope, effects_ok defaults to running all tests — including the unspecified ones. back to chaos, we love that for us. 🌈

---

🔍 DIAGNOSTICS 🔍

none. literally nothing. no drama, no notes. 😌

---

⚙️ CONFIGURATION AND ENVIRONMENT ⚙️

Test::Effects::ONLY requires no configuration files or environment variables. it just works. fr fr. 🧚

---

🎀 DEPENDENCIES 🎀

• needs Perl 5.14 (or better) 💖
• does not require the Test::Effects module — but it is meaningless without it, so like, what are we even doing here without it 🙈

---

💀 INCOMPATIBILITIES 💀

none reported. we're unproblematic. ✨

---

🐛 BUGS AND LIMITATIONS 🐛

no bugs have been reported. bestie behaviour, honestly. 🫶

if you find one though, or you want a feature, please report it to bug-lib-test-effects@rt.cpan.org, or through the web interface at <http://rt.cpan.org>. do it, i'm begging. 😭

---

👑 AUTHOR 👑

Damian Conway <DCONWAY@cpan.org>. main character energy, honestly. ⭐

---

📜 LICENCE AND COPYRIGHT 📜

Copyright (c) 2012, Damian Conway <DCONWAY@cpan.org>. All rights reserved.

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

---

🚨 DISCLAIMER OF WARRANTY 🚨

okay bestie this part is the legal bit and it's in ALL CAPS because it means business. read it, don't skip it, i love you. 💖

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

---

and that's the whole page, bestie!! 🎀 this lil guy is perl v5.36.0, dated 2023-07-17, and it lives under the name Test::...s::ONLY(3pm). go forth and lexically scope your vibes. 💅✨