Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

dist::zilla::role::filefinderuser(3pm) [debian man page]

Dist::Zilla::Role::FileFinderUser(3pm)			User Contributed Perl Documentation		    Dist::Zilla::Role::FileFinderUser(3pm)

NAME

       Dist::Zilla::Role::FileFinderUser - something that uses FileFinder plugins

VERSION

       version 4.300020

DESCRIPTION

       This role enables you to search for files in the dist. This makes it easy to find specific files and have the code factored out to common
       methods.

       Here's an example of a finder: ( taken from AutoPrereqs )

	 with 'Dist::Zilla::Role::FileFinderUser' => {
	     default_finders  => [ ':InstallModules', ':ExecFiles' ],
	 };

       Then you use it in your code like this:

	 foreach my $file ( $self->found_files ) {
	   # $file is an object! Look at L<Dist::Zilla::Role::File>
	 }

ATTRIBUTES

   finder_arg_names
       Define the name of the attribute which will hold this finder. Be sure to specify different names if you have multiple finders!

       This is an ArrayRef.

       Default: [ qw( finder ) ]

   default_finders
       This attribute is an arrayref of plugin names for the default plugins the consuming plugin will use as finder.s

       Example: "[ qw( :InstallModules :ExecFiles ) ]"

       The default finders are:

       :InstallModules
	   Searches your lib/ directory for pm/pod files

       :IncModules
	   Searches your inc/ directory for pm files

       :MainModule
	   Finds the "main_module" of your dist

       :TestFiles
	   Searches your t/ directory and lists the files in it.

       :ExecFiles
	   Searches your distribution for executable files.  Hint: Use the Dist::Zilla::Plugin::ExecDir plugin to mark those files as executables.

       :ShareFiles
	   Searches your ShareDir directory and lists the files in it.	Hint: Use the Dist::Zilla::Plugin::ShareDir plugin to setup the sharedir.

   method
       This will be the name of the subroutine installed in your package for this finder.  Be sure to specify different names if you have multiple
       finders!

       Default: found_files

AUTHOR

       Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

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

perl v5.14.2							    2012-06-21				    Dist::Zilla::Role::FileFinderUser(3pm)

Check Out this Related Man Page

Dist::Zilla::Plugin::MetaNoIndex(3pm)			User Contributed Perl Documentation		     Dist::Zilla::Plugin::MetaNoIndex(3pm)

NAME

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

VERSION

       version 4.300020

SYNOPSIS

       In your dist.ini:

	 [MetaNoIndex]

	 directory = t/author
	 directory = examples

	 file = lib/Foo.pm

	 package = My::Module

	 namespace = My::Module

DESCRIPTION

       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.

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 package "My::Package", only everything under it like "My::Package::Foo".

METHODS

   metadata
       Returns a reference to a hash containing the distribution's no_index metadata.

SEE ALSO

       Dist::Zilla roles: MetaProvider.

AUTHOR

       Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

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

perl v5.14.2							    2012-06-21				     Dist::Zilla::Plugin::MetaNoIndex(3pm)
Man Page