CPANPL...::Build(3pm)

💖 CPANPL...::Build — the perl man page, but make it a group chat 💖

okay bestie, so this is CPANPL...::Build from the User Contributed Perl Documentation section of your friendly neighbourhood perl man pages (that's section 3pm for the uninitiated). It's a CPANPLUS plugin situation and honestly? it's giving "does the thing so you don't have to". 🫶

VERSION: version 0.90 ✨

---

🌸 NAME 🌸

CPANPLUS::Dist::Build — it's a CPANPLUS plugin that installs packages which use Build.PL. no cap. that's the whole gig. 💅

---

✨ SYNOPSIS ✨

look at her go:

my $build = CPANPLUS::Dist->new(
                            format  => 'CPANPLUS::Dist::Build',
                            module  => $modobj,
                        );

$build->prepare;    # runs Build.PL
$build->create;     # runs build && build test
$build->install;    # runs build install

see how it's literally just prepare, create, install? main character energy fr fr. 👑

---

🦋 DESCRIPTION 🦋

CPANPLUS::Dist::Build is a distribution class for modules related to Module::Build. Using this package, you can create, install and uninstall perl modules. She inherits from CPANPLUS::Dist, as one does. 💖

Normal users won't have to worry about the interface to this module, because it functions transparently as a plug-in to CPANPLUS and will just "Do The Right Thing" when it's loaded. iconic behaviour honestly. no notes. 😌

---

🎀 ACCESSORS 🎀

• parent() — Returns the CPANPLUS::Module object that parented this object. it's giving family tree. 🌳
• status() — Returns the Object::Accessor object that keeps the status for this module. the vibe check holder, if you will. ✨

---

💜 STATUS ACCESSORS 💜

All accessors can be accessed like this, bestie:

$build->status->ACCESSOR

• build_pl () — Location of the Build file. Set to 0 explicitly if something went wrong. 😭
• build () — BOOL indicating if the Build command was successful.
• test () — BOOL indicating if the Build test command was successful.
• prepared () — BOOL indicating if the prepare call exited successfully. This gets set after perl Build.PL.
• distdir () — Full path to the directory in which the prepare call took place, set after a call to prepare.
• created () — BOOL indicating if the create call exited successfully. This gets set after Build and Build test.
• installed () — BOOL indicating if the module was installed. This gets set after Build install exits successfully.
• uninstalled () — BOOL indicating if the module was uninstalled properly.
• _create_args () — Storage of the arguments passed to create for this object. Used for recursive calls when satisfying prerequisites. yes she's recursive, she contains multitudes. 🌈
• _install_args () — Storage of the arguments passed to install for this object. Used for recursive calls when satisfying prerequisites.

---

🔥 METHODS 🔥

$bool = CPANPLUS::Dist::Build->format_available();

Returns a boolean indicating whether or not you can use this package to create and install modules in your environment. it's a vibe check on your whole setup, honestly. 🫶

$bool = $dist->init();

Sets up the CPANPLUS::Dist::Build object for use. Effectively creates all the needed status accessors. ✨

Called automatically whenever you create a new CPANPLUS::Dist object. so like, you don't have to do anything. she's self-sufficient. 💅

$bool = $dist->prepare([perl => '/path/to/perl', buildflags => 'EXTRA=FLAGS', force => BOOL, verbose => BOOL])

prepare prepares a distribution, running Build.PL and establishing any prerequisites this distribution has. getting her ready for the big moment. 💖

The variable PERL5_CPANPLUS_IS_EXECUTING will be set to the full path of the Build.PL that is being executed. This enables any code inside the Build.PL to know that it is being installed via CPANPLUS. iykyk. 👀

After a successful prepare you may call create to create the distribution, followed by install to actually install it.

Returns true on success and false on failure. periodt.

$dist->create([perl => '/path/to/perl', buildflags => 'EXTRA=FLAGS', prereq_target => TARGET, force => BOOL, verbose => BOOL, skiptest => BOOL])

create preps a distribution for installation. This means it will run Build and Build test. This will also satisfy any prerequisites the module may have. doing the absolute most, and we love her for it. 🔥

If you set skiptest to true, it will skip the Build test stage. If you set force to true, it will go over all the stages of the Build process again, ignoring any previously cached results. It will also ignore a bad return value from Build test and still allow the operation to return true. (yes, force is that girl. she does not care. 😤)

Returns true on success and false on failure.

You may then call $dist->install on the object to actually install it.

$dist->install([verbose => BOOL, perl => /path/to/perl])

Actually installs the created dist. the moment we've all been waiting for. 💅✨

Returns true on success and false on failure.

---

👑 PROMINENCE 👑

Originally by Jos Boumans <kane@cpan.org>. Brought to working condition by Ken Williams <kwilliams@cpan.org>. 🫶

Other hackery and currently maintained by Chris "BinGOs" Williams ( no relation ). <bingos@cpan.org>.

not me being obsessed with the "( no relation )" note. that's so real. 😭

---

🧚 AUTHOR 🧚

Jos Boumans <kane[at]cpan.org>, Ken Williams <kwilliams@cpan.org>

---

🌈 COPYRIGHT AND LICENSE 🌈

This software is copyright (c) 2018 by Jos Boumans, Ken Williams, Chris Williams and David Golden.

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

---

and that's the whole page, bestie!! this was rendered with perl v5.32.1, dated 2022-01-01, under the CPANPL...::Build(3pm) header. slay, mwah, go install some modules 💖🎀🦋🌸⭐💜