NAME
gen-cpan-meta - Generate CPAN META for a distribution
VERSION
This document describes version 0.011 of gen-cpan-meta (from Perl distribution App-CPANMetaUtils), released on 2020-08-27.
SYNOPSIS
Usage:
% gen-cpan-meta [--config-path=path | -c] [--config-profile=profile | -P]
[--format=name] [--json] [--(no)naked-res] [--no-config | -C]
[--no-env] [--page-result[=program]] [dir]DESCRIPTION
NOTE: EARLY VERSION.
This utility assumes it is run in the top-level directory of a Perl distribution and will try to generate a CPAN META structure for the distribution. For example: abstract will be searched from POD, name from the shortest package name, version from the main module, prereqs using App::ScanPrereqs and so on. Finally it will validate its generated META.json first before outputing it, printing found errors to stderr.
This utility can be used to generate (at least the preliminary version of) META.json for Perl distributions that do not yet have META.json. It is usually not useful for distributions that use a distribution builder tool like Dist::Zilla, because in that case the tool will generate META.json for you.
OPTIONS
* marks required options.
Main options
Configuration options
- --config-path=s, -c
-
Set path to configuration file.
- --config-profile=s, -P
-
Set configuration profile to use.
- --no-config, -C
-
Do not use any configuration file.
Environment options
Output options
- --format=s
-
Choose output format, e.g. json, text.
Default value:
undef - --json
-
Set output format to json.
- --naked-res
-
When outputing as JSON, strip result envelope.
Default value:
0By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:
[1,2,3] - --page-result
-
Filter output through a pager.
Other options
COMPLETION
This script has shell tab completion capability with support for several shells.
bash
To activate bash completion for this script, put:
complete -C gen-cpan-meta gen-cpan-metain your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
tcsh
To activate tcsh completion for this script, put:
complete gen-cpan-meta 'p/*/`gen-cpan-meta`/'in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
other shells
For fish and zsh, install shcompgen as described above.
CONFIGURATION FILE
This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/gen-cpan-meta.conf, ~/gen-cpan-meta.conf, or /etc/gen-cpan-meta.conf.
All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.
You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.
Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.
List of available configuration parameters:
dir (see --dir)
format (see --format)
naked_res (see --naked-res)ENVIRONMENT
GEN_CPAN_META_OPT => str
Specify additional command-line options.
FILES
~/.config/gen-cpan-meta.conf
~/gen-cpan-meta.conf
/etc/gen-cpan-meta.conf
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-CPANMetaUtils.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-CPANMetaUtils.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-CPANMetaUtils
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.
SEE ALSO
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2020, 2017, 2016 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.