NAME

App::lcpan::Cmd::cwalitee_of_module_abstract - Calculate the cwalitee of a module's Abstract

VERSION

This document describes version 0.004 of App::lcpan::Cmd::cwalitee_of_module_abstract (from Perl distribution App-lcpan-CmdBundle-cwalitee), released on 2021-06-06.

DESCRIPTION

This module handles the lcpan subcommand cwalitee-of-module-abstract.

FUNCTIONS

handle_cmd

Usage:

handle_cmd(%args) -> [$status_code, $reason, $payload, \%result_meta]

Calculate the cwalitee of a module's Abstract.

This function is not exported.

Arguments ('*' denotes required arguments):

• cpan => dirname

  Location of your local CPAN mirror, e.g. /path/to/cpan.

  Defaults to ~/cpan.

• exclude_indicator => array[str]

  Do not use these indicators.

• exclude_indicator_module => array[perl::modname]

  Do not use indicators from these modules.

• exclude_indicator_status => array[str]

  Do not use indicators having these statuses.

• include_indicator => array[str]

  Only use these indicators.

• include_indicator_module => array[perl::modname]

  Only use indicators from these modules.

• include_indicator_status => array[str] (default: ["stable"])

  Only use indicators having these statuses.

• index_name => filename (default: "index.db")

  Filename of index.

  If index_name is a filename without any path, e.g. index.db then index will be located in the top-level of cpan. If index_name contains a path, e.g. ./index.db or /home/ujang/lcpan.db then the index will be located solely using the index_name.

• min_indicator_severity => uint (default: 1)

  Minimum indicator severity.

• module* => perl::modname

• use_bootstrap => bool (default: 1)

  Whether to use bootstrap database from App-lcpan-Bootstrap.

  If you are indexing your private CPAN-like repository, you want to turn this off.

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-lcpan-CmdBundle-cwalitee.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-lcpan-CmdBundle-cwalitee.

BUGS

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

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