Module...irStore(3pm)

πŸ“¦
version 0.144 Β· 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

πŸ’– Module::Starter::Plugin::DirStore β€” module template files in a directory πŸ’–

okay so bestie, this is a Perl module page (a 3pm one, if you're keeping score) straight out of the User Contributed Perl Documentation collection. Let's get into it. 🫢


✨ VERSION ✨

version 0.144 β€” that's the vibe, that's the number, no cap. 🌸


🌈 SYNOPSIS 🌈

Like, here's how you actually summon this thing:

use Module::Starter qw(
  Module::Starter::Simple
  Module::Starter::Plugin::Template
  Module::Starter::Plugin::DirStore
  ...
);

Module::Starter->create_distro( ... );

see that ... in there? that's you, filling in your own lil' details. go off. πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

So here's the tea, bestie. This plugin is a Module::Starter plugin, and the way it's designed to work is that you load it after Module::Starter::Plugin::Template. Order matters, okay? it's giving "sequel energy."

What it does: it implements the "templates" method β€” the one the Template plugin requires, like it literally cannot function without it β€” and the "DirStore" plugin's whole thing is that it stores all the required templates as files in a directory. That's the bit. That's the whole personality. πŸ“βœ¨


πŸ‘‘ METHODS πŸ‘‘

πŸ’« "templates"

This method reads in the template files and populates the object's "templates" attribute. Simple, iconic, does what it says on the tin. πŸŽ€

Now, how does it figure out where your module template directory even is? It checks things in this order:

  1. the MODULE_TEMPLATE_DIR environment variable first πŸ‘€
  2. and then the config option "template_dir"

So if the env var's set, that's the one it rides with. If not, it falls back to the config option. order of operations, bestie β€” respect it. 🧚


πŸ’œ AUTHOR πŸ’œ

Ricardo SIGNES, "<rjbs@cpan.org>" β€” the legend himself. πŸ‘‘


😭 Bugs 😭

found a bug? got a feature request? Please report any bugs or feature requests to "bug-module-starter-plugin-inlinestore@rt.cpan.org", or through the web interface at <http://rt.cpan.org>.

And here's the promise, direct from the source: "I will be notified, and then you'll automatically be notified of progress on your bug as I make changes." So like... you will hear back. the pipeline is real. πŸ”₯

ngl, that email address says inlinestore and not dirstore β€” but that's literally what the page says, so I'm not touching it. do not come for me. πŸ’€

Copyright 2004 Ricardo SIGNES, All Rights Reserved. ✨

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. free as in freedom, free as in slay. πŸ¦‹


and that's the whole page, bestie β€” every flag, every method, every email, nothing skipped, nothing invented. πŸ’–

This lil' slice of documentation came to you courtesy of perl v5.32.0, dated 2021-01-09, and the page header itself (yes, the Module...irStore(3pm) one, truncated and everything) plus that User Contributed Perl Documentation badge up top. periodt. πŸ’…βœ¨