calc-cpan-changes-cwalitee - Calculate CPAN Changes cwalitee
This document describes version 0.005 of calc-cpan-changes-cwalitee (from Perl distribution App-CPANChangesCwaliteeUtils), released on 2019-08-02.
Usage:
% calc-cpan-changes-cwalitee [options] [path]
Examples:
Run against the the Changes of App-CPANChangesCwaliteeUtils distribution:
% calc-cpan-changes-cwalitee +-----------------------------------+-----+--------+----------------+----------+ | indicator | num | result | result_summary | severity | +-----------------------------------+-----+--------+----------------+----------+ | not_too_wide | 1 | 1 | | 3 | | parsable | 2 | 1 | | 3 | | date_correct_format | 3 | 1 | | 3 | | date_parsable | 4 | 1 | | 3 | | english | 5 | 1 | | 3 | | has_releases | 6 | 1 | | 3 | | no_duplicate_version | 7 | 1 | | 3 | | no_empty_group | 8 | 1 | | 3 | | no_shouting | 9 | 1 | | 3 | | no_useless_text | 10 | 1 | | 3 | | preamble_has_no_releases | 11 | 1 | | 3 | | release_dates_not_future | 12 | 1 | | 3 | | releases_in_descending_date_order | 13 | 1 | | 3 | | Score | | 100.00 | 13 out of 13 | | +-----------------------------------+-----+--------+----------------+----------+
* marks required options.
*
Do not use these indicators (JSON-encoded).
See --exclude-indicator.
--exclude-indicator
Do not use indicators from these modules (JSON-encoded).
See --exclude-indicator-module.
--exclude-indicator-module
Do not use indicators from these modules.
Can be specified multiple times.
Do not use indicators having these statuses (JSON-encoded).
See --exclude-indicator-status.
--exclude-indicator-status
Do not use indicators having these statuses.
Do not use these indicators.
Only use these indicators (JSON-encoded).
See --include-indicator.
--include-indicator
Only use indicators from these modules (JSON-encoded).
See --include-indicator-module.
--include-indicator-module
Only use indicators from these modules.
Only use indicators having these statuses (JSON-encoded).
See --include-indicator-status.
--include-indicator-status
Only use indicators having these statuses.
Default value:
["stable"]
Only use these indicators.
Minimum indicator severity.
1
Choose output format, e.g. json, text.
undef
Set output format to json.
When outputing as JSON, strip result envelope.
0
By 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]
Display help message and exit.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C calc-cpan-changes-cwalitee calc-cpan-changes-cwalitee
in 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.
To activate tcsh completion for this script, put:
complete calc-cpan-changes-cwalitee 'p/*/`calc-cpan-changes-cwalitee`/'
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).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/App-CPANChangesCwaliteeUtils.
Source repository is at https://github.com/perlancar/perl-App-CPANChangesCwaliteeUtils.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-CPANChangesCwaliteeUtils
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2019 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 App::CPANChangesCwaliteeUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::CPANChangesCwaliteeUtils
CPAN shell
perl -MCPAN -e shell install App::CPANChangesCwaliteeUtils
For more information on module installation, please visit the detailed CPAN module installation guide.