-
-
02 Mar 2017 03:21:11 UTC
- Distribution: Dist-Zilla-Plugin-MetaData-BuiltWith
- Module version: 1.004005
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues (0)
- Testers (1284 / 1 / 0)
- Kwalitee
Bus factor: 1- 79.65% Coverage
- License: perl_5
- Perl: v5.6.0
- Activity
24 month- Tools
- Download (37.33KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
- Dependencies
- CPAN::Meta::Converter
- Carp
- Devel::CheckBin
- Dist::Zilla::File::FromCode
- Dist::Zilla::Role::ConfigDumper
- Dist::Zilla::Role::FileGatherer
- Dist::Zilla::Role::FileMunger
- Dist::Zilla::Role::MetaProvider
- JSON::MaybeXS
- Module::Metadata
- Module::Runtime
- Moose
- MooseX::Types::Moose
- Path::Tiny
- YAML::Tiny
- namespace::autoclean
- strict
- warnings
- Reverse dependencies
- CPAN Testers List
- Dependency graph
- NAME
- VERSION
- SYNOPSIS
- DESCRIPTION
- OPTIONS
- METHODS
- EXAMPLE OUTPUT ( META.json )
- AUTHOR
- COPYRIGHT AND LICENSE
NAME
Dist::Zilla::Plugin::MetaData::BuiltWith - Report what versions of things your distribution was built against
VERSION
version 1.004005
SYNOPSIS
[MetaData::BuiltWith] include = Some::Module::Thats::Not::In::Preq exclude = Some::Module::Youre::Ashamed::Of show_uname = 1 ; default is 0 show_config = 1 ; default is 0 uname_call = uname ; the default uname_args = -s -r -m -p ; the default is -a use_external_file = only ; the default is undef
DESCRIPTION
This module provides extra metadata in your distribution, automatically documenting what versions of dependencies the author was using at the time of release.
This allows consumers of said distributions to be able to see a range of versions that are "known good" should they experience problems.
OPTIONS
exclude
Specify modules to exclude from version reporting
exclude = Foo exclude = Bar
include
Specify additional modules to include the version of
include = Foo include = Bar
show_config
Report "interesting" values from
%Config::Config
show_config = 1 ; Boolean
show_uname
Report the output from
uname
show_uname = 1 ; Boolean
uname_call
Specify what the system
uname
function is calleduname_call = uname ; String
uname_args
Specify arguments passed to the
uname
call.uname_args = -a ; String
use_external_file
This option regulates the optional output to an isolated file.
An external file will be created as long as this value is a true value.
use_external_file = 1
If this true value is the string
only
, then it won't also be exported to META.yml/META.jsonuse_external_file = only
NOTE:
This will still leave an x_BuiltWith section in your META.*, however, its much less fragile and will simply be:
x_BuiltWith: { external_file: "your/path/here" }
This is mostly a compatibility pointer so any tools traversing a distributions history will know where and when to change behavior.
external_file_name
This option controls what the external file will be called in conjunction with
use_external_file
Default value is:
misc/built_with.json
Extensions:
.json => JSON is used. .yml => YAML is used (untested) .yaml => YAML is used (untested)
METHODS
mvp_multivalue_args
This module can take, as parameters, any volume of 'exclude' or 'include' arguments.
munge_files
This module scrapes together the name of all modules that exist in the "
Prereqs
" section that Dist::Zilla collects, and then works out what version of things you have, applies the various include/exclude rules, and ships that data back to Dist::Zilla via this method. SeeDist::Zilla
'sMetaProvider
role for more details.EXAMPLE OUTPUT (
META.json
)"x_BuiltWith" : { "modules" : { "Dist::Zilla::Role::MetaProvider" : "4.101612", "File::Find" : "1.15", "File::Temp" : "0.22", "Module::Build" : "0.3607", "Moose" : "1.07", "Test::More" : "0.94" }, "perl" : "5.012000", "platform" : "MSWin32" },
AUTHOR
Kent Fredric <kentnl@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2017 by Kent Fredric <kentnl@cpan.org>.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
Module Install Instructions
To install Dist::Zilla::Plugin::MetaData::BuiltWith, copy and paste the appropriate command in to your terminal.
cpanm Dist::Zilla::Plugin::MetaData::BuiltWith
perl -MCPAN -e shell install Dist::Zilla::Plugin::MetaData::BuiltWith
For more information on module installation, please visit the detailed CPAN module installation guide.