NAME
My::Module::Meta - Metadata for the current module
SYNOPSIS
use lib qw{ inc };
use My::Module::Meta qw{ recommended_module_versions };DESCRIPTION
This Perl module holds metadata for the current module. It is private to the current module.
METHODS
This class supports the following public methods:
new
my $meta = My::Module::Meta->new();This method instantiates the class.
build_requires
use YAML;
print Dump( $meta->build_requires() );This method computes and returns a reference to a hash describing the modules required to build the App::Retab package, suitable for use in a Build.PL build_requires key, or a Makefile.PL {META_MERGE}->{build_requires} or BUILD_REQUIRES key.
meta_merge
use YAML;
print Dump( $meta->meta_merge() );This method returns a reference to a hash describing the meta-data which has to be provided by making use of the builder's meta_merge functionality. This includes the dynamic_config, no_index and resources data.
recommended_module_versions
This subroutine returns an array of the names and versions of recommended modules.
requires
use YAML;
print Dump( $meta->requires() );This method computes and returns a reference to a hash describing the modules required to run the App::Retab package, suitable for use in a Build.PL requires key, or a Makefile.PL PREREQ_PM key. Any additional arguments will be appended to the generated hash. In addition, unless distribution() is true, configuration-specific modules may be added.
requires_perl
This subroutine returns the version of Perl required by the module.
SUPPORT
Support is by the author. Please file bug reports at https://rt.cpan.org/Public/Dist/Display.html?Name=Perl-Critic-Policy-Variables-ProhibitNumericNamesWithLeadingZero, https://github.com/trwyant/perl-Perl-Critic-Policy-Variables-ProhibitNumericNamesWithLeadingZero/issues, or in electronic mail to the author.
AUTHOR
Thomas R. Wyant, III wyant at cpan dot org
COPYRIGHT AND LICENSE
Copyright (C) 2013-2022 by Thomas R. Wyant, III
This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5.10.0. For more details, see the full text of the licenses in the directory LICENSES.
This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.
abstract
This method returns the distribution's abstract.
add_to_cleanup
This method returns a reference to an array of files to be added to the cleanup.
author
This method returns the name of the distribution author
configure_requires
use YAML;
print Dump( $meta->configure_requires() );This method returns a reference to a hash describing the modules required to configure the package, suitable for use in a Build.PL configure_requires key, or a Makefile.PL {META_MERGE}->{configure_requires} or CONFIGURE_REQUIRES key.
dist_name
This method returns the distribution name.
license
This method returns the distribution's license.
meta_merge
use YAML;
print Dump( $meta->meta_merge() );This method returns a reference to a hash describing the meta-data which has to be provided by making use of the builder's meta_merge functionality. This includes the dynamic_config and resources data.
Any arguments will be appended to the generated array.
module_name
This method returns the name of the module the distribution is based on.
no_index
This method returns the names of things which are not to be indexed by CPAN.
provides
use YAML;
print Dump( [ $meta->provides() ] );This method attempts to load Module::Metadata. If this succeeds, it returns a provides entry suitable for inclusion in meta_merge() data (i.e. 'provides' followed by a hash reference). If it can not load the required module, it returns nothing.
script_files
This method returns a reference to an array containing the names of script files provided by this distribution. This array may be empty.
version_from
This method returns the name of the distribution file from which the distribution's version is to be derived.