/ 
Sort-SubBundle-PERLANCAR-0.093
River stage one • 4 direct dependents • 9 total dependents
/ Sort::Sub::changes_group_ala_perlancar

NAME

Sort::Sub::changes_group_ala_perlancar - Sort changes group heading PERLANCAR-style

VERSION

This document describes version 0.093 of Sort::Sub::changes_group_ala_perlancar (from Perl distribution Sort-SubBundle-PERLANCAR), released on 2024-01-08.

SYNOPSIS

Generate sorter (accessed as variable) via Sort::Sub import:

use Sort::Sub '$changes_group_ala_perlancar'; # use '$changes_group_ala_perlancar<i>' for case-insensitive sorting, '$changes_group_ala_perlancar<r>' for reverse sorting
my @sorted = sort $changes_group_ala_perlancar ('item', ...);

Generate sorter (accessed as subroutine):

use Sort::Sub 'changes_group_ala_perlancar<ir>';
my @sorted = sort {changes_group_ala_perlancar} ('item', ...);

Generate directly without Sort::Sub:

use Sort::Sub::changes_group_ala_perlancar;
my $sorter = Sort::Sub::changes_group_ala_perlancar::gen_sorter(
    ci => 1,      # default 0, set 1 to sort case-insensitively
    reverse => 1, # default 0, set 1 to sort in reverse order
);
my @sorted = sort $sorter ('item', ...);

Use in shell/CLI with sortsub (from App::sortsub):

% some-cmd | sortsub changes_group_ala_perlancar
% some-cmd | sortsub changes_group_ala_perlancar --ignore-case -r

DESCRIPTION

A Changes file can group its changes entries into groups with headings, e.g.:

[ENHANCEMENTS]

- blah blah

- blah

[BUG FIXES]

- blah blah blah

I sort these group headings according to this principle: prioritize the items that:

  • are more important;

  • affect users the most;

  • users would want to know first.

Thus breaking or backward-incompatible changes are put first because they affect existing users and in a significant way. Removed features are next, they are also basically backward-incompatible changes.

Then come new features. After that, enhancements. Bug fixes currently come last (actually bug fixes vary in importance but we currently do not categorize them further into subgroups).

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Sort-SubBundle-PERLANCAR.

SOURCE

Source repository is at https://github.com/perlancar/perl-Sort-SubBundle-PERLANCAR.

SEE ALSO

Sort::Sub

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2024, 2021 by perlancar <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.

BUGS

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

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.