# ansicolors

**Repository Path**: mirrors_LuaDist/ansicolors

## Basic Information

- **Project Name**: ansicolors
- **Description**: ANSI terminal color manipulation for Lua.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2026-02-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

h1. ansicolors.lua

!https://travis-ci.org/kikito/ansicolors.lua.png?branch=master!:https://travis-ci.org/kikito/ansicolors.lua

ansicolors is a simple Lua function for printing to the console in color.


h1. Installation

Put the file ansicolors.lua somewhere where your Lua interpreter will be able to find it. Then:

<pre>
  local ansicolors = require 'ansicolors'
</pre>

h2. Usage

<pre>
  local colors = require 'ansicolors'
  print(colors('%{red}hello'))
  print(colors('%{redbg}hello%{reset}'))
  print(colors('%{bright red underlined}hello'))
</pre>

The @colors@ function makes sure that color attributes are reset at each end of the generated string. If you want to generate complex strings piece-by-piece, use @colors.noReset@, which works exactly the same, but without adding the reset codes at each end of the string.

h2. Testing

This application uses telescope in order to perform the tests. Install telescope, and then execute
<pre>
  tsc specs/ansicolors_spec.lua
</pre>

Notice that the tests will only work on an ANSI-compatible machine (windows isn't ANSI-compatible)

h2. Windows

Windows console, by default, isn't capable of handling ANSI color codes correctly. This library tries to detect whether it is on a windows machine (by looking at package.path) and in that case it suppresses all ANSI control characters (the text appears devoid of color, but legible).

h2. Valid attribute list:

Misc. attributes:

*  @reset@
*  @bright@
*  @dim@
*  @underline@
*  @blink@
*  @reverse@
*  @hidden@

Foreground colors:

*  @black@
*  @red@
*  @green@
*  @yellow@
*  @blue@
*  @magenta@
*  @cyan@
*  @white@

Background colors:
*  @blackbg@
*  @redbg@
*  @greenbg@
*  @yellowbg@
*  @bluebg@
*  @magentabg@
*  @cyanbg@
*  @whitebg@