ansi-regex
Advanced tools
Package description
The ansi-regex npm package is used to create regular expressions to match ANSI escape codes, which are used to format output in terminal with colors, background colors, styles like bold or underline, and other text effects.
Matching ANSI escape codes
This code sample demonstrates how to use ansi-regex to match ANSI escape codes in a string. The string contains the ANSI escape codes for underlining text, followed by the word 'cake', and then the reset code to stop the underlining. The ansiRegex function is called to generate a regular expression that matches these codes.
"\u001B[4mcake\u001B[0m".match(ansiRegex());strip-ansi is a package that removes ANSI escape codes from strings. It is similar to ansi-regex in that it deals with ANSI codes, but instead of matching them, it strips them from the text, which can be useful for cleaning up terminal output for logging or processing.
chalk is a popular package for styling terminal output with ANSI escape codes. It provides a more user-friendly API for applying styles compared to manually writing escape codes. While ansi-regex is used for detecting ANSI codes, chalk is used for generating them.
Readme
Regular expression for matching ANSI escape codes
$ npm install --save ansi-regex
var ansiRegex = require('ansi-regex');
ansiRegex().test('\u001b[4mcake\u001b[0m');
//=> true
ansiRegex().test('cake');
//=> false
'\u001b[4mcake\u001b[0m'.match(ansiRegex());
//=> ['\u001b[4m', '\u001b[0m']
It's a function so you can create multiple instances. Regexes with the global flag will have the .lastIndex property changed for each call to methods on the instance. Therefore reusing the instance with multiple calls will not work as expected for .test().
MIT © Sindre Sorhus
FAQs
Regular expression for matching ANSI escape codes
The npm package ansi-regex receives a total of 96,053,337 weekly downloads. As such, ansi-regex popularity was classified as popular.
We found that ansi-regex demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.