ExtUti...alizers(3pm)

πŸ“¦
version 0.63 Β· 2 versions
  • 0.63 Β· debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
  • 0.63 Β· ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

πŸ’– ExtUtils::ModuleMaker::Initializers πŸ’–

okay bestie, you found the 3pm page β€” it's part of the User Contributed Perl Documentation, and it's literally the backstage-pass page for ExtUtils::ModuleMaker. Pull up a chair, grab a boba πŸ§‹, and let's get into it.


🌸 NAME 🌸

ExtUtils::ModuleMaker::Initializers β€” the methods used inside ExtUtils::ModuleMaker::new() and ExtUtils::ModuleMaker::Interactive::Main_Menu ✨


πŸ¦‹ DESCRIPTION πŸ¦‹

So the methods down below? They're 'quasi-private'. Which is giving "private but not really, we're just not gonna stop you" energy. πŸ’…

They get called by certain publicly available methods of ExtUtils::ModuleMaker and ExtUtils::ModuleMaker::Interactive. The whole 'quasi-private' thing means they are not meant to be called by the everyday user of ExtUtils::ModuleMaker. Nothing stops you from calling them, bestie β€” the door's unlocked, no cap β€” but they're documented here primarily so that users writing plug-ins for ExtUtils::ModuleMaker will know what methods need to be subclassed. πŸ‘‘

And since they are not part of the public interface, their names and functionality may change in future versions of ExtUtils::ModuleMaker. So don't get too attached, fr fr. 😭

The methods below are called in ExtUtils::ModuleMaker::new() but not in that same package's complete_build. For methods called in complete_build, please see ExtUtils::ModuleMaker::StandardText. Some of the methods below are also called within methods in ExtUtils::ModuleMaker::Interactive.

Subclassers: listen up 🫢 β€” at ExtUtils::ModuleMaker's current state of development, it is recommended that you not subclass these methods but instead focus your efforts on subclassing the methods in ExtUtils::ModuleMaker::StandardText. The latter package's methods focus more closely on the structure and content of the files built by ExtUtils::ModuleMaker.

Happy subclassing! πŸŽ€


⭐ METHODS ⭐

πŸ’œ Methods Called within new()

set_author_composite

Usage     : $self->set_author_composite() within new() and
            Interactive::Main_Menu()
Purpose   : Sets $self key COMPOSITE by composing it from $self keys AUTHOR,
            CPANID, ORGANIZATION, EMAIL and WEBSITE
Returns   : n/a
Argument  : n/a
Comment   :

It's giving "assemble the author identity from all the little pieces" πŸ’« β€” AUTHOR, CPANID, ORGANIZATION, EMAIL and WEBSITE all walk in, and out comes COMPOSITE.

set_file_composite

Usage     : $self->set_file_composite() within new()
Purpose   : Sets $self key COMPOSITE by composing it from $self key NAME
Returns   : n/a
Argument  : n/a
Comment   :

Same energy, but for files. It sets the $self key COMPOSITE by composing it from the $self key NAME. Simple. Iconic. 🌈

set_dates()

Usage     : $self->set_dates() within new()
Purpose   : Sets 3 keys in $self:  year, timestamp and COPYRIGHT_YEAR
Returns   : n/a
Argument  : n/a
Comment   :

Three keys, one call: year, timestamp and COPYRIGHT_YEAR. ⏰ The way that it just... handles time for you. Obsessed.

validate_values()

Usage     : $self->validate_values() within complete_build() and
            Interactive::Main_Menu()
Purpose   : Verify module values are valid and complete.
Returns   : Error message if there is a problem
Argument  : n/a
Throws    : Will die with a death_message if errors and not interactive.
Comment   : References many $self keys

This is the vibe-check method πŸ•΅οΈβ™€οΈ β€” it verifies your module values are valid and complete.

  • Returns an error message if there is a problem.
  • Throws: will die with a death_message if there are errors and it's not interactive. Not a drill. It literally dies. πŸ’€
  • Comment: references many $self keys, iykyk.

initialize_license

Usage     : $self->initialize_license() within new() and
            Interactive::License_Menu
Purpose   : Gets appropriate license and, where necessary, fills in 'blanks'
            with information such as COPYRIGHT_YEAR, AUTHOR and
            ORGANIZATION; sets $self keys LICENSE and LicenseParts
Returns   : n/a
Argument  : n/a
Comment   :

Legal-ish but make it cute ✨ It gets the appropriate license and, where necessary, fills in the 'blanks' with information such as COPYRIGHT_YEAR, AUTHOR and ORGANIZATION. Then it sets the $self keys LICENSE and LicenseParts. Slay. πŸ‘‘


🌈 SEE ALSO 🌈

ExtUtils::ModuleMaker.


And that's the whole page, bestie! πŸŽ€ This one came from perl v5.36.0, dated 2023-01-27, and yes β€” the footer is doing that cute little abbreviation thing, ExtUti...alizers(3pm), because even manpage footers gotta be mysterious sometimes. πŸ’…βœ¨ Mwah, go build something iconic. πŸ¦‹

πŸ“¦ where this page comes from