支持颜色检测库:supports-color
2024-05-20 14:58:01作者:董斯意
在开发命令行工具或终端应用时,适配不同终端的颜色支持是一项重要的任务。supports-color 是一个简洁且高效的 Node.js 库,用于检测终端是否支持色彩显示。这个库不仅能够判断基本的彩色支持,还能识别 256 色和真彩色(16百万色)的支持情况。
安装与使用
要开始使用 supports-color,只需简单地通过 NPM 进行安装:
$ npm install supports-color
随后,你可以在你的代码中引入并使用它来检测标准输出流(stdout)或标准错误流(stderr)是否支持颜色:
import supportsColor from 'supports-color';
if (supportsColor.stdout) {
console.log('Terminal stdout supports color');
}
if (supportsColor.stdout.has256) {
console.log('Terminal stdout supports 256 colors');
}
if (supportsColor.stderr.has16m) {
console.log('Terminal stderr supports 16 million colors (truecolor)');
}
API 详解
supports-color 返回一个对象,包含了 stdout 和 stderr 两个属性,分别对应这两个流的颜色支持信息。每个属性都是一个对象,或者如果终端不支持颜色,则为 false。每个对象都有一个 .level 属性,表示支持的颜色级别,并有相应的标志:
.level = 1和.hasBasic = true:基础色支持(16种颜色).level = 2和.has256 = true:256色支持.level = 3和.has16m = true:真彩色支持(16百万色)
此外,库还提供了一个名为 createSupportsColor 的函数,可以为任意的写入流创建自定义颜色支持检测器。
自定义实例
例如,你可以这样为 process.stdout 创建一个定制的实例:
import { createSupportsColor } from 'supports-color';
const stdoutSupportsColor = createSupportsColor(process.stdout);
此处的 stdoutSupportsColor 对象与 supportsColor.stdout 相同。
功能特性
- 遵守
--color和--no-color命令行参数。 - 可以通过环境变量
FORCE_COLOR强制开启或关闭颜色支持。 - 使用
--color=256或--color=16m参数可强制设置为 256 色或真彩色模式。
相关项目
如果你对相关的终端美化或辅助工具感兴趣,可以查看以下项目:
- supports-color-cli - 该模块的命令行界面工具
- chalk - 端口字符串样式处理库
- is-unicode-supported - 检测终端是否支持Unicode
- is-interactive - 判断 stdout 或 stderr 是否处于交互模式
维护者
本项目的维护者包括 Sindre Sorhus 和 Josh Junon。
请注意:为了确保开源软件的可持续发展,该项目也提供了由 Tidelift 提供的专业支持订阅服务。这为开发者提供了保证安全、维护和许可的商业级保证,同时也支持了开源社区。
supports-color 是一款强大而易用的工具,将为你在处理终端色彩支持问题上带来极大的便利。无论你是新手还是经验丰富的开发者,都值得一试。立即加入,让你的命令行应用更具色彩!
登录后查看全文
热门项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0137- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
MiniCPM-V-4.6这是 MiniCPM-V 系列有史以来效率与性能平衡最佳的模型。它以仅 1.3B 的参数规模,实现了性能与效率的双重突破,在全球同尺寸模型中登顶,全面超越了阿里 Qwen3.5-0.8B 与谷歌 Gemma4-E2B-it。Jinja00
MiniMax-M2.7MiniMax-M2.7 是我们首个深度参与自身进化过程的模型。M2.7 具备构建复杂智能体应用框架的能力,能够借助智能体团队、复杂技能以及动态工具搜索,完成高度精细的生产力任务。Python00
MusicFreeDesktop插件化、定制化、无广告的免费音乐播放器TypeScript00
项目优选
收起
暂无描述
Dockerfile
725
4.66 K
Ascend Extension for PyTorch
Python
597
749
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
425
377
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
992
985
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
981
137
昇腾LLM分布式训练框架
Python
160
190
暂无简介
Dart
969
246
deepin linux kernel
C
29
16
Oohos_react_native
React Native鸿蒙化仓库
C++
345
393
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.65 K
970