Installations

npm install @silva97/ansi

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

16.15.0

NPM Version

8.5.5 Score

68.5

Supply Chain

98.7

Quality

75.4

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

10

Closed

0

Merged

10

Issues

Open

0

Total

0

Closed

0

Releases

5

Version 1.1.3

v1.1.3

Updated on May 18, 2022

Version 1.1.2

v1.1.2

Updated on Jun 12, 2021

Version 1.1.1

v1.1.1

Updated on Feb 24, 2021

Version 1.1.0

v1.1.0

Updated on Nov 28, 2020

Version 1.0.0

v1.0.0

Updated on Nov 28, 2020

View All 5 releases

Languages

2

JavaScript

TypeScript

JavaScript (62.2%)

TypeScript (37.8%)

Developer

Silva97

Download Statistics

Total Downloads

1,207

Last Day

1

Last Week

3

Last Month

22

Last Year

162

GitHub Statistics

MIT License

1 Stars

36 Commits

1 Watchers

1 Branches

1 Contributors

Updated on May 17, 2022

Bundle Size

1.58 kB

Minified

830.00 B

Minified + Gzipped

Bundlephobia

Maintainers

1

View All 1 Contributors

Package Meta Information

Latest Version

1.1.3

Package Id

@silva97/ansi@1.1.3

Unpacked Size

8.45 kB

Size

3.72 kB

File Count

9

NPM Version

8.5.5

Node Version

16.15.0

Total Downloads

Cumulative downloads

Total Downloads

1,207

Last Day

0%

1

Compared to previous day

Last Week

0%

3

Compared to previous week

Last Month

633.3%

22

Compared to previous month

Last Year

-12.9%

162

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

4

@types/jest jest ts-jest typescript

@silva97/ansi

This package implements a tag function to parse template strings and add ANSI escape sequences to use colors and text styles on terminal. (read about template strings)

1// Example
2const { ansi } = require('@silva97/ansi');
3
4console.log(ansi`%{f.green}Hello %{f.red;bold;under}World!`);

Output:
terminal-output

Installation

1npm install @silva97/ansi
2# Or using yarn:
3yarn add @silva97/ansi

ansi tags

The ansi tags follows the format %{...}, it's similar to notation ${...} of template strings to expands the content of an expression on the string. But ansi tags is used to output ANSI escapes.

The color name is specified using the format mode.color. Example f.blue will be set the foreground color to blue.

Mode	ANSI code	Description
`f`	`3`	Foreground color
`F`	`9`	Light foreground color
`b`	`4`	Background color

Color	ANSI code
`black`	`0`
`red`	`1`
`green`	`2`
`yellow`	`3`
`blue`	`4`
`violet`	`5`
`purple`	`5`
`cyan`	`6`
`white`	`7`

You can also specify styles to text. Example: %{bold;strike}Hello!.

Style	ANSI code	Description
`normal`	`0`	Resets to normal style
`bold`	`1`	Bold text
`italic`	`3`	Italic text
`under`	`4`	underline text
`blink`	`5`	Blinks the text
`invert`	`7`	Inverts background and foreground colors
`strike`	`9`	~~strike text~~

Warning: Some styles, like blink and strike, will not work on all terminals. (i.e. VS code integrated terminal)

Note: You can also specify the style numbers instead of the names. Example: %{31;1} will be translated to \x1b[31;1m (same as %{f.red;bold}).

It's yet template strings!

Using ansi tag function you can yet use ${} expressions inside yours strings. Example:

1const { ansi } = require('@silva97/ansi');
2
3const name = 'Luiz Felipe';
4
5console.log(ansi`Your name is %{f.green;bold}${name}%{normal}!`);

You can easy disable colors!

You can simple disable the colors of the output if you set ansi.enabled to false. For example:

1const { ansi } = require('@silva97/ansi');
2
3ansi.enabled = false;
4const name = 'Luiz Felipe';
5
6console.log(ansi`Your name is %{f.green;bold}${name}%{normal}!`);
7// Output: "Your name is Luiz Felipe!"

It's will print the text without colors.

Purify text from ANSI escapes

If you previous has been escaped an text, but need the raw text back. You just need to use the purify() function and it will remove all ANSI escapes from the text.

1const { ansi, purify } = require('@silva97/ansi');
2
3const name = 'Luiz Felipe';
4const welcome = ansi`Your name is %{f.green;bold}${name}%{normal}!`;
5
6console.log(welcome);         // Colored text
7console.log(purify(welcome)); // Normal text
8

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

2

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

2.7

/10

Last Scanned on 2025-04-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More