npmpackage.info

Gathering detailed insights and metrics for @poppinss/colors

Other packages similar to @poppinss/colors

@poppinss/cliui

6.4.3

Opinionated UI KIT for Command Line apps

Gathering detailed insights and metrics for @poppinss/colors

@poppinss/colors - 4.1.4 | npmpackage.info

@poppinss/colors

Wrapper over kleur with better support for testing

4.1.4

MIT

TypeScript

14.67 kB

4.1

Installations

npm install @poppinss/colors

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>=18.16.0

Node Version

20.18.1

NPM Version

10.8.2 Score

99.5

Supply Chain

98.6

Quality

80.8

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

8

Closed

0

Merged

8

Issues

Open

0

Total

1

Closed

1

Releases

Update dependencies

v4.1.4

Updated on Dec 24, 2024

Update dependencies

v4.1.3

Updated on Mar 28, 2024

Updating dependencies

v4.1.2

Updated on Dec 15, 2023

Publish source map and use TSC for generating types

v4.1.1

Updated on Nov 06, 2023

Publish under latest release

v4.1.0

Updated on Oct 14, 2023

Use tsup for bundling

v4.1.0-4

Updated on Sep 23, 2023

View All 36 releases

Languages

TypeScript

JavaScript

TypeScript (99.52%)

JavaScript (0.48%)

Developer

poppinss

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

5 Stars

97 Commits

2 Forks

3 Watchers

1 Branches

4 Contributors

Updated on Dec 24, 2024

Maintainers

View All 4 Contributors

Package Meta Information

Latest Version

4.1.4

Package Id

@poppinss/colors@4.1.4

Unpacked Size

14.67 kB

Size

4.54 kB

File Count

NPM Version

10.8.2

Node Version

20.18.1

Published on

Dec 24, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

kleur

Dev Dependencies

@adonisjs/eslint-config @adonisjs/prettier-config @adonisjs/tsconfig @japa/assert @japa/runner @release-it/conventional-changelog @swc/core @types/node c8 del-cli eslint prettier release-it ts-node-maintained tsup typescript

@poppinss/colors

Wrapper over kleur with better support for testing

Why this package exists?

This package is a wrapper over kleur with additional implementations to make testing easier and work seamlessly with terminals/stdout streams that do not support colors.

Usage

Install the package from the npm registry as follows.

1npm i @poppinss/colors

And use it as follows. The ansi method returns an instance of the kleur package.

1import useColors from '@poppinss/colors'
2const colors = useColors.ansi()
3
4console.log(colors.red('this is an error'))
5console.log(colors.cyan('hello world'))

Chaining methods

1const colors = useColors.ansi()
2console.log(colors.red().bgBlack('this is an error'))

Raw implementation

The raw implementation is ideal for testing. Instead of outputting ANSI escape codes, we wrap the string with transformation names. For example:

1import useColors from '@poppinss/colors'
2const colors = useColors.raw()
3
4console.log(colors.red('hello world'))
5// OUTPUT: red(hello world)
6
7console.log(colors.bgBlack().red('hello world'))
8// OUTPUT: bgBlack(red(hello world))

As you can notice, the output is a plain text value, so it is easier to write assertions against it.

1assert.equal(colors.red('hello world'), 'red(hello world)')

Silent output

The silent mode does not perform any transformations on the string and returns the value. This is helpful when the output terminal or stdout stream does not support colors.

1import useColors from '@poppinss/colors'
2const colors = useColors.silent()
3
4console.log(colors.red('hello world'))
5// OUTPUT: hello world
6
7console.log(colors.bgBlack().red('hello world'))
8// OUTPUT: hello world

Pick based on the runtime environment

Ideally, you will use one of the available implementations based on some runtime environment. For example:

1import useColors from '@poppinss/colors'
2import supportsColor from 'supports-color'
3
4const isTestEnv = process.env.NODE_ENV === 'test'
5
6const colors = isTestEnv
7  ? useColors.raw() // use raw in test environment
8  : supportsColor.stdout
9    ? useColors.ansi() // use kleur when stdout has colors
10    : useColors.silent() // use silent mode 
11
12export default colors

SAST

Determines if the project uses static code analysis.

0

Branch-Protection

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

Score

4.1

/10

Last Scanned on 2025-06-23

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