Dist::Z...NoIndex(3)
β¨ NAME β¨
Dist::Zilla::Plugin::MetaNoIndex β aka the thing that stops CPAN from indexing your stuff π
(Yes bestie, this is a User Contributed Perl Documentation page, and you're in the right place. It's giving "my distribution, my rules" energy fr fr.)
πΈ VERSION πΈ
version 6.040
π SYNOPSIS π
Drop this in your dist.ini and you're cooking:
[MetaNoIndex]
directory = t/author
directory = examples
file = lib/Foo.pm
package = My::Module
namespace = My::Module
π DESCRIPTION π
Okay so picture this: you've got test classes, example classes, little helper thingies that exist only to make your test suite and docs go brrr β and they are absolutely not part of what your distribution actually ships. π
This plugin is the bouncer at the club. π«Ά It lets you stop PAUSE/CPAN from indexing files you don't want indexed. Perfect for exactly that situation: test classes and example classes that are used for those purposes only and aren't part of the distribution.
And how does it pull this off? Iconic behaviour honestly: it adds a no_index block to your META.json (or META.yml) file in your distribution. That's it. That's the whole move. β¨
π₯ PERL VERSION π₯
This module should work on any version of perl still receiving updates from the Perl 5 Porters. Which means it should work on any version of perl released in the last two to three years. (Translation: if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.) π
Ngl bestie, lowkey works on older perls too, but no guarantee is made that the minimum required version won't 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. That's the deal. π
π ATTRIBUTES π
π directories
Exclude folders and everything in them, for example: author.t
Aliases: folder, dir, directory
π¦ files
Exclude a specific file, for example: lib/Foo.pm
Alias: file
π packages
Exclude by package name, for example: My::Package
Aliases: class, module, package
π§ namespaces
Exclude everything under a specific namespace, for example: My::Package
Alias: namespace
NOTE: This will not exclude the packageMy::Package, only everything under it likeMy::Package::Foo. Read it twice bestie, it's the sneaky one. β
π METHODS π
β¨ metadata
Returns a reference to a hash containing the distribution's no_index metadata. That's the whole vibe. π
π SEE ALSO π
Dist::Zilla roles: MetaProvider.
π AUTHOR π
Ricardo SIGNES π <cpan@semiotic.systems>
π COPYRIGHT AND LICENSE π
This software is copyright (c) 2026 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.
And that's a wrap, bestie!! π«Ά This was perl v5.42.3, dated 2026-10-19, and you just read the Dist::Z...NoIndex(3) page top to bottom. Go forth and no_index responsibly. Periodt. πβ¨
π¦ where this page comes from
- fedora 44: perl-Dist-Zilla 6.040-1.fc44 Β· GPL-1.0-or-later OR Artistic-1.0-Perl
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms