view release on metacpan or  search on metacpan

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

     <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

script/list-module-abstract-cwalitee-indicators  view on Meta::CPAN

     [--(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

script/ma-cwa  view on Meta::CPAN

     <abstract>

Examples:

Example of a good Abstract:

 % ma-cwa '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:

 % ma-cwa '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