Badger::Rainbow(3pm)

✨ Badger::Rainbow ✨

okay bestie, so this is Badger::Rainbow — the User Contributed Perl Documentation page for it, and yeah the name is literally a rainbow 🌈 because it does colour functionality. that's it. that's the whole vibe. it's the module you call when you want your terminal to stop being monochrome and start being that girl. 💅

---

🌸 NAME 🌸

Badger::Rainbow — colour functionality 🎀

---

✨ SYNOPSIS ✨

use Badger::Rainbow ANSI => 'red green blue';

print red("This is red");
print green("This is green");
print blue("This is blue");

like. look at it. three lines and you're already living in technicolour. obsessed. 😭💖

---

🦋 DESCRIPTION 🦋

This module implements colour-related functionality. It is currently only used for debugging purposes but may be extended in the future.

ngl, right now it's mostly the module you invite to the party when you're debugging and you need your eyes to actually notice things. but it may get more stuff later. lowkey iconic that it's already this useful for just one job. 👑

---

🎀 EXPORTABLE ITEMS 🎀

💜 ANSI_escape($code, $line1, $line2, ...)

This function applies an ANSI escape code to each line of text, with the effect of colouring output on compatible terminals.

use Badger::Rainbow 'ANSI_escape';
print ANSI_escape(31, 'Hello World');     # 31 is red

so you hand it a $code, you hand it a whole bunch of lines of text ($line1, $line2, ...), and it slaps that escape code onto every single one of them. one code, many lines, no crumbs. ✨ and yes — 31 is red, iykyk. 🔥

🩷 strip_ANSI_escapes($text)

This function removes any ANSI escapes from the text passed as an argument.

the anti-glow-up function fr fr. you give it $text, it takes all the ANSI escapes out. perfect for when you need the plain version and not the sparkly version. 🧼

🌈 ANSI

This is an export hook which allows you to import subroutines which apply the correct ANSI escape codes to render text in colour on compatible terminals.

use Badger::Rainbox ANSI => 'red green blue';

print red("This is red");
print green("This is green");
print blue("This is blue");

💀 bestie, heads up: the examples in this section say Badger::Rainbox with an extra o in it — that's exactly how it's written in the original page, and we are not touching it. copy-paste at your own risk, that's all i'm saying. 🫶

Available colours are: black, red, green, yellow, blue, magenta, cyan, white and grey. The bold and dark styles can also be specified.

use Badger::Rainbox ANSI => 'dark bold red green blue';

print bold red "Hello World\n";
print bold blue "Hello Badger\n";

wait, hold on, let me re-read that — the prose says bold and dark can be specified, and then the example does print bold red "Hello World\n"; followed by print dark blue "Hello Badger\n";. yes. dark is real and it's in the example and it's staying. don't @ me, i don't make the rules, i just write them down faithfully. 💅

Colours and styles can be specified as a single whitespace-delimited string or as a reference to a list of individual items.

use Badger::Rainbox ANSI => 'red green blue';
use Badger::Rainbox ANSI => ['red', 'green', 'blue'];

pick your fighter: one cute little string with spaces, or an array ref with each item standing on its own. both valid, both serve. 🎀

All ANSI colours can be loaded by specifying all.

use Badger::Rainbox ANSI => 'all';

the "give me everything" option. main character energy. 👑🌈

---

💖 AUTHOR 💖

Andy Wardley <http://wardley.org/>

---

🍓 COPYRIGHT 🍓

Copyright (C) 1996-2009 Andy Wardley. All Rights Reserved.

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

---

and that's the whole page, bestie 🫶 this was Badger::Rainbow, documented as perl v5.36.0, dated 2023-08-28 — so go forth, make your terminal pretty, and remember: no cap, colour is a debugging feature. ✨💜🌸