@coveo/atomic-component-health-check

中文文档
2.2.19发布于 2024/05/14Apache-2.0ES Module近 30 天下载 6634

A Health checker for custom Atomic component

原始使用文档
文档目录3 节
  1. Installation
  2. Usage
  3. Contributing

Health Check

This is a package that checks if your Atomic custom components meet all the conditions required in order to be published. It is designed to help you ensure that your component is healthy and easily sharable with other users.

Installation

You can install Health Check using npm:

npm install health-check --save-dev

Usage

Once installed, you can use Health Check by running the bin file (atomic-meta-check) available in the node modules: It is meant to be used as a prepublishOnly script. You can add it to your package.json:

...
"scripts": {
    "prepublishOnly": "npm run build && atomic-meta-check",
},
...
"devDependencies": {
    "@coveo/atomic-component-health-check": "latest",
},
...

Contributing

If you find a bug or have a feature request, please create an issue or submit a pull request.

版本与发布记录

@coveo/atomic-component-health-check 共发布 96 个版本,首次发布于 2023/03/21;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.2.19latest2024/05/142 年前
2.2.19-0beta2024/05/142 年前
2.2.182024/05/082 年前
2.2.172024/02/212 年前
2.2.17-02024/02/212 年前
2.2.162024/01/162 年前

关于 @coveo/atomic-component-health-check 的常见问题

@coveo/atomic-component-health-check 是什么?

A Health checker for custom Atomic component

如何安装 @coveo/atomic-component-health-check?

在项目目录运行 npm install @coveo/atomic-component-health-check,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 atomic-meta-check,可以用 npx atomic-meta-check 直接运行。

@coveo/atomic-component-health-check 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/coveo__atomic-component-health-check 是否存在。

@coveo/atomic-component-health-check 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@coveo/atomic-component-health-check 可以商用吗?

@coveo/atomic-component-health-check 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@coveo/atomic-component-health-check 的下载量有多少?

根据 npm 官方下载统计,@coveo/atomic-component-health-check 在 2026/10/11 – 2026/11/09 这 30 天内被下载 6,634 次,日均约 221 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@coveo/atomic-component-health-check 还在维护吗?

最新版本 2.2.19 发布于 2024/05/14(2 年前);至今共发布 96 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/03/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。