支持颜色检测库: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 是一款强大而易用的工具,将为你在处理终端色彩支持问题上带来极大的便利。无论你是新手还是经验丰富的开发者,都值得一试。立即加入,让你的命令行应用更具色彩!
登录后查看全文
热门项目推荐
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型,它在 Kimi-K2-Base 的基础上,通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式,以及对话式与智能体范式无缝融合。Python00- QQwen3-Coder-Next2026年2月4日,正式发布的Qwen3-Coder-Next,一款专为编码智能体和本地开发场景设计的开源语言模型。Python00
xw-cli实现国产算力大模型零门槛部署,一键跑通 Qwen、GLM-4.7、Minimax-2.1、DeepSeek-OCR 等模型Go06
PaddleOCR-VL-1.5PaddleOCR-VL-1.5 是 PaddleOCR-VL 的新一代进阶模型,在 OmniDocBench v1.5 上实现了 94.5% 的全新 state-of-the-art 准确率。 为了严格评估模型在真实物理畸变下的鲁棒性——包括扫描伪影、倾斜、扭曲、屏幕拍摄和光照变化——我们提出了 Real5-OmniDocBench 基准测试集。实验结果表明,该增强模型在新构建的基准测试集上达到了 SOTA 性能。此外,我们通过整合印章识别和文本检测识别(text spotting)任务扩展了模型的能力,同时保持 0.9B 的超紧凑 VLM 规模,具备高效率特性。Python00
KuiklyUI基于KMP技术的高性能、全平台开发框架,具备统一代码库、极致易用性和动态灵活性。 Provide a high-performance, full-platform development framework with unified codebase, ultimate ease of use, and dynamic flexibility. 注意:本仓库为Github仓库镜像,PR或Issue请移步至Github发起,感谢支持!Kotlin08
VLOOKVLOOK™ 是优雅好用的 Typora/Markdown 主题包和增强插件。 VLOOK™ is an elegant and practical THEME PACKAGE × ENHANCEMENT PLUGIN for Typora/Markdown.Less00
热门内容推荐
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
531
3.74 K
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
336
178
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
886
596
Ascend Extension for PyTorch
Python
340
403
暂无简介
Dart
772
191
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
1
openJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力
TSX
986
247
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
416
4.21 K
React Native鸿蒙化仓库
JavaScript
303
355