view release on metacpan or  search on metacpan

lib/App/CPANChangesCwaliteeUtils.pm  view on Meta::CPAN

    );
}

1;
# ABSTRACT: CLI Utilities related to CPAN Changes cwalitee

__END__

=pod

=encoding UTF-8

=head1 NAME

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

=head1 VERSION

This document describes version 0.007 of App::CPANChangesCwaliteeUtils (from Perl distribution App-CPANChangesCwaliteeUtils), released on 2021-05-26.

=head1 DESCRIPTION

This distribution includes the following utilities:

=over

=item * L<calc-cpan-changes-cwalitee>

=item * L<cc-cwa>

=item * L<list-cpan-changes-cwalitee-indicators>

=back

=head1 FUNCTIONS


=head2 calc_cpan_changes_cwalitee

Usage:

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

Calculate CPAN Changes cwalitee.

Examples:

=over

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

 calc_cpan_changes_cwalitee();

Result:

 [
   200,
   "OK",
   [
     {
       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 => 0,
       result_summary => "Release date '2021-05-27' (2021-05-27) is in the future",
       severity => 3,
     },
     {
       indicator => "releases_in_descending_date_order",
       num => 13,
       result => 1,
       result_summary => "",
       severity => 3,
     },
     { indicator => "Score", result => 92.31, result_summary => "12 out of 13" },
   ],
   {},
 ]

=back

This function is not exported.

Arguments ('*' denotes required arguments):

=over 4

=item * B<exclude_indicator> => I<array[str]>

Do not use these indicators.

=item * B<exclude_indicator_module> => I<array[perl::modname]>

Do not use indicators from these modules.

=item * B<exclude_indicator_status> => I<array[str]>

Do not use indicators having these statuses.

=item * B<include_indicator> => I<array[str]>

Only use these indicators.

=item * B<include_indicator_module> => I<array[perl::modname]>

Only use indicators from these modules.

=item * B<include_indicator_status> => I<array[str]> (default: ["stable"])

Only use indicators having these statuses.

=item * B<min_indicator_severity> => I<uint> (default: 1)

Minimum indicator severity.

=item * B<path> => I<pathname>


=back

Returns an enveloped result (an array).