view release on metacpan or  search on metacpan

script/calc-module-abstract-cwalitee  view on Meta::CPAN

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;
use warnings;

use Perinci::CmdLine::Any;

my $cmdline = Perinci::CmdLine::Any->new(
    url => "/Module/Abstract/Cwalitee/calc_module_abstract_cwalitee",
    program_name => "calc-module-abstract-cwalitee",
    read_config => 0,
    read_env => 0,
);

$cmdline->run;

# ABSTRACT: calc-module-abstract-cwalitee
# PODNAME: calc-module-abstract-cwalitee

__END__

=pod

=encoding UTF-8

=head1 NAME

calc-module-abstract-cwalitee - calc-module-abstract-cwalitee

=head1 VERSION

This document describes version 0.004 of calc-module-abstract-cwalitee (from Perl distribution App-ModuleAbstractCwaliteeUtils), released on 2021-05-25.

=head1 SYNOPSIS

Usage:

 % calc-module-abstract-cwalitee [-I=s+] [-X=s+]
     [--exclude-indicator-json=s] [--exclude-indicator-module-json=s]
     [--exclude-indicator-module=s+] [--exclude-indicator-status-json=s]
     [--exclude-indicator-status=s+] [--exclude-indicator=s+]
     [--format=name] [--include-indicator-json=s]
     [--include-indicator-module-json=s] [--include-indicator-module=s+]
     [--include-indicator-status-json=s] [--include-indicator-status=s+]
     [--include-indicator=s+] [--json] [--min-indicator-severity=s]
     [--(no)naked-res] [--page-result[=program]] [--view-result[=program]]
     <abstract>

Examples:

Example of a good Abstract:

 % calc-module-abstract-cwalitee 'Calculate the frobnitz of thromblemeisters'
 +---------------------------------+-----+--------+----------------+----------+
 | indicator                       | num | result | result_summary | severity |
 +---------------------------------+-----+--------+----------------+----------+
 | not_empty                       | 1   | 1      |                | 3        |
 | language_english                | 2   | 1      |                | 3        |
 | no_shouting                     | 3   | 1      |                | 3        |
 | not_end_with_dot                | 4   | 1      |                | 3        |
 | not_module_name                 | 5   | 1      |                | 3        |
 | not_multiline                   | 6   | 1      |                | 3        |
 | not_redundant                   | 7   | 1      |                | 3        |
 | not_start_with_lowercase_letter | 8   | 1      |                | 3        |
 | not_template                    | 9   | 1      |                | 3        |
 | not_too_long                    | 10  | 1      |                | 3        |
 | not_too_short                   | 11  | 1      |                | 3        |
 | Score                           |     | 100.00 | 11 out of 11   |          |
 +---------------------------------+-----+--------+----------------+----------+

Example of a not-so-good Abstract:

 % calc-module-abstract-cwalitee 'PERL MODULE TO DO SOMETHING'
 +---------------------------------+-----+--------+-----------------------------------------------+----------+
 | indicator                       | num | result | result_summary                                | severity |
 +---------------------------------+-----+--------+-----------------------------------------------+----------+
 | not_empty                       | 1   | 1      |                                               | 3        |
 | language_english                | 2   | 1      |                                               | 3        |
 | no_shouting                     | 3   | 0      | All-caps                                      | 3        |
 | not_end_with_dot                | 4   | 1      |                                               | 3        |
 | not_module_name                 | 5   | 1      |                                               | 3        |
 | not_multiline                   | 6   | 1      |                                               | 3        |
 | not_redundant                   | 7   | 0      | Saying 'PERL MODULE TO' is redundant, omit it | 3        |
 | not_start_with_lowercase_letter | 8   | 1      |                                               | 3        |
 | not_template                    | 9   | 1      |                                               | 3        |
 | not_too_long                    | 10  | 1      |                                               | 3        |
 | not_too_short                   | 11  | 1      |                                               | 3        |
 | Score                           |     | 81.82  | 9 out of 11                                   |          |
 +---------------------------------+-----+--------+-----------------------------------------------+----------+

=head1 OPTIONS

C<*> marks required options.

=head2 Main options

=over

=item B<--abstract>=I<s>*

Can also be specified as the 1st command-line argument.

=back

=head2 Indicator selection options

=over

=item B<--exclude-indicator-json>=I<s>, B<-X>

Do not use these indicators (JSON-encoded).

See C<--exclude-indicator>.

=item B<--exclude-indicator-module-json>=I<s>

Do not use indicators from these modules (JSON-encoded).

See C<--exclude-indicator-module>.

=item B<--exclude-indicator-module>=I<s@>

Do not use indicators from these modules.

Can be specified multiple times.

=item B<--exclude-indicator-status-json>=I<s>

Do not use indicators having these statuses (JSON-encoded).

See C<--exclude-indicator-status>.

=item B<--exclude-indicator-status>=I<s@>

Do not use indicators having these statuses.

Can be specified multiple times.

=item B<--exclude-indicator>=I<s@>

Do not use these indicators.

Can be specified multiple times.

=item B<--include-indicator-json>=I<s>, B<-I>

Only use these indicators (JSON-encoded).