Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Plugin.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Test2::Plugin 3pm"
61 .TH Test2::Plugin 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Test2::Plugin \- Documentation for plugins
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 Plugins are packages that cause behavior changes, or other side\-effects for the
71 test file that loads them. They should not export any functions, or provide any
72 tools. Plugins should be distinct units of functionality.
73 .PP
74 If you wish to combine behavior changes with tools then you should write a
75 Plugin, a Tools module, and a bundle that loads them both.
76 .SH FAQ
77 .IX Header "FAQ"
78 .IP "Should I subclass Test2::Plugin?" 4
79 .IX Item "Should I subclass Test2::Plugin?"
80 No. Currently this class is empty. Eventually we may want to add behavior, in
81 which case we do not want anyone to already be subclassing it.
82 .SH "HOW DO I WRITE A PLUGIN?"
83 .IX Header "HOW DO I WRITE A PLUGIN?"
84 Writing a plugin is not as simple as writing an Test2::Bundle, or writing
85 Test2::Tools. Plugins alter behavior, or cause desirable side\-effects. To
86 accomplish this you typically need a custom \f(CWimport()\fR method that calls one
87 or more functions provided by the Test2::API package.
88 .PP
89 If you want to write a plugin you should look at existing plugins, as well as
90 the Test2::API and Test2::Hub documentation. There is no formula for a
91 Plugin, they are generally unique, however consistent rules are that they
92 should not load other plugins, or export any functions.
93 .SH SOURCE
94 .IX Header "SOURCE"
95 The source code repository for Test2\-Suite can be found at
96 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
97 .SH MAINTAINERS
98 .IX Header "MAINTAINERS"
99 .IP "Chad Granum <[email protected]>" 4
100 .IX Item "Chad Granum <[email protected]>"
101 .SH AUTHORS
102 .IX Header "AUTHORS"
103 .IP "Chad Granum <[email protected]>" 4
104 .IX Item "Chad Granum <[email protected]>"
105 .SH COPYRIGHT
106 .IX Header "COPYRIGHT"
107 Copyright Chad Granum <[email protected]>.
108 .PP
109 This program is free software; you can redistribute it and/or
110 modify it under the same terms as Perl itself.
111 .PP
112 See \fIhttp://dev.perl.org/licenses/\fR