« Pod/Weaver/Section/Author/HAYOBAAN/Bugs.pm
↑ Summary
Dist/Zilla/Plugin/Author/HAYOBAAN/LinkCheck.pm »
| 1 | package Pod::Weaver::PluginBundle::Author::HAYOBAAN; | ||
| 2 | 3 | ▶ | use strict; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 3 | 3 | ▶ | use warnings; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | |||
| 5 | # ABSTRACT: HAYOBAAN's Pod::Weaver configuration | ||
| 6 | 3 | our $VERSION = '0.016'; # VERSION | |
| 7 | |||
| 8 | #pod =head1 DESCRIPTION | ||
| 9 | #pod | ||
| 10 | #pod This is a L<Pod::Weaver> PluginBundle, set up according to HAYOBAAN's | ||
| 11 | #pod preferences. | ||
| 12 | #pod | ||
| 13 | #pod It's main features are: | ||
| 14 | #pod | ||
| 15 | #pod =begin :list | ||
| 16 | #pod | ||
| 17 | #pod * Specific sequence of headings | ||
| 18 | #pod | ||
| 19 | #pod * Region collectors for: | ||
| 20 | #pod | ||
| 21 | #pod =for :list | ||
| 22 | #pod * requires (Requirements) | ||
| 23 | #pod * var (Variables) | ||
| 24 | #pod * func (Functions) | ||
| 25 | #pod * c_attr (Class Attributes) | ||
| 26 | #pod * attr (Attributes) | ||
| 27 | #pod * construct (Constructors) | ||
| 28 | #pod * c_method (Class Methods) | ||
| 29 | #pod * method (Methods) | ||
| 30 | #pod | ||
| 31 | #pod * Replacing the original pod statements with comments, allowing line | ||
| 32 | #pod numbers to stay the same between development and build versions. | ||
| 33 | #pod | ||
| 34 | #pod =end :list | ||
| 35 | #pod | ||
| 36 | #pod It is roughly equivalent to the following weaver.ini: | ||
| 37 | #pod | ||
| 38 | #pod [@CorePrep] | ||
| 39 | #pod | ||
| 40 | #pod [-SingleEncoding] | ||
| 41 | #pod [-Transformer] | ||
| 42 | #pod transformer = List | ||
| 43 | #pod | ||
| 44 | #pod [Name] | ||
| 45 | #pod [Version] | ||
| 46 | #pod | ||
| 47 | #pod [Region / prelude] | ||
| 48 | #pod | ||
| 49 | #pod [Generic / SYNOPSIS] | ||
| 50 | #pod [Generic / DESCRIPTION] | ||
| 51 | #pod [Generic / OVERVIEW] | ||
| 52 | #pod [Generic / USAGE] | ||
| 53 | #pod [Generic / OPTIONS] | ||
| 54 | #pod | ||
| 55 | #pod [Collect / REQUIREMENTS] | ||
| 56 | #pod command = requires | ||
| 57 | #pod | ||
| 58 | #pod [Collect / VARIABLES] | ||
| 59 | #pod command = var | ||
| 60 | #pod | ||
| 61 | #pod [Collect / FUNCTIONS] | ||
| 62 | #pod command = func | ||
| 63 | #pod | ||
| 64 | #pod [Collect / CLASS ATTRIBUTES] | ||
| 65 | #pod command = c_attr | ||
| 66 | #pod | ||
| 67 | #pod [Collect / ATTRIBUTES] | ||
| 68 | #pod command = attr | ||
| 69 | #pod | ||
| 70 | #pod [Collect / CONSTRUCTORS] | ||
| 71 | #pod command = construct | ||
| 72 | #pod | ||
| 73 | #pod [Collect / CLASS METHODS] | ||
| 74 | #pod command = c_method | ||
| 75 | #pod | ||
| 76 | #pod [Collect / METHODS] | ||
| 77 | #pod command = method | ||
| 78 | #pod | ||
| 79 | #pod [Leftovers] | ||
| 80 | #pod | ||
| 81 | #pod [Region /postlude] | ||
| 82 | #pod | ||
| 83 | #pod [Bugs] | ||
| 84 | #pod [Generic / STABILITY] | ||
| 85 | #pod [Generic / COMPATIBILITY] | ||
| 86 | #pod [Generic / SEE ALSO] | ||
| 87 | #pod [Generic / CREDITS] | ||
| 88 | #pod [Authors] | ||
| 89 | #pod [Legal] | ||
| 90 | #pod | ||
| 91 | #pod =head1 USAGE | ||
| 92 | #pod | ||
| 93 | #pod Add the following line to your F<weaver.ini>: | ||
| 94 | #pod | ||
| 95 | #pod [@Author::HAYOBAAN] | ||
| 96 | #pod | ||
| 97 | #pod or, these lines to your F<dist.ini> file: | ||
| 98 | #pod | ||
| 99 | #pod [PodWeaver] | ||
| 100 | #pod config_plugin = @Author::HAYOBAAN | ||
| 101 | #pod | ||
| 102 | #pod Alternatively you can also add the following line to your F<dist.ini> | ||
| 103 | #pod (this will also enable HAYOBAAN's L<Dist::Zilla> setup): | ||
| 104 | #pod | ||
| 105 | #pod [@Author::HAYOBAAN] | ||
| 106 | #pod | ||
| 107 | #pod | ||
| 108 | #pod =head1 SEE ALSO | ||
| 109 | #pod | ||
| 110 | #pod =for :list | ||
| 111 | #pod * L<Pod::Weaver> | ||
| 112 | #pod * L<Pod::Elemental::Transformer::List> | ||
| 113 | #pod * L<Pod::Elemental::PerlMunger> | ||
| 114 | #pod * L<Pod::Weaver::Section::Autor::HAYOBAAN::Bugs> | ||
| 115 | #pod * L<Dist::Zilla::Plugin::PodWeaver> | ||
| 116 | #pod | ||
| 117 | #pod =for Pod::Coverage mvp_bundle_config | ||
| 118 | #pod | ||
| 119 | #pod =cut | ||
| 120 | |||
| 121 | 3 | ▶ | use Pod::Weaver::Config::Assembler; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 122 | 28 | ▶ | sub _exp { return Pod::Weaver::Config::Assembler->expand_package( $_[0] ) } |
|
Subroutine
_exp: called CC=1 SCAR=0.0
| |||
| 123 | |||
| 124 | # Required non-core Pod Weaver modules | ||
| 125 | 3 | ▶ | use Pod::Elemental::Transformer::List (); |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 126 | 3 | ▶ | use Pod::Elemental::PerlMunger (); |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 127 | |||
| 128 | 1 | ▶ | sub mvp_bundle_config { |
|
Subroutine
mvp_bundle_config: called CC=2 SCAR=6.9
Pod
undocumented
| |||
| 129 | 1 | my @plugins; | |
| 130 | 1 | push @plugins, ( | |
| 131 | [ '@HAYOBAAN/CorePrep', _exp('@CorePrep'), {} ], | ||
| 132 | |||
| 133 | [ '@HAYOBAAN/SingleEncoding', _exp('-SingleEncoding'), {} ], | ||
| 134 | [ '@HAYOBAAN/List', _exp('-Transformer'), { 'transformer' => 'List' } ], | ||
| 135 | |||
| 136 | [ '@HAYOBAAN/Name', _exp('Name'), {} ], | ||
| 137 | [ '@HAYOBAAN/Version', _exp('Version'), {} ], | ||
| 138 | |||
| 139 | [ '@HAYOBAAN/Prelude', _exp('Region'), { region_name => 'prelude' } ], | ||
| 140 | |||
| 141 | [ '@HAYOBAAN/Synopsis', _exp('Generic'), { header => 'SYNOPSIS' } ], | ||
| 142 | [ '@HAYOBAAN/Description', _exp('Generic'), { header => 'DESCRIPTION' } ], | ||
| 143 | [ '@HAYOBAAN/Overview', _exp('Generic'), { header => 'OVERVIEW' } ], | ||
| 144 | [ '@HAYOBAAN/Usage', _exp('Generic'), { header => 'USAGE' } ], | ||
| 145 | [ '@HAYOBAAN/Options', _exp('Generic'), { header => 'OPTIONS' } ], | ||
| 146 | ); | ||
| 147 | |||
| 148 | 1 | for my $plugin ( | |
| 149 | [ 'Requirements', _exp('Collect'), { command => 'requires' } ], | ||
| 150 | [ 'Variables', _exp('Collect'), { command => 'var' } ], | ||
| 151 | [ 'Functions', _exp('Collect'), { command => 'func' } ], | ||
| 152 | [ 'Class Attributes', _exp('Collect'), { command => 'c_attr' } ], | ||
| 153 | [ 'Attributes', _exp('Collect'), { command => 'attr' } ], | ||
| 154 | [ 'Constructors', _exp('Collect'), { command => 'construct' } ], | ||
| 155 | [ 'Class Methods', _exp('Collect'), { command => 'c_method' } ], | ||
| 156 | [ 'Methods', _exp('Collect'), { command => 'method' } ], | ||
| 157 | ) { | ||
| 158 | 8 | $plugin->[2]{header} = uc $plugin->[0]; | |
| 159 | 8 | push @plugins, $plugin; | |
| 160 | } | ||
| 161 | |||
| 162 | 1 | push @plugins, ( | |
| 163 | [ '@HAYOBAAN/Leftovers', _exp('Leftovers'), {} ], | ||
| 164 | |||
| 165 | [ '@HAYOBAAN/postlude', _exp('Region'), { region_name => 'postlude' } ], | ||
| 166 | |||
| 167 | [ '@HAYOBAAN/Bugs', _exp('Author::HAYOBAAN::Bugs'), {} ], | ||
| 168 | |||
| 169 | [ '@HAYOBAAN/Stability', _exp('Generic'), { header => 'STABILITY' } ], | ||
| 170 | [ '@HAYOBAAN/Compatibility', _exp('Generic'), { header => 'COMPATIBILITY' } ], | ||
| 171 | |||
| 172 | [ '@HAYOBAAN/SeeAlso', _exp('Generic'), { header => 'SEE ALSO' } ], | ||
| 173 | [ '@HAYOBAAN/Credits', _exp('Generic'), { header => 'CREDITS' } ], | ||
| 174 | |||
| 175 | [ '@HAYOBAAN/Authors', _exp('Authors'), {} ], | ||
| 176 | [ '@HAYOBAAN/Legal', _exp('Legal'), {} ], | ||
| 177 | ); | ||
| 178 | |||
| 179 | 1 | return @plugins; | |
| 180 | } | ||
| 181 | |||
| 182 | 3 | 1; | |
| 183 | |||
| 184 | __END__ | ||