# parse-ansi > ๐Ÿค– Parse ANSI text into an array of ansi-tags and text-chunks. Latest version **1.0.4** (published 2026-09-07) ยท MIT license ยท 0 weekly downloads ## Install ```sh npm install parse-ansi pnpm add parse-ansi yarn add parse-ansi bun add parse-ansi ``` ## Health **Score 55/100 (C)** โ€” status: active. Positive: no vulnerabilities; recently updated; high maintenance score. Warnings: low downloads; no types; no esm support. ## Facts | | | |---|---| | Version | 1.0.4 | | Published | 2026-09-07 | | First published | 2018-04-07 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 5 | | Unpacked size | 14.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 13 | | Author | F1LT3R | | Maintainers | f1lt3r | | Keywords | ansi, parse, parser, escape, sequence, chalk, color, open, close, style, character | ## Links - npm: https://www.npmjs.com/package/parse-ansi - Repository: https://github.com/F1LT3R/parse-ansi - Homepage: https://github.com/F1LT3R/parse-ansi#readme - Issues: https://github.com/F1LT3R/parse-ansi/issues - npm.io page: https://npm.io/package/parse-ansi ## Dependencies (5) - [deepmerge](https://npm.io/package/deepmerge.md) ^2.1.0 - [ansi-regex](https://npm.io/package/ansi-regex.md) ^3.0.0 - [array-uniq](https://npm.io/package/array-uniq.md) ^1.0.3 - [strip-ansi](https://npm.io/package/strip-ansi.md) ^4.0.0 - [super-split](https://npm.io/package/super-split.md) ^1.1.0 ## Alternatives - [babylon](https://npm.io/package/babylon.md) โ€” 5.1M weekly downloads - [csscolorparser](https://npm.io/package/csscolorparser.md) โ€” 3.7M weekly downloads - [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) โ€” 1.5M weekly downloads - [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) โ€” 247.7K weekly downloads - [xml-parser](https://npm.io/package/xml-parser.md) โ€” 78.4K weekly downloads ## Recent versions - 1.0.4 (latest) โ€” 2026-09-07 - 1.0.3 โ€” 2018-04-07 - 1.0.2 โ€” 2018-04-07 - 1.0.1 โ€” 2018-04-07 - 1.0.0 โ€” 2018-04-07 ## README # parse-ansi > ๐Ÿค– Parse ansi into an array of ansi-tags and text-chunks. [![Build Status](https://travis-ci.org/F1LT3R/parse-ansi.svg?branch=master)](https://travis-ci.org/F1LT3R/parse-ansi) [![Coverage Status](https://coveralls.io/repos/github/F1LT3R/parse-ansi/badge.svg?branch=master)](https://coveralls.io/github/F1LT3R/parse-ansi?branch=master) [![NPM Version](https://img.shields.io/npm/v/@f1lt3r/parse-ansi.svg)](https://www.npmjs.com/package/@f1lt3r/parse-ansi) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo) Parse-ANSI takes an ANSI string as input: ```plain const text = "๐Ÿค–\u001B[31m DANGER\u001B[0m Will Robbinson" console.log(text) ``` ![Danger Will Robbinson](danger-will-robbinson.png) When you run your text through the ANSI parser... ```js const parseAnsi = require('parse-ansi') const parsed = parseAnsi(text) console.log(parsed) ``` ...Parse-ANSI outputs value, position and style data. ```js { raw: '๐Ÿค–\u001B[31m DANGER\u001B[0m Will Robbinson', plain: '๐Ÿค– DANGER Will Robbinson', textArea: {columns: 24, rows: 1}, chunks: [{ type: 'text', value: '๐Ÿค–', position: {x: 0, y: 0, n: 0, raw: 0}, style: {} }, { type: 'ansi', value: {tag: 'red', ansi: '\u001b[31m'}, position: {x: 2, y: 0, n: 2, raw: 2} }, { type: 'text', value: ' DANGER', position: {x: 2,y: 0,n: 2, raw: 7}, style: { foregroundColor: 'red' } }, { type: 'ansi', value: {tag: 'reset', ansi: '\u001b[0m'}, position: {x: 9, y: 0, n: 9, raw: 14} }, { type: 'text', value: ' Will Robbinson', position: {x: 9, y: 0, n: 9, raw: 18}, style: {} }] } ``` This data can be used to convert ANSI sequences to other formatsm such as HTML, Image, SVG, etc. ## Chunk Each object in the output array is called a "chunk". Each chunk represents one or more of the following data types. 1. `ansi` - ANSI escape sequence 1. `newline` - Newline character 1. `text` - Text chunk of like-styles ## Style The style object contains a list of styles associated with the current chunk. Each style represents an ANSI Escape sequence that is mapped to friendly name called an `ANSI-Tag`. - Styles are only included in text chunks. - Styles that are off/closed, are not present in the style object. The following style object describes a chunk of red text: ```js { foregroundColor: 'red' } ``` This object shows alls styles in combination: ```js { backgroundColor: 'bgRed', foregroundColor: 'white', dim: true, bold: true, italic: true, underline: true, strikethrough: true, inverse: true } ``` Styles that are closed or reset are not included in the style object. For example: ```js // Turn on Bold const text = '\u001b[1m BOLD' + // Turn off all styles '\u001b[0m NORMAL' const parsed = parseAnsi(text) const styles = parsed .filter(chunk => chunk.style) .map(chunk => chunk.style) console.log(styles) ``` The above code should log: ```js [ // Turn on Bold { bold: true }, // Turn off all styles {} ] ``` ## Position ```js {x: 2, y: 0, n: 2, raw: 2} ``` The position object contains 4 kinds of position: 1. `x` - Plain-text column at which the chunk starts 1. `y` - Plain-text crow at which the chunk starts 1. `n` - Linear, 1-dimensional plain-text position at which the chunk starts. 1. `raw` - Linear 1-dimensional position at which the chunk starts for ANSI or plain-text. This is the real JavaScript position string position of the chunk. ## Value ### Text Value The value of a `text` chunk is a JavaScript string. The value of a text chunk should never contain any ANSI escape sequences. ```js { type: 'text', value: ' DANGER', } ``` ### ANSI Value The value of an `ansi` chunk is an object. - `value.tag` - Friendly-named ansi-tag. - `value.ansi` - Raw ANSI string value. ```js { type: 'ansi', value: { tag: 'red', ansi: '\u001b[31m' } } ``` You can find the list ansi-tags in [types/types.ansi-seqs-to-ansi-tags.js](types/types.ansi-seqs-to-ansi-tags.js). ## Install ``` $ yarn add parse-ansi ``` --- _Source: https://npm.io/package/parse-ansi ยท Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._