DOKK / manpages / debian 11 / libdist-zilla-perl / Dist::Zilla::Plugin::MetaNoIndex.3pm.en
Dist::Zilla::Plugin::MetaNoIndex(3pm) User Contributed Perl Documentation Dist::Zilla::Plugin::MetaNoIndex(3pm)

Dist::Zilla::Plugin::MetaNoIndex - Stop CPAN from indexing stuff

version 6.017

In your dist.ini:

  [MetaNoIndex]
  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.

Exclude folders and everything in them, for example: author.t

Aliases: "folder", "dir", "directory"

Exclude a specific file, for example: lib/Foo.pm

Alias: "file"

Exclude by package name, for example: "My::Package"

Aliases: "class", "module", "package"

Exclude everything under a specific namespace, for example: "My::Package"

Alias: "namespace"

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 😏 <rjbs@cpan.org>

This software is copyright (c) 2020 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.

2020-11-04 perl v5.30.3