Scroll to navigation

Dist::Zilla::Prereqs(3pm) User Contributed Perl Documentation Dist::Zilla::Prereqs(3pm)

NAME

Dist::Zilla::Prereqs - the prerequisites of a Dist::Zilla distribution

VERSION

version 6.030

DESCRIPTION

Dist::Zilla::Prereqs is a subcomponent of Dist::Zilla. The "prereqs" attribute on your Dist::Zilla object is a Dist::Zilla::Prereqs object, and is responsible for keeping track of the distribution's prerequisites.

In fact, a Dist::Zilla::Prereqs object is just a thin layer over a CPAN::Meta::Prereqs object, stored in the "cpan_meta_prereqs" attribute.

Almost everything this object does is proxied to the CPAN::Meta::Prereqs object, so you should really read how that works.

Dist::Zilla::Prereqs proxies the following methods to the CPAN::Meta::Prereqs object:

  • finalize
  • is_finalized
  • requirements_for
  • as_string_hash

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.

METHODS

register_prereqs

  $prereqs->register_prereqs(%prereqs);
  $prereqs->register_prereqs(\%arg, %prereqs);

This method adds new minimums to the prereqs object. If a hashref is the first arg, it may have entries for "phase" and "type" to indicate what kind of prereqs are being registered. (For more information on phase and type, see CPAN::Meta::Spec.) For example, you might say:

  $prereqs->register_prereqs(
    { phase => 'test', type => 'recommends' },
    'Test::Foo' => '1.23',
    'XML::YZZY' => '2.01',
  );

If not given, phase and type default to runtime and requires, respectively.

AUTHOR

Ricardo SIGNES 😏 <cpan@semiotic.systems>

COPYRIGHT AND LICENSE

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

2023-01-19 perl v5.36.0