NAME
    App::CPANChangesCwaliteeUtils - CLI Utilities related to CPAN Changes
    cwalitee

VERSION
    This document describes version 0.004 of App::CPANChangesCwaliteeUtils
    (from Perl distribution App-CPANChangesCwaliteeUtils), released on
    2019-07-26.

DESCRIPTION
    This distribution includes the following utilities:

    *   calc-cpan-changes-cwalitee

    *   list-cpan-changes-cwalitee-indicators

FUNCTIONS
  calc_cpan_changes_cwalitee
    Usage:

     calc_cpan_changes_cwalitee(%args) -> [status, msg, payload, meta]

    Calculate CPAN Changes cwalitee.

    Examples:

    *   Run against the the Changes of App-CPANChangesCwaliteeUtils
        distribution:

         calc_cpan_changes_cwalitee();

        Result:

         [
           {
             indicator => "not_too_wide",
             num => 1,
             result => 1,
             result_summary => "",
             severity => 3,
           },
           {
             indicator => "parsable",
             num => 2,
             result => 1,
             result_summary => "",
             severity => 3,
           },
           {
             indicator => "date_correct_format",
             num => 3,
             result => 1,
             result_summary => "",
             severity => 3,
           },
           {
             indicator => "date_parsable",
             num => 4,
             result => 1,
             result_summary => "",
             severity => 3,
           },
           {
             indicator => "english",
             num => 5,
             result => 1,
             result_summary => "",
             severity => 3,
           },
           {
             indicator => "has_releases",
             num => 6,
             result => 1,
             result_summary => "",
             severity => 3,
           },
           {
             indicator => "no_duplicate_version",
             num => 7,
             result => 1,
             result_summary => "",
             severity => 3,
           },
           {
             indicator => "no_empty_group",
             num => 8,
             result => 1,
             result_summary => "",
             severity => 3,
           },
           {
             indicator => "no_shouting",
             num => 9,
             result => 1,
             result_summary => "",
             severity => 3,
           },
           {
             indicator => "no_useless_text",
             num => 10,
             result => 1,
             result_summary => "",
             severity => 3,
           },
           {
             indicator => "preamble_has_no_releases",
             num => 11,
             result => 1,
             result_summary => "",
             severity => 3,
           },
           {
             indicator => "release_dates_not_future",
             num => 12,
             result => 1,
             result_summary => "",
             severity => 3,
           },
           {
             indicator => "releases_in_descending_date_order",
             num => 13,
             result => 1,
             result_summary => "",
             severity => 3,
           },
           {
             indicator => "Score",
             result => "100.00",
             result_summary => "13 out of 13",
           },
         ]

    This function is not exported.

    Arguments ('*' denotes required arguments):

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

    *   min_indicator_severity => *uint* (default: 1)

        Minimum indicator severity.

    *   path => *pathname*

    Returns an enveloped result (an array).

    First element (status) is an integer containing HTTP status code (200
    means OK, 4xx caller error, 5xx function error). Second element (msg) is
    a string containing error message, or 'OK' if status is 200. Third
    element (payload) is optional, the actual result. Fourth element (meta)
    is called result metadata and is optional, a hash that contains extra
    information.

    Return value: (any)

HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/App-CPANChangesCwaliteeUtils>.

SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-App-CPANChangesCwaliteeUtils>.

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

    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.

SEE ALSO
    CPAN::Changes::Cwalitee

AUTHOR
    perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE
    This software is copyright (c) 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.

