Dist::Z...::ByName(3)

💖 Dist::Z...::ByName(3) 💖

okay bestie, so this is the manual page for Dist::Zilla::Plugin::FileFinder::ByName — you're reading the Dist::Z...::ByName(3) page, and ngl it's a sleeper hit. it's a FileFinder, which means it picks out files for you based on pathnames. tiny module, immaculate vibes 💅

---

✨ NAME ✨

Dist::Zilla::Plugin::FileFinder::ByName — a FileFinder that matches on pathnames 🦋

🌸 VERSION 🌸

version 6.040

🎀 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

look at that. she's organized. she's specific. she knows exactly what she wants 🌈

💜 DESCRIPTION 💜

FileFinder::ByName is a FileFinder that selects files by matching the criteria you specify against the pathname. that's it, that's the whole thing, and the way it does it is so clean.

there are three types of criteria you can use, and honestly each one is doing its own little job:

• "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. so to get selected, a file has to:

1. be located in one of the "dir"s,
2. match one of the "match" regexs,
3. and not match any of the "skip" regexs.

periodt. that's the whole selection algorithm, no cap.

heads up bestie — "file" and "match" are considered to be the same key. they're just different ways to write a regex that the pathname must match. don't come for me, I'm just the messenger 🙈

Omitting a particular key means that criterion will not apply to the search. Omitting all keys will select every file in your dist. (iconic behavior, but maybe not what you meant to do.)

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. iykyk 💅

🦋 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. so like… don't get attached to ancient perl, she may not be invited to the function later 😭

---

👑 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. we love a founding contributor 🫶

⭐ AUTHOR ⭐

Ricardo SIGNES 😏 <cpan@semiotic.systems>

💖 COPYRIGHT AND LICENSE 💖

This software is copyright (c) 2026 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. free as in, go off, do your thing, slay 💅

---

aaaand that's the whole page bestie, no notes. this was Dist::Z...::ByName(3), generated from perl v5.42.3 on 2026-10-19 — go find some files, you're gonna eat 🍓✨