App::Midgen - Check requires & test_requires of your package for CPAN inclusion.
This document describes App::Midgen version: 0.25_06
Change to the root of your package and run
midgen
Now with a Getopt --help or -?
midgen -?
See midgen for cmd line option info.
This is an aid to show your packages module includes by scanning it's files, then display in a familiar format with the current version number from MetaCPAN.
This started as a way of generating the formatted contents for a Module::Install::DSL Makefile.PL, which has now grown to support other output formats, as well as the ability to show dual-life and perl core modules, see midgen for option info. This enables you to see which modules you have used, we even try and list Dist-Zilla Plugins.
All output goes to STDOUT, so you can use it as you see fit.
MetaCPAN Version Number Displayed
NN.nnnnnn we got the current version number from MetaCPAN.
'core' indicates the module is a perl core module.
'!mcpan' must be local, one of yours. Not in MetaCPAN, Not in core.
Food for thought, if we update our Modules, don't we want our users to use the current version, so should we not by default do the same with others Modules. Thus we always show the current version number, regardless.
We also display some other complementary information relevant to this package and your chosen output format.
For more info and sample output see wiki
degree_separation
now a separate Method, returns an integer.
find_required_modules
Search for Includes use and require in package modules
find_required_test_modules
Search for Includes use and require in test scripts, also use_ok, plus some other patterns along the way.
first_package_name
Assume first package found is your packages name
get_module_version
side affect of re-factoring, helps with code readability
mod_in_dist
Check if module is in a distribution and use that version number, rather than 'undef'
remove_noisy_children
Parent A::B has noisy Children A::B::C and A::B::D all with same version number.
remove_twins
Twins E::F::G and E::F::H have a parent E::F with same version number, so we add a parent E::F and re-test for noisy children, catching triplets along the way.
run
App::Midgen requires no configuration files or environment variables. We do honour $ENV{ANSI_COLORS_DISABLED}
App::Midgen::Roles, App::Midgen::Output
After some reflection, we do not scan xt/... as the methods by which the modules are Included are various, this is best left to the module Author.
As our mantra is to show the current version of a module, we do this by asking MetaCPAN directly so we are going to need to connect to http://api.metacpan.org/v0/.
There may be some modules on CPAN that when MetaCPAN-API asks for there version string, it is provided with the wrong information, as the contents of there Meta files are out of sync with there current version string.
Please report any bugs or feature requests to through the web interface at https://github.com/kevindawson/App-Midgen/issues. If reporting a Bug, also supply the Module info, midgen failed against.
Kevin Dawson <bowtie@cpan.org>
Ahmad M. Zawawi <ahmad.zawawi@gmail.com>
Matt S. Trout <mst@shadowcat.co.uk>
Tommy Butler <ace@tommybutler.me>
Neil Bowers <neilb@cpan.org>
Tatsuhiko Miyagawa <miyagawa@bulknews.net>
Copyright © 2013 the App:Midgen "AUTHOR" and "CONTRIBUTORS" as listed above.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5 itself.
Perl::PrereqScanner, Module::Install::DSL
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
To install App::Midgen, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::Midgen
CPAN shell
perl -MCPAN -e shell install App::Midgen
For more information on module installation, please visit the detailed CPAN module installation guide.