Dist::Zilla::Plugin::FileFinder::ByName(3)

NAME
Dist::Zilla::Plugin::FileFinder::ByName - FileFinder matching on pathnames

VERSION
version 6.033

SYNOPSIS
In your dist.ini:

  [FileFinder::ByName / MyFiles]
  dir   = bin     ; look in the bin/ directory
  dir   = lib     ; and the lib/ directory
  file  = *.pl    ; for .pl files
  match = \.pm$   ; and for .pm files
  skip  = ignore  ; that don't have "ignore" in the path

DESCRIPTION
FileFinder::ByName is a FileFinder that selects files by matching the criteria you specify against the pathname.

There are three types of criteria you can use. "dir" limits the search to a particular directory. "match" is a regular expression that must match the pathname. "skip" is a regular expression that must not match the pathname.

Each key can be specified multiple times. Multiple occurrences of the same key are ORed together. Different keys are ANDed together. That means that to be selected, a file must be located in one of the "dir"s, must match one of the "match" regexs, and must not match any of the "skip" regexs.

Note that "file" and "match" are considered to be the same key. They're just different ways to write a regex that the pathname must match.

Omitting a particular key means that criterion will not apply to the search. Omitting all keys will select every file in your dist.

Note: If you need to OR different types of criteria, then use more than one instance of FileFinder::ByName. A FileFinderUser should allow you to specify more than one FileFinder to use.

PERL VERSION
This module should work on any version of perl still receiving updates from the Perl 5 Porters. This means it should work on any version of perl released in the last two to three years. (That is, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.)

Although it may work on older versions of perl, no guarantee is made that the minimum required version will not 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.

ATTRIBUTES

  dir
The file must be located in one of the specified directories (relative to the root directory of the dist).

  file
The filename must match one of the specified patterns (which are converted to regexs using Text::Glob and combined with any "match" rules).

  match
The pathname must match one of these regular expressions.

  skip
The pathname must not match any of these regular expressions.

CREDITS
This plugin was originally contributed by Christopher J. Madsen.

AUTHOR
Ricardo SIGNES 😏 <cpan@semiotic.systems>

COPYRIGHT AND LICENSE
This software is copyright (c) 2025 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.