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

支持颜色检测库: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 返回一个对象,包含了 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 是一款强大而易用的工具,将为你在处理终端色彩支持问题上带来极大的便利。无论你是新手还是经验丰富的开发者,都值得一试。立即加入,让你的命令行应用更具色彩!

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
262
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
863
511
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
259
300
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
596
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K