1Module::Starter::BuildeUrsSeert(C3o)ntributed Perl DocumMeondtualtei:o:nStarter::BuilderSet(3)
2
3
4

NAME

6       Module::Starter::BuilderSet - determine builder metadata
7

VERSION

9       version 1.77
10

SYNOPSIS

12           use Module::Starter::BuilderSet;
13
14           my $builder_set = Module::Starter::BuilderSet->new;
15           my @supported_builders = $builder_set->supported_builders();
16           my $default_builder = $builder_set->default_builder();
17           my $output_file = $builder_set->file_for_builder($default_builder);
18
19           my $create_method = $builder_set->method_for_builder($default_builder);
20           Module::Starter::Simple->$create_method($default_builder); # eeew.
21
22           my @build_commands = $builder_set->instructions_for_builder($default_builder);
23           my @builder_dependencies = $builder_set->deps_for_builder($default_builder);
24           my @compatible_builders = $builder_set->check_compatibility(@builder_list);
25
26           my $ms_simple    = Module::Starter::Simple->new();
27           my $build_method = $builder_set->manifest_method($builder);
28           $ms_simple->$build_method();
29

DESCRIPTION

31       Module::Starter::BuilderSet is a collection of utility methods used to
32       provide metadata about builders supported by Module::Starter.
33

CLASS METHODS

35   new()
36       This method initializes and returns an object representing the set of
37       Builders supported by Module::Starter
38
39   supported_builders()
40       This method returns a list of builders supported by Module::Starter
41
42   file_for_builder($builder)
43       This method returns the name of the file generated by Module::Starter
44       that will be used to build the generated module
45
46   method_for_builder($builder)
47       This method returns the name of the method in the
48       "Module::Starter::Simple" package that is called to create the file
49       returned by file_for_builder($builder)
50
51   instructions_for_builder($builder)
52       This method returns a list of commands that, when run from the command
53       line (or with system()), will cause the generated module to be built,
54       tested and installed.
55
56   deps_for_builder($builder)
57       This method returns a list of dependencies in the following format: "(
58       { command => "make",
59           aliases => [ 'make', 'gmake' ],
60          },
61         { command => "another_command",
62           aliases => [ 'alias0', 'alias1', '...' ],
63          }, )"
64
65   manifest_method($builder)
66       This method returns the command to run to create the manifest according
67       to the builder asked.
68
69   check_compatibility(@builders)
70       This method accepts a list of builders and filters out the ones that
71       are unsupported or mutually exclusive, returning the builders that
72       passed the filter.  If none pass the filter, the default builder is
73       returned.
74
75   default_builder()
76       This method returns the module name of the default builder.
77

BUGS

79       Please report any bugs or feature requests to the bugtracker for this
80       project on GitHub at:
81       <https://github.com/xsawyerx/module-starter/issues>. I will be
82       notified, and then you'll automatically be notified of progress on your
83       bug as I make changes.
84

AUTHOR

86       C.J. Adams-Collier, "<cjac@colliertech.org>"
87

89       Copyright 2007 C.J. Adams-Collier, All Rights Reserved.
90
91       This program is free software; you can redistribute it and/or modify it
92       under the same terms as Perl itself.
93
94       Please note that these modules are not products of or supported by the
95       employers of the various contributors to the code.
96
97
98
99perl v5.38.0                      2023-07-20    Module::Starter::BuilderSet(3)
Impressum