1Dist::Zilla::Plugin::MeUtsaeNroICnodnetxr(i3b)uted PerlDDiosctu:m:eZnitlaltai:o:nPlugin::MetaNoIndex(3)
2
3
4

NAME

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

VERSION

9       version 6.024
10

SYNOPSIS

12       In your dist.ini:
13
14         [MetaNoIndex]
15
16         directory = t/author
17         directory = examples
18
19         file = lib/Foo.pm
20
21         package = My::Module
22
23         namespace = My::Module
24

DESCRIPTION

26       This plugin allows you to prevent PAUSE/CPAN from indexing files you
27       don't want indexed. This is useful if you build test classes or example
28       classes that are used for those purposes only, and are not part of the
29       distribution.  It does this by adding a "no_index" block to your
30       META.json (or META.yml) file in your distribution.
31

PERL VERSION

33       This module should work on any version of perl still receiving updates
34       from the Perl 5 Porters.  This means it should work on any version of
35       perl released in the last two to three years.  (That is, if the most
36       recently released version is v5.40, then this module should work on
37       both v5.40 and v5.38.)
38
39       Although it may work on older versions of perl, no guarantee is made
40       that the minimum required version will not be increased.  The version
41       may be increased for any reason, and there is no promise that patches
42       will be accepted to lower the minimum required perl.
43

ATTRIBUTES

45   directories
46       Exclude folders and everything in them, for example: author.t
47
48       Aliases: "folder", "dir", "directory"
49
50   files
51       Exclude a specific file, for example: lib/Foo.pm
52
53       Alias: "file"
54
55   packages
56       Exclude by package name, for example: "My::Package"
57
58       Aliases: "class", "module", "package"
59
60   namespaces
61       Exclude everything under a specific namespace, for example:
62       "My::Package"
63
64       Alias: "namespace"
65
66       NOTE: This will not exclude the package "My::Package", only everything
67       under it like "My::Package::Foo".
68

METHODS

70   metadata
71       Returns a reference to a hash containing the distribution's no_index
72       metadata.
73

SEE ALSO

75       Dist::Zilla roles: MetaProvider.
76

AUTHOR

78       Ricardo SIGNES 😏 <rjbs@semiotic.systems>
79

81       This software is copyright (c) 2021 by Ricardo SIGNES.
82
83       This is free software; you can redistribute it and/or modify it under
84       the same terms as the Perl 5 programming language system itself.
85
86
87
88perl v5.34.0                      2022-01-21Dist::Zilla::Plugin::MetaNoIndex(3)
Impressum