list-module-abstract-cwalitee-indicators - list-module-abstract-cwalitee-indicators
This document describes version 0.004 of list-module-abstract-cwalitee-indicators (from Perl distribution App-ModuleAbstractCwaliteeUtils), released on 2021-05-25.
Usage:
% list-module-abstract-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-module-abstract-cwalitee-indicators language_english no_shouting not_empty not_end_with_dot not_module_name not_multiline not_redundant not_start_with_lowercase_letter not_template not_too_long not_too_short
List only certain names, show details:
% list-module-abstract-cwalitee-indicators --detail --include not_too_short --include not_too_long --include not_template +----------------------------------+---------------+----------+----------+--------+---------+ | module | name | priority | severity | status | summary | +----------------------------------+---------------+----------+----------+--------+---------+ | Module::Abstract::Cwalitee::Core | not_template | 50 | 3 | stable | | | Module::Abstract::Cwalitee::Core | not_too_long | 50 | 3 | stable | | | Module::Abstract::Cwalitee::Core | not_too_short | 50 | 3 | stable | | +----------------------------------+---------------+----------+----------+--------+---------+
* marks required options.
*
Exclude by name (JSON-encoded).
See --exclude.
--exclude
Exclude by module (JSON-encoded).
See --exclude-module.
--exclude-module
Exclude by module.
Can be specified multiple times.
Exclude by status (JSON-encoded).
See --exclude-status.
--exclude-status
Exclude by status.
Exclude by name.
Include by name (JSON-encoded).
See --include.
--include
Include by module (JSON-encoded).
See --include-module.
--include-module
Include by module.
Include by status (JSON-encoded).
See --include-status.
--include-status
Include by status.
Default value:
["stable"]
Include by name.
Maximum severity.
5
Minimum 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]
Filter output through a pager.
View output using a viewer.
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 list-module-abstract-cwalitee-indicators list-module-abstract-cwalitee-indicators
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 list-module-abstract-cwalitee-indicators 'p/*/`list-module-abstract-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).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/App-ModuleAbstractCwaliteeUtils.
Source repository is at https://github.com/perlancar/perl-App-ModuleAbstractCwaliteeUtils.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-ModuleAbstractCwaliteeUtils
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) 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.
To install App::ModuleAbstractCwaliteeUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::ModuleAbstractCwaliteeUtils
CPAN shell
perl -MCPAN -e shell install App::ModuleAbstractCwaliteeUtils
For more information on module installation, please visit the detailed CPAN module installation guide.