The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

#!perl
# Note: This script is a CLI for Riap function /Module/Abstract/Cwalitee/list_module_abstract_cwalitee_indicators
# and generated automatically using Perinci::CmdLine::Gen version 0.498
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2021-05-25'; # DATE
our $DIST = 'App-ModuleAbstractCwaliteeUtils'; # DIST
our $VERSION = '0.004'; # VERSION
use 5.010001;
use strict;
my $cmdline = Perinci::CmdLine::Any->new(
url => "/Module/Abstract/Cwalitee/list_module_abstract_cwalitee_indicators",
program_name => "list-module-abstract-cwalitee-indicators",
read_config => 0,
read_env => 0,
);
$cmdline->run;
# ABSTRACT: list-module-abstract-cwalitee-indicators
# PODNAME: list-module-abstract-cwalitee-indicators
__END__
=pod
=encoding UTF-8
=head1 NAME
list-module-abstract-cwalitee-indicators - list-module-abstract-cwalitee-indicators
=head1 VERSION
This document describes version 0.004 of list-module-abstract-cwalitee-indicators (from Perl distribution App-ModuleAbstractCwaliteeUtils), released on 2021-05-25.
=head1 SYNOPSIS
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 | |
+----------------------------------+---------------+----------+----------+--------+---------+
=head1 OPTIONS
C<*> marks required options.
=head2 Main options
=over
=item B<--detail>, B<-l>
=back
=head2 Filtering options
=over
=item B<--exclude-json>=I<s>, B<-X>
Exclude by name (JSON-encoded).
See C<--exclude>.
=item B<--exclude-module-json>=I<s>
Exclude by module (JSON-encoded).
See C<--exclude-module>.
=item B<--exclude-module>=I<s@>
Exclude by module.
Can be specified multiple times.
=item B<--exclude-status-json>=I<s>
Exclude by status (JSON-encoded).
See C<--exclude-status>.
=item B<--exclude-status>=I<s@>
Exclude by status.
Can be specified multiple times.
=item B<--exclude>=I<s@>
Exclude by name.
Can be specified multiple times.
=item B<--include-json>=I<s>, B<-I>
Include by name (JSON-encoded).
See C<--include>.
=item B<--include-module-json>=I<s>
Include by module (JSON-encoded).
See C<--include-module>.
=item B<--include-module>=I<s@>
Include by module.
Can be specified multiple times.
=item B<--include-status-json>=I<s>
Include by status (JSON-encoded).
See C<--include-status>.
=item B<--include-status>=I<s@>
Include by status.
Default value:
["stable"]
Can be specified multiple times.
=item B<--include>=I<s@>
Include by name.
Can be specified multiple times.
=item B<--max-severity>=I<s>
Maximum severity.
Default value:
5
=item B<--min-severity>=I<s>
Minimum severity.
Default value:
1
=back
=head2 Output options
=over
=item B<--format>=I<s>
Choose output format, e.g. json, text.
Default value:
undef
=item B<--json>
Set output format to json.
=item B<--naked-res>
When outputing as JSON, strip result envelope.
Default value:
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]
=item B<--page-result>
Filter output through a pager.
=item B<--view-result>
View output using a viewer.
=back
=head2 Other options
=over
=item B<--help>, B<-h>, B<-?>
Display help message and exit.
=item B<--version>, B<-v>
Display program's version and exit.
=back
=head1 COMPLETION
This script has shell tab completion capability with support for several
shells.
=head2 bash
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. F<~/.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 L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.
=head2 tcsh
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. F<~/.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 L<shcompgen> (see above).
=head2 other shells
For fish and zsh, install L<shcompgen> as described above.
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/App-ModuleAbstractCwaliteeUtils>.
=head1 SOURCE
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<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.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 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.
=cut