XXX(3pm)

💖 XXX 💖

okay bestie, sit down, hydrate, and let me tell you about the module that lets you See Your Data in the Nude. yes that's literally the NAME. it's iconic, it's chaotic, it's giving main character energy. 💅

---

✨ VERSION ✨

this doc is describing XXX version 0.38. she's grown, she's evolved, she's serving. 🎀

---

🌸 SYNOPSIS 🌸

look at this flexibility. the way she fits anywhere in your code:

use XXX;
XXX my $dog = Dog->new({has => ['fleas', 'style']});
my $dog = XXX Dog->new({has => ['fleas', 'style']});
my $dog = Dog->new(XXX {has => ['fleas', 'style']});
my $dog = Dog->new({XXX has => ['fleas', 'style']});
my $dog = Dog->new({has => XXX ['fleas', 'style']});
my $dog = Dog->new({has => [XXX 'fleas', 'style']});

like. she can go ANYWHERE. insert her mid-expression, mid-hash, mid-array, wherever. no cap. 🦋

---

💜 DESCRIPTION 💜

XXX.pm exports a function called XXX that you can drop basically anywhere in your Perl code, and it will die with a YAML dump of whatever arguments are sitting to its right. dramatic exit, but make it data.

the charm of XXX-debugging (and yes, it IS charming, it's the moment) is that:

• it is easy to type — three letters, that's it
• it rarely requires parens — so it slides right in
• it stands out visually — so you actually REMEMBER to remove it before you ship 🙈

XXX.pm also exports WWW, YYY and ZZZ, which do similar debugging things. she's got a whole friend group. 👑

---

🔥 FUNCTIONS 🔥

WWW

WWW will warn a dump of its arguments, and then return the original arguments. that means you can stick it in the middle of expressions and nothing breaks, it just yells a little. 💀

NOTE: If you use WWW with Test::More, it will diag() rather than warn().

mnemonic: W for warn

XXX

XXX will die with a dump of its arguments.

mnemonic: XXX == Death, Nudity — yes, really. that's the mnemonic. she said what she said. 💅

YYY

YYY will print a dump of its arguments, and then return the original arguments. same energy as WWW but louder and printed, so again — mid-expression placement is fully allowed.

NOTE: If you use YYY with Test::More, it will note() rather than print().

mnemonic: YYY == Why Why Why??? or YAML YAML YAML

ZZZ

ZZZ will Carp::confess a dump of its arguments. full confession. no secrets. 😭

mnemonic: You should confess all your sins before you sleep. zzzzzzzz

DDD

DDD will start an interactive debugger session using the Enbugger module. by default it will use the Perl debugger, but you can switch to the fancier Devel::Trepan debugger by setting the environment variable PERL_XXX_DEBUGGER=trepan. ✨

in the debugger session you will be able to both read and modify all variables, including lexical variables. everything. all of it. the whole vibe. 🫶

mnemonic: Debug, Debug, Debug!

---

🌈 USE XXX WITHOUT use XXX; 🌈

if you export PERL5OPT='-MXXX=global' in your shell environment, then XXX will always be loaded, and all the functions will also be exported into the main namespace. that means you can call XXX from any package with ::XXX (since :: is a synonym for main::). no imports, no setup, just vibes. 🎀

also XXX will be exported as $::XXX which you can use like this:

$self->foo->$::WWW->bar;

this will warn a YAML dump of $self, returning $self so that bar will be called correctly. method chaining but make it nosy. 👑

---

🧚 CONFIGURATION 🧚

by default, XXX uses YAML::PP to dump your data. you can change this like so:

use XXX -with => 'Data::Dumper';
use XXX -with => 'Data::Dump';
use XXX -with => 'Data::Dump::Color';
use XXX -with => 'YAML';
use XXX -with => 'YAML::XS';
use XXX -with => 'YAML::SomeOtherYamlModule';
use XXX -with => 'JSON::Color';
use XXX -with => 'JSON::SomeOtherJsonModule';

you can also use the environment variable PERL_XXX_DUMPER to set the module, for example:

PERL_XXX_DUMPER=JSON::Color perl script.pl
PERL_XXX_DUMPER=YAML::PP::Highlight perl script.pl

only modules with names beginning with 'YAML' or 'JSON', and the Data::Dumper, Data::Dump, and Data::Dump::Color modules are supported. don't try to sneak anything else in there bestie, she will not allow it. 🙈

if you need to load XXX with require, you can set the dumper module with the $XXX::DumpModule global variable:

require XXX;
$XXX::DumpModule = 'YAML::Syck';

XXX::XXX($variable);

---

⭐ STACK TRACE LEVEL ⭐

if you call a debugging function that calls XXX for you, XXX will print the wrong file and line number. tragic. the call stack is lying to you. 😭

to force XXX to skip a package in the call stack, just define the XXX_skip constant like this:

package MyDebugger;
use constant XXX_skip => 1;
sub debug {
    require XXX;
    XXX::XXX(@_);
}

now calls to MyDebugger::debug will print the file name you called it from, not from MyDebugger itself. accuracy restored, slay. ✨

---

💖 AUTHOR 💖

Ingy döt Net <ingy@cpan.org>

---

🎀 COPYRIGHT AND LICENSE 🎀

Copyright 2006-2021. Ingy döt Net.

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

See <http://www.perl.com/perl/misc/Artistic.html>

---

and that's the whole page bestie, no notes, we ate. this was perl v5.32.1, dated 2021-09-12, and you just read XXX(3pm) — go forth and debug in the nude. 💅🦋💖