NAME

Acme::CPANModules::ModernPreambles - List of modules that offer modern preambles

VERSION

This document describes version 0.002 of Acme::CPANModules::ModernPreambles (from Perl distribution Acme-CPANModules-ModernPreambles), released on 2023-10-29.

DESCRIPTION

The overwhelming convention for coding Perl properly code is to at least add the following preamble:

 use strict;
 use warnings;

to the beginning of your code. But some people say that's not enough, and they develop modules/pragmas that bundle the above incantation plus some additional stuffs. For example:

 use Modern::Perl '2018';

is equivalent to:

 use strict;
 use warnings;
 use feature ':5.26';
 mro::set_mro( scalar caller(), 'c3' );

I think Modern::Perl is one of the first to popularize this modern preamble concept and a bunch of similar preambles emerged. This list catalogs them.

Meanwhile, you can also use:

 use v5.12; # enables strict and warnings, as well as all 5.12 features (see L<feature> for more details on new features of each perl release)

and so on, but this also means you set a minimum Perl version.

ACME::CPANMODULES ENTRIES

Alt::common::sense::TOBYINK

Author: TOBYINK

common::sense

Author: MLEHMANN

latest

Author: ANDYA

Modern::Perl

Author: CHROMATIC

nonsense

Author: JROCKWAY

perl5

Author: INGY

perl5i

Author: MSCHWERN

FAQ

What is an Acme::CPANModules::* module?

An Acme::CPANModules::* module, like this module, contains just a list of module names that share a common characteristics. It is a way to categorize modules and document CPAN. See Acme::CPANModules for more details.

What are ways to use this Acme::CPANModules module?

Aside from reading this Acme::CPANModules module's POD documentation, you can install all the listed modules (entries) using cpanm-cpanmodules script (from App::cpanm::cpanmodules distribution):

 % cpanm-cpanmodules -n ModernPreambles

Alternatively you can use the cpanmodules CLI (from App::cpanmodules distribution):

    % cpanmodules ls-entries ModernPreambles | cpanm -n

or Acme::CM::Get:

    % perl -MAcme::CM::Get=ModernPreambles -E'say $_->{module} for @{ $LIST->{entries} }' | cpanm -n

or directly:

    % perl -MAcme::CPANModules::ModernPreambles -E'say $_->{module} for @{ $Acme::CPANModules::ModernPreambles::LIST->{entries} }' | cpanm -n

This Acme::CPANModules module also helps lcpan produce a more meaningful result for lcpan related-mods command when it comes to finding related modules for the modules listed in this Acme::CPANModules module. See App::lcpan::Cmd::related_mods for more details on how "related modules" are found.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Acme-CPANModules-ModernPreambles.

SOURCE

Source repository is at https://github.com/perlancar/perl-Acme-CPANModules-ModernPreambles.

SEE ALSO

Acme::CPANModules - about the Acme::CPANModules namespace

cpanmodules - CLI tool to let you browse/view the lists

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

 % prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023, 2019 by perlancar <perlancar@cpan.org>.

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

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Acme-CPANModules-ModernPreambles

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

cpanm Acme::CPANModules::ModernPreambles

perl -MCPAN -e shell
install Acme::CPANModules::ModernPreambles