NAME

Acme::CPANModules::COLOR - List of modules that follow the COLOR & NO_COLOR convention

VERSION

This document describes version 0.005 of Acme::CPANModules::COLOR (from Perl distribution Acme-CPANModules-COLOR), released on 2023-08-06.

DESCRIPTION

The NO_COLOR convention (see https://no-color.org) lets user disable color output of console programs by defining an environment variable called NO_COLOR. The existence of said environment variable, regardless of its value (including empty string, undef, or 0), signals that programs should not use colored output.

Another similar convention is the use of the COLOR environment variable. False value (empty string or the value 0) means that programs should disable colored output, while true value (values other than the mentioned false values) means that programs should enable colored output. This convention allows force-enabling colored output instead of just force-disabling it, although programs supporting it need to add a line of code or two to check the value of the environment variable.

If you know of other modules that should be listed here, please contact me.

ACME::CPANMODULES ENTRIES

AppBase::Grep

Author: PERLANCAR

App::abgrep

Author: PERLANCAR

Script: abgrep

App::diffdb

Author: PERLANCAR

App::DiffTarballs

Author: PERLANCAR

App::diffwc

Author: PERLANCAR

App::hr

Author: PERLANCAR

App::riap

Author: PERLANCAR

App::wordlist

Author: PERLANCAR

Color::ANSI::Util

Author: PERLANCAR

Data::Dump::Color

Author: PERLANCAR

Data::Format::Pretty::JSON

Author: PERLANCAR

Data::Format::Pretty::Perl

Author: PERLANCAR

Data::Format::Pretty::YAML

Author: PERLANCAR

Debug::Print

Author: PERLANCAR

Log::Any::Adapter::Screen

Author: PERLANCAR

Log::ger::Output::Screen

Author: PERLANCAR

Perinci::CmdLine::Classic

Author: PERLANCAR

Perinci::CmdLine::Lite

Author: PERLANCAR

Perinci::Result::Format

Author: PERLANCAR

Perinci::Result::Format::Lite

Author: PERLANCAR

Progress::Any::Output::TermProgressBar

Term::ANSIColor::Conditional

Author: PERLANCAR

Term::ANSIColor::Patch::Conditional

Author: PERLANCAR

Term::App::Roles

Author: PERLANCAR

Text::ANSITable

Author: PERLANCAR

Text::DiffU

Author: PERLANCAR

FAQ

What is an Acme::CPANModules::* module?

An Acme::CPANModules::* module, like this module, contains just a list of module names that share a common characteristics. It is a way to categorize modules and document CPAN. See Acme::CPANModules for more details.

What are ways to use this Acme::CPANModules module?

Aside from reading this Acme::CPANModules module's POD documentation, you can install all the listed modules (entries) using cpanm-cpanmodules script (from App::cpanm::cpanmodules distribution):

 % cpanm-cpanmodules -n COLOR

Alternatively you can use the cpanmodules CLI (from App::cpanmodules distribution):

    % cpanmodules ls-entries COLOR | cpanm -n

or Acme::CM::Get:

    % perl -MAcme::CM::Get=COLOR -E'say $_->{module} for @{ $LIST->{entries} }' | cpanm -n

or directly:

    % perl -MAcme::CPANModules::COLOR -E'say $_->{module} for @{ $Acme::CPANModules::COLOR::LIST->{entries} }' | cpanm -n

This Acme::CPANModules module also helps lcpan produce a more meaningful result for lcpan related-mods command when it comes to finding related modules for the modules listed in this Acme::CPANModules module. See App::lcpan::Cmd::related_mods for more details on how "related modules" are found.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Acme-CPANModules-COLOR.

SOURCE

Source repository is at https://github.com/perlancar/perl-Acme-CPANModules-COLOR.

SEE ALSO

Acme::CPANModules - about the Acme::CPANModules namespace

cpanmodules - CLI tool to let you browse/view the lists

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) 2023, 2021, 2020, 2018 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=Acme-CPANModules-COLOR

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.

cpanm Acme::CPANModules::COLOR

perl -MCPAN -e shell
install Acme::CPANModules::COLOR