strip-ansi

What is strip-ansi?

The strip-ansi npm package is used to remove ANSI escape codes from strings. These codes are often used to provide coloring and formatting in terminal output, but they can be problematic when the text needs to be processed without these codes, such as logging to a file or displaying in a GUI.

What are strip-ansi's main functionalities?

Strip ANSI escape codes from a string

This feature allows you to remove any ANSI escape codes from a given string, leaving only the plain text without any formatting or color.

const stripAnsi = require('strip-ansi');
const coloredString = '\u001B[4mUnicorn\u001B[0m';
const strippedString = stripAnsi(coloredString);
console.log(strippedString); // 'Unicorn'

Other packages similar to strip-ansi

chalk

Chalk is a popular npm package that allows you to style terminal text with colors and other effects. While it is primarily used to add ANSI codes to strings, it also provides methods to strip color from strings, which can be used as an alternative to strip-ansi for this specific purpose.

ansi-regex

ansi-regex is a package that provides a regular expression to match ANSI escape codes. It can be used in combination with string replace functions to remove ANSI codes from strings, similar to what strip-ansi does, but requires a bit more manual work.

ansi-colors

ansi-colors is another library for styling terminal strings with ANSI colors. It also includes functionality to strip ANSI codes from strings. It is a lightweight alternative to chalk and can be used in place of strip-ansi for removing ANSI codes.

README

strip-ansi

Strip ANSI escape codes from a string

[!NOTE] Node.js has this built-in now with stripVTControlCharacters. The benefit of this package is consistent behavior across Node.js versions and faster improvements. The Node.js version is actually based on this package.

Install

npm install strip-ansi

Usage

import stripAnsi from 'strip-ansi';

stripAnsi('\u001B[4mUnicorn\u001B[0m');
//=> 'Unicorn'

stripAnsi('\u001B]8;;https://github.com\u0007Click\u001B]8;;\u0007');
//=> 'Click'

Related

• strip-ansi-cli - CLI for this module
• strip-ansi-stream - Streaming version of this module
• has-ansi - Check if a string has ANSI escape codes
• ansi-regex - Regular expression for matching ANSI escape codes
• chalk - Terminal string styling done right

Maintainers

• Sindre Sorhus
• Josh Junon