NAME

calc-kwalitee - Calculate kwalitee of a local distribution

VERSION

This document describes version 0.003 of calc-kwalitee (from Perl distribution App-KwaliteeUtils), released on 2021-05-25.

SYNOPSIS

Usage:

% calc-kwalitee [--format=name] [--json] [--(no)naked-res]
    [--page-result[=program]] [--raw] [--view-result[=program]] [dist]

OPTIONS

* marks required options.

Main options

--dist=s

Distribution archive file (e.g. tarball) or directory.

Default value:

"."

Although a directory (top-level directory of an extracted Perl distribution) can be analyzed, distribution Kwalitee is supposed to be calculated on a distribution archive file (e.g. tarball) because there are metrics like `extractable`, `extracts_nicely`, `no_pax_headers` which can only be tested on a distribution archive file. Running this on a directory will result in a less-than-full score.

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

--raw

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-kwalitee calc-kwalitee

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-kwalitee 'p/*/`calc-kwalitee`/'

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

SOURCE

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

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-KwaliteeUtils

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

cpanm App::KwaliteeUtils

perl -MCPAN -e shell
install App::KwaliteeUtils