1Dist::Zilla::Plugin::PrUesreerqsC(o3n)tributed Perl DocuDmiesntt:a:tZiiolnla::Plugin::Prereqs(3)
2
3
4
6 Dist::Zilla::Plugin::Prereqs - list simple prerequisites
7
9 version 6.031
10
12 In your dist.ini:
13
14 [Prereqs]
15 Foo::Bar = 1.002
16 MRO::Compat = 10
17 Sub::Exporter = 0
18
19 You can specify requirements for different phases and relationships
20 with:
21
22 [Prereqs]
23 -phase = test
24 -relationship = recommends
25
26 Fitz::Fotz = 1.23
27 Text::SoundEx = 3
28
29 Remember that if you load two Prereqs plugins, each will needs its own
30 name, added like this:
31
32 [Prereqs / PluginName]
33 -phase = test
34 -relationship = recommends
35
36 Fitz::Fotz = 1.23
37 Text::SoundEx = 3
38
39 If the name is the CamelCase concatenation of a phase and relationship
40 (or just a relationship), it will set those parameters implicitly. If
41 you use a custom name, but it does not specify the relationship, and
42 you didn't specify either "-phase" or "-relationship", it throws the
43 error "No -phase or -relationship specified". This is to prevent a
44 typo that makes the name meaningless from slipping by unnoticed.
45
46 The example below is equivalent to the example above, except for the
47 name of the resulting plugin:
48
49 [Prereqs / TestRecommends]
50 Fitz::Fotz = 1.23
51 Text::SoundEx = 3
52
54 This module adds "fixed" prerequisites to your distribution. These are
55 prereqs with a known, fixed minimum version that doesn't change based
56 on platform or other conditions.
57
58 You can specify prerequisites for different phases and kinds of
59 relationships. In "RuntimeRequires", the phase is Runtime and the
60 relationship is Requires. These are described in more detail in the
61 CPAN::Meta specification.
62
63 The phases are:
64
65 • configure
66
67 • build
68
69 • test
70
71 • runtime
72
73 • develop
74
75 The relationship types are:
76
77 • requires
78
79 • recommends
80
81 • suggests
82
83 • conflicts
84
85 If the phase is omitted, it will default to runtime; thus, specifying
86 "Prereqs / Recommends" in your dist.ini is equivalent to
87 RuntimeRecommends.
88
89 Not all of these phases are useful for all tools, especially tools that
90 only understand version 1.x CPAN::Meta files.
91
93 This module should work on any version of perl still receiving updates
94 from the Perl 5 Porters. This means it should work on any version of
95 perl released in the last two to three years. (That is, if the most
96 recently released version is v5.40, then this module should work on
97 both v5.40 and v5.38.)
98
99 Although it may work on older versions of perl, no guarantee is made
100 that the minimum required version will not be increased. The version
101 may be increased for any reason, and there is no promise that patches
102 will be accepted to lower the minimum required perl.
103
105 • Core Dist::Zilla plugins: @Basic, AutoPrereqs.
106
107 • The CPAN Meta specification: "PREREQUISITES" in CPAN::Meta.
108
110 Ricardo SIGNES 😏 <cpan@semiotic.systems>
111
113 This software is copyright (c) 2023 by Ricardo SIGNES.
114
115 This is free software; you can redistribute it and/or modify it under
116 the same terms as the Perl 5 programming language system itself.
117
118
119
120perl v5.36.1 2023-11-21 Dist::Zilla::Plugin::Prereqs(3)