Gathering detailed insights and metrics for @poppinss/colors
Gathering detailed insights and metrics for @poppinss/colors
Installations
npm install @poppinss/colorsDeveloper 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
Releases
36
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
Languages
2
TypeScript
JavaScript
TypeScript (99.52%)
JavaScript (0.48%)
Developer
poppinss
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
5 Stars
97 Commits
2 Forks
3 Watchers
1 Branches
4 Contributors
Updated on Dec 24, 2024
Bundle Size
3.66 kB
Minified
1.36 kB
Minified + Gzipped
Maintainers
3
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
11
NPM Version
10.8.2
Node Version
20.18.1
Published on
Dec 24, 2024
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
@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
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE.md:0
- Info: FSF or OSI recognized license: MIT License: LICENSE.md:0
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/poppinss/.github/docs/SECURITY.md:1
- Info: Found linked content: github.com/poppinss/.github/docs/SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/poppinss/.github/docs/SECURITY.md:1
- Info: Found text in security policy: github.com/poppinss/.github/docs/SECURITY.md:1
Reason
Found 1/30 approved changesets -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/labels.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/poppinss/colors/labels.yml/4.x?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/labels.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/poppinss/colors/labels.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/poppinss/colors/release.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/poppinss/colors/release.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stale.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/poppinss/colors/stale.yml/4.x?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/release.yml:28
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/checks.yml:1
- Warn: topLevel 'contents' permission set to 'write': .github/workflows/release.yml:4
- Warn: no topLevel permission defined: .github/workflows/stale.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 2 are checked with a SAST tool
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch '4.x'
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