GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  DIST::ZILLA::ROLE::FILEFINDERUSER (3)

.ds Aq ’

NAME

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

CONTENTS

VERSION

version 4.300030

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) 2013 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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 DIST::ZILLA::ROLE::FILEFINDERUSER (3) 2013-01-31

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.