CPAN::Meta::X - List of custom (x_*) keys in CPAN distribution metadata being used in the wild
This document describes version 0.002 of CPAN::Meta::X (from Perl distribution CPAN-Meta-X), released on 2020-10-29.
The CPAN distribution metadata specification allows custom keys (those that begin with x_ or X_ to be added to the metadata. Over time, some keys are being used for their specific purposes. This document tries to list them.
x_
X_
This document also lists custom phases and relationships in the prereqs hash that are being used, custom keys in resources hash.
A big structure recording information related to Dist::Zilla which presumably is used to build the current distribution. Some of the things being put in here include: perl version used to build the distribution, Dist::Zilla plugins used to build the distribution, and so on.
List of contributors in a release.
Examples:
References:
DAGOLDEN, https://perlmaven.com/how-to-add-list-of-contributors-to-the-cpan-meta-files
SZABGAB, https://github.com/book/CPANio/issues/7
List prerequisites for example scripts.
KENTNL, https://perlancar.wordpress.com/2016/12/28/x_-prereqs/
List what scripts are being provided in the distribution. The structure is modeled after the standard provides hash.
So say your distribution provides a "csv2json" script, your META.json would contain:
"x_provides_scripts": { "csv2json": { "version": "0.1", "file": "bin/csv2json" } }
TOBYINK, https://perlmonks.org/?node_id=11123240
Express that the current distribution is benchmarking the specified module.
PERLANCAR, https://perlancar.wordpress.com/2016/12/28/x_-prereqs/
Express that the current distribution is mentioning the specified module.
Express that the current distribution is following a specification defined in the specified module.
See "x_benchmarks phase".
See "x_mentions phase".
See "x_spec phase".
Please visit the project's homepage at https://metacpan.org/release/CPAN-Meta-X.
Source repository is at https://github.com/perlancar/perl-CPAN-Meta-X.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=CPAN-Meta-X
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
CPAN::Meta::Spec - Specification for CPAN distribution metadata
perlancar <perlancar@cpan.org>
This software is copyright (c) 2020 by perlancar@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.
To install CPAN::Meta::X, copy and paste the appropriate command in to your terminal.
cpanm
cpanm CPAN::Meta::X
CPAN shell
perl -MCPAN -e shell install CPAN::Meta::X
For more information on module installation, please visit the detailed CPAN module installation guide.