Scroll to navigation

Dist::Zilla::Util::AuthorDeps(3pm) User Contributed Perl Documentation Dist::Zilla::Util::AuthorDeps(3pm)

NAME

Dist::Zilla::Util::AuthorDeps - Utils for listing your distribution's author dependencies

VERSION

version 6.036

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.

FUNCTIONS

extract_author_deps

  my $prereqs = extract_author_deps($dist_root, $missing_only);

This returns a reference to an array in the form:

  [
    { $module1 => $ver1 },
    { $module2 => $ver2 },
    ...
  ]

Each entry is one of the likely author dependencies for the distribution at the root path $dist_root. If $missing_only is true, then prereqs that appear to be available under the running perl will not be included.

This function is not really meant to be reliable. It was undocumented and subject to change at any time, but some downstream libraries chose to use it anyway. I may provide a replacement, at some point, at which point this method will be deprecated and begin issuing a warning. I have documented this method only to provide this warning!

format_author_deps

  my $string = format_author_deps($prereqs, $include_versions);

Given a reference to an array in the format returned by "extract_author_deps", this returns a string in the form:

  Module::One
  Module::Two
  Module::Three

or, if $include_versions is true:

  Module::One = 1.00
  Module::Two = 1.23
  Module::Three = 8.910213

This function is not really meant to be reliable. It was undocumented and subject to change at any time, but some downstream libraries chose to use it anyway. I may provide a replacement, at some point, at which point this method will be deprecated and begin issuing a warning. I have documented this method only to provide this warning!

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.

2025-11-10 perl v5.40.1