Dist::Zilla::Plugin::MetaNoIndex - Stop CPAN from indexing stuff
In your dist.ini:
directory = t/author
directory = examples
file = lib/Foo.pm
package = My::Module
namespace = My::Module
This plugin allows you to prevent PAUSE/CPAN from indexing files you don't want indexed. This is useful if you build test classes or example classes that are used for those purposes only, and are not part of the distribution. It does this by adding a no_index block to your META.json (or META.yml) file in your distribution.
This module should work on any version of perl still receiving updates from the Perl 5 Porters. This means it should work on any version of perl released in the last two to three years. (That is, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.)
Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.
Exclude folders and everything in them, for example: author.t
Aliases: folder, dir, directory
Exclude a specific file, for example: lib/Foo.pm
Exclude by package name, for example: My::Package
Aliases: class, module, package
Exclude everything under a specific namespace, for example: My::Package
NOTE: This will not exclude the package My::Package, only everything under it like My::Package::Foo.
Returns a reference to a hash containing the distribution's no_index metadata.
Dist::Zilla roles: MetaProvider.
Ricardo SIGNES 😏 <email@example.com>
This software is copyright (c) 2023 by Ricardo SIGNES.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Dist::Zilla, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.