/ 
Dist-Zilla-Plugin-Acme-CPANModules-Blacklist-0.002
River stage one • 2 direct dependents • 2 total dependents
/ Dist::Zilla::Plugin::Acme::CPANModules::Blacklist

NAME

Dist::Zilla::Plugin::Acme::CPANModules::Blacklist - Blacklist prereqs using an Acme::CPANModules module

VERSION

This document describes version 0.002 of Dist::Zilla::Plugin::Acme::CPANModules::Blacklist (from Perl distribution Dist-Zilla-Plugin-Acme-CPANModules-Blacklist), released on 2023-07-09.

SYNOPSIS

In dist.ini:

[Acme::CPANModules::Blacklist]
module=PERLANCAR::Avoided

During build, if there is a prereq to a module listed in the above Acme::CPANModules::PERLANCAR::Avoided, the build process will be aborted.

Currently prereqs with custom phase (/^x_/) or custom relationship are ignored.

DESCRIPTION

Acme::CPANModules::* modules contains lists of modules. With this plugin, you can specify a blacklist to modules in those lists.

If you specify a module, e.g.:

module=SomeName

then a module called Acme::CPANModules::SomeName will be loaded, and all modules listed in the module's $LIST will be added to the blacklist.

To specify more Acme::CPANModules modules, add more module= lines.

Later in the build, when a prereq is specified against one of the blacklisted modules, an error message will be thrown and the build process aborted.

To whitelist a module, list it in the Whitelist configuration in dist.ini:

[Acme::CPANModules::Whitelist]
module=Log::Any

To whitelist more modules, add more module= lines.

CONFIGURATION

module

Str. Can be specified more than once. Module name to blacklist.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Dist-Zilla-Plugin-Acme-CPANModules-Blacklist.

SOURCE

Source repository is at https://github.com/perlancar/perl-Dist-Zilla-Plugin-Acme-CPANModules-Blacklist.

SEE ALSO

Acme::CPANModules

Acme::CPANModules::* modules

Dist::Zilla::Plugin::CPANModules::Whitelist

Dist::Zilla::Plugin::CPANAuthors::Blacklist

Dist::Zilla::Plugin::CPANAuthors::Whitelist

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, 2018 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=Dist-Zilla-Plugin-Acme-CPANModules-Blacklist

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.