NAME
list-cpan-changes-cwalitee-indicators - list-cpan-changes-cwalitee-indicators
VERSION
This document describes version 0.007 of list-cpan-changes-cwalitee-indicators (from Perl distribution App-CPANChangesCwaliteeUtils), released on 2021-05-26.
SYNOPSIS
Usage:
% list-cpan-changes-cwalitee-indicators [-I=s+] [-X=s+] [--detail]
[--exclude-json=s] [--exclude-module-json=s] [--exclude-module=s+]
[--exclude-status-json=s] [--exclude-status=s+] [--exclude=s+]
[--format=name] [--include-json=s] [--include-module-json=s]
[--include-module=s+] [--include-status-json=s] [--include-status=s+]
[--include=s+] [--json] [-l] [--max-severity=s] [--min-severity=s]
[--(no)naked-res] [--no-detail] [--nodetail] [--page-result[=program]]
[--view-result[=program]]Examples:
List all installed indicators from all modules:
% list-cpan-changes-cwalitee-indicators
date_correct_format
date_parsable
english
has_releases
no_duplicate_version
no_empty_group
no_shouting
no_useless_text
not_too_wide
parsable
preamble_has_no_releases
release_dates_not_future
releases_in_descending_date_orderList only certain names, show details:
% list-cpan-changes-cwalitee-indicators --detail --include parsable --include date_parsable --include date_correct_format
+-------------------------------+---------------------+----------+----------+--------+----------------------------------------------------------------------+
| module | name | priority | severity | status | summary |
+-------------------------------+---------------------+----------+----------+--------+----------------------------------------------------------------------+
| CPAN::Changes::Cwalitee::Core | date_correct_format | 50 | 3 | stable | Dates are specified in the correct specified format, e.g. YYYY-MM-DD |
| CPAN::Changes::Cwalitee::Core | date_parsable | 50 | 3 | stable | Dates are parsable by CPAN::Changes |
| CPAN::Changes::Cwalitee::Core | parsable | 10 | 3 | stable | Parseable by CPAN::Changes |
+-------------------------------+---------------------+----------+----------+--------+----------------------------------------------------------------------+OPTIONS
* marks required options.
Main options
Filtering options
- --exclude-json=s, -X
-
Exclude by name (JSON-encoded).
See
--exclude. - --exclude-module-json=s
-
Exclude by module (JSON-encoded).
See
--exclude-module. - --exclude-module=s@
-
Exclude by module.
Can be specified multiple times.
- --exclude-status-json=s
-
Exclude by status (JSON-encoded).
See
--exclude-status. - --exclude-status=s@
-
Exclude by status.
Can be specified multiple times.
- --exclude=s@
-
Exclude by name.
Can be specified multiple times.
- --include-json=s, -I
-
Include by name (JSON-encoded).
See
--include. - --include-module-json=s
-
Include by module (JSON-encoded).
See
--include-module. - --include-module=s@
-
Include by module.
Can be specified multiple times.
- --include-status-json=s
-
Include by status (JSON-encoded).
See
--include-status. - --include-status=s@
-
Include by status.
Default value:
["stable"]Can be specified multiple times.
- --include=s@
-
Include by name.
Can be specified multiple times.
- --max-severity=s
-
Maximum severity.
Default value:
5 - --min-severity=s
-
Minimum severity.
Default value:
1
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.
- --view-result
-
View output using a viewer.
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 list-cpan-changes-cwalitee-indicators list-cpan-changes-cwalitee-indicatorsin 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 list-cpan-changes-cwalitee-indicators 'p/*/`list-cpan-changes-cwalitee-indicators`/'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.
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-CPANChangesCwaliteeUtils.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-CPANChangesCwaliteeUtils.
BUGS
Please report any bugs or feature requests on the bugtracker website https://github.com/perlancar/perl-App-CPANChangesCwaliteeUtils/issues
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.
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2021, 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.