首页
/ 支持颜色检测库:supports-color

支持颜色检测库:supports-color

2024-05-20 14:58:01作者:董斯意
supports-color
Detect whether a terminal supports color

在开发命令行工具或终端应用时,适配不同终端的颜色支持是一项重要的任务。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 返回一个对象,包含了 stdoutstderr 两个属性,分别对应这两个流的颜色支持信息。每个属性都是一个对象,或者如果终端不支持颜色,则为 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 色或真彩色模式。

相关项目

如果你对相关的终端美化或辅助工具感兴趣,可以查看以下项目:

维护者

本项目的维护者包括 Sindre Sorhus 和 Josh Junon。


请注意:为了确保开源软件的可持续发展,该项目也提供了由 Tidelift 提供的专业支持订阅服务。这为开发者提供了保证安全、维护和许可的商业级保证,同时也支持了开源社区。


supports-color 是一款强大而易用的工具,将为你在处理终端色彩支持问题上带来极大的便利。无论你是新手还是经验丰富的开发者,都值得一试。立即加入,让你的命令行应用更具色彩!

supports-color
Detect whether a terminal supports color
热门项目推荐
相关项目推荐

项目优选

收起
CangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
672
0
openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
12
8
advanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.83 K
19.04 K
redis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
323
26
RuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
136
18
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
31
5
easy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
1.42 K
231
xzs
在线考试系统、考试系统、在线教育考试系统、在线教育、跨平台考试、考试、智能考试、试题、错误试题、考试题目、试题组卷等
HTML
3
1
langgpt
Ai 结构化提示词,人人都能写出高质量提示词,GitHub 开源社区全球趋势热榜前十项目,已被百度、智谱、字节、华为等国内主流大模型智能体平台使用,内容来自国内最具影响力的高质量提示词工程师学习交流社群——LangGPT。开源知识库:https://langgptai.feishu.cn/wiki/RXdbwRyASiShtDky381ciwFEnpe
Jupyter Notebook
16
2