/ 
App-ModuleAbstractCwaliteeUtils-0.004
River stage one • 1 direct dependent • 1 total dependent
/ calc-module-abstract-cwalitee

NAME

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

VERSION

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

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                                   |          |
+---------------------------------+-----+--------+-----------------------------------------------+----------+

OPTIONS

* marks required options.

Main options

--abstract=s*

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

Indicator selection options

--exclude-indicator-json=s, -X

Do not use these indicators (JSON-encoded).

See --exclude-indicator.

--exclude-indicator-module-json=s

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

See --exclude-indicator-module.

--exclude-indicator-module=s@

Do not use indicators from these modules.

Can be specified multiple times.

--exclude-indicator-status-json=s

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

See --exclude-indicator-status.

--exclude-indicator-status=s@

Do not use indicators having these statuses.

Can be specified multiple times.

--exclude-indicator=s@

Do not use these indicators.

Can be specified multiple times.

--include-indicator-json=s, -I

Only use these indicators (JSON-encoded).

See --include-indicator.

--include-indicator-module-json=s

Only use indicators from these modules (JSON-encoded).

See --include-indicator-module.

--include-indicator-module=s@

Only use indicators from these modules.

Can be specified multiple times.

--include-indicator-status-json=s

Only use indicators having these statuses (JSON-encoded).

See --include-indicator-status.

--include-indicator-status=s@

Only use indicators having these statuses.

Default value:

["stable"]

Can be specified multiple times.

--include-indicator=s@

Only use these indicators.

Can be specified multiple times.

--min-indicator-severity=s

Minimum indicator 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:

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]
--page-result

Filter output through a pager.

--view-result

View output using a viewer.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C calc-module-abstract-cwalitee calc-module-abstract-cwalitee

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.

tcsh

To activate tcsh completion for this script, put:

complete calc-module-abstract-cwalitee 'p/*/`calc-module-abstract-cwalitee`/'

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-ModuleAbstractCwaliteeUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-ModuleAbstractCwaliteeUtils.

BUGS

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.

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.