view release on metacpan or  search on metacpan

lib/Acme/CPANModules/WrappingText.pm  view on Meta::CPAN

package Acme::CPANModules::WrappingText;

use strict;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2022-11-24'; # DATE
our $DIST = 'Acme-CPANModules-WrappingText'; # DIST
our $VERSION = '0.001'; # VERSION

our $LIST = {
    summary => "List of modules and utilities to wrap text",
    description => <<'_',

See also: <prog:fold> Unix command line.

_
    # TODO: use Module::Features
    entry_features => {
        can_unicode => {summary => 'Can wrap Unicode text, including wide characters'},
        can_cjk     => {summary => 'Can wrap CJK wide characters'},
        can_ansi    => {summary => 'Can wrap text that contains ANSI color/escape codes'},
    },
    entries => [
        {
            module => 'App::TextWrapUtils',
            script => 'textwrap',
            description => <<'_',

CLI front-end for various backends mentioned in this list.

_
        },
        {
            module => 'Lingua::JA::Fold',
            function => 'fold',
            description => <<'_',

Specifically for folding Japanese (and other CJK) text.

_
            features => {
                can_unicode => 0,
                can_cjk => 1,
                can_ansi => 0,
            },
        },
        {
            module => 'Text::ANSI::Fold',
            function => 'ansi_fold',
            description => <<'_',

_
            features => {
                can_unicode => 1,
                can_cjk => 1,
                can_ansi => 1,
            },
        },
        {
            module => 'Text::ANSI::Util',
            function => 'ta_wrap',
            description => <<'_',

For wrapping text that contains ANSI escape/color codes.

_
            features => {
                can_unicode => 0,
                can_cjk => 0,
                can_ansi => 1,
            },
        },
        {
            module => 'Text::ANSI::WideUtil',
            function => 'ta_mbwrap',
            description => <<'_',

For wrapping text that contains ANSI escape/color codes *and* Unicode wide
characters.

_
            features => {
                can_unicode => 1,
                can_cjk => 0,
                can_ansi => 1,
            },
        },
        {
            module => 'Text::WideChar::Util',
            function => 'mbwrap',
            description => <<'_',

For wrapping text that contains Unicode wide characters.

_
            features => {
                can_unicode => 1,
                can_cjk => 0,
                can_ansi => 0,
            },
        },
        {
            module => 'Text::Fold',
            function => 'fold_text',
            description => <<'_',

_
            features => {
                can_unicode => 1,
                can_cjk => 0,
                can_ansi => 0,
            },
        },
        {
            module => 'Text::LineFold',
            method => 'fold',
            description => <<'_',

_
            features => {
                can_unicode => 0,
                can_cjk => 0,
                can_ansi => 0,
            },
        },
        {
            module => 'Text::Wrap',
            description => <<'_',

Core module.

_
            features => {
                can_unicode => 0,
                can_cjk => 0,
                can_ansi => 0,
            },
        },
    ],
};

1;
# ABSTRACT: List of modules and utilities to wrap text

__END__

=pod

=encoding UTF-8

=head1 NAME

Acme::CPANModules::WrappingText - List of modules and utilities to wrap text

=head1 VERSION

This document describes version 0.001 of Acme::CPANModules::WrappingText (from Perl distribution Acme-CPANModules-WrappingText), released on 2022-11-24.

=head1 DESCRIPTION

See also: L<fold> Unix command line.

=head1 ACME::CPANMODULES ENTRIES

=over

=item L<App::TextWrapUtils>

CLI front-end for various backends mentioned in this list.


Script: L<textwrap>

=item L<Lingua::JA::Fold>

Author: L<HATA|https://metacpan.org/author/HATA>

Specifically for folding Japanese (and other CJK) text.


=item L<Text::ANSI::Fold>

Author: L<UTASHIRO|https://metacpan.org/author/UTASHIRO>

=item L<Text::ANSI::Util>

Author: L<PERLANCAR|https://metacpan.org/author/PERLANCAR>

For wrapping text that contains ANSI escape/color codes.


=item L<Text::ANSI::WideUtil>