The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Acme::CPANModules::CPANModules - List of modules related to Acme::CPANModules

VERSION

This document describes version 0.003 of Acme::CPANModules::CPANModules (from Perl distribution Acme-CPANModules-CPANModules), released on 2023-08-06.

DESCRIPTION

Specification

Acme::CPANModules is the specification.

CLIs

App::cpanmodules distribution contains the cpanmodules CLI to view lists and entries from the command-line.

App::lcpan::CmdBundle::cpanmodules distribution provides cpanmodules-* subcommands for App::lcpan which, like cpanmodules CLI, lets you view lists and entries from the command-line.

App::CPANModulesUtils distribution contains more CLI utilities related to Acme::CPANModules, e.g. acme-cpanmodules-for to find whether a module is mentioned in some Acme::CPANModules::* modules.

App::CreateAcmeCPANModulesImportModules

App::CreateAcmeCPANModulesImportCPANRatingsModules

Dist::Zilla (and Pod::Weaver)

If you develop CPAN modules with Dist::Zilla, you can use Dist::Zilla::Plugin::Acme::CPANModules and Pod::Weaver::Plugin::Acme::CPANModules. There is also Dist::Zilla::Plugin::Acme::CPANModules::Blacklist to prevent adding blacklisted dependencies into your distribution.

Other modules

TableData::Acme::CPANModules

Acme::CPANLists is an older, deprecated specification.

Pod::From::Acme::CPANModules

Snippets

Acme::CPANModules::CPANModules contains this snippet to create entries by extracting <pm:...> in the description:

 $LIST->{entries} = [
     map { +{module=>$_} }
         ($LIST->{description} =~ /<pm:(.+?)>/g)
 ];

This does not prevent duplicates. To do so:

 $LIST->{entries} = [
     map { +{module=>$_} }
         do { my %seen; grep { !$seen{$_}++ }
              ($LIST->{description} =~ /<pm:(.+?)>/g)
          }
 ];

ACME::CPANMODULES ENTRIES

Acme::CPANModules

Author: PERLANCAR

App::cpanmodules

Author: PERLANCAR

App::lcpan::CmdBundle::cpanmodules

Author: PERLANCAR

App::lcpan

Author: PERLANCAR

App::CPANModulesUtils

Author: PERLANCAR

App::CreateAcmeCPANModulesImportModules

Author: PERLANCAR

App::CreateAcmeCPANModulesImportCPANRatingsModules

Author: PERLANCAR

Dist::Zilla::Plugin::Acme::CPANModules

Author: PERLANCAR

Pod::Weaver::Plugin::Acme::CPANModules

Author: PERLANCAR

Dist::Zilla::Plugin::Acme::CPANModules::Blacklist

Author: PERLANCAR

TableData::Acme::CPANModules

Author: PERLANCAR

Acme::CPANLists
Pod::From::Acme::CPANModules

Author: PERLANCAR

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 CPANModules

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

    % cpanmodules ls-entries CPANModules | cpanm -n

or Acme::CM::Get:

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

or directly:

    % perl -MAcme::CPANModules::CPANModules -E'say $_->{module} for @{ $Acme::CPANModules::CPANModules::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-CPANModules.

SOURCE

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

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, 2020, 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-CPANModules

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.