# @clipboard-health/oxlint-plugin 中文文档

规范地址：https://npmcn.com/package/%40clipboard-health/oxlint-plugin/

版本：1\.8\.7
npm 元数据更新时间：2026-11-05T13:14:32.228Z
中文译文更新时间：2026-11-10T01:52:05.065Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40clipboard-health/oxlint-plugin
原文对照：https://npmcn.com/package/%40clipboard-health/oxlint-plugin/?lang=original
项目主页：https://github.com/ClipboardHealth/core-utils#readme
源码仓库：https://github.com/ClipboardHealth/core-utils

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：182 kB，47 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2026-08-14T19:01:03.369Z
- 最新版本发布：2026-11-05T13:14:32.021Z
- 近 30 天下载量：37423（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：46（近 12 个月 46 个）

## 中文简介

剪贴板的Oxlint插件.

## 安装

```sh
npm install @clipboard-health/oxlint-plugin
```

也可以使用：`pnpm add @clipboard-health/oxlint-plugin`、`yarn add @clipboard-health/oxlint-plugin`、`bun add @clipboard-health/oxlint-plugin`

## README

# @clipboard-health/克林特-插图

剪贴板自定义Oxlint规则. 消费者通常应当使用由下列单位输出的预设: `@clipboard-health/oxlint-config`。 。 。 .

该软件包独立于ESLint和 `@typescript-eslint`。标准 `create(context)` 规则还按下列方式再出口: `@clipboard-health/eslint-plugin` 用于仍然使用的存储器 (原始内容存档于2018-10-10). EsLint.

## 规则

-   `enforce-contract-in-controllers`
-   `enforce-ts-rest-in-controllers`: 贬值的别名 `enforce-contract-in-controllers`已删除 在下一个主要版本中
-   `no-ambiguous-positional-parameters`
-   `no-empty-boolean-call`
-   `no-cross-contract-imports`
-   `no-parallel-mongo-session-ops`
-   `no-tests-in-contract-packages`
-   `require-contract-fixture-construction`
-   `require-contract-response-parse`
-   `require-http-module-factory`
-   `require-run-validators-with-upsert`
-   `require-to-declared-error`
-   `require-zod-import-in-contracts`

## 配置

使用 `customRules` 预设从 `@clipboard-health/oxlint-config` 以注册插件和 适用共享控制器、模块、合同和跨合同进口范围。 这个 `contractFixtures` 预设可以在测试中进行固定-构造检查.

`no-empty-boolean-call`, (中文(简体) ), `require-contract-response-parse`,以及 `require-run-validators-with-upsert` 因为他们的安全收养范围 特定仓库.

`customRules` 启用 `no-tests-in-contract-packages` 从 `@clipboard-health/oxlint-config` 3.0.0 (中文(简体) ). 它只报告内部测试文件 `packages/contract-*` 目录,不包括 `packages/contract-core`。 。 。 .

`no-parallel-mongo-session-ops` 也可以选入。 从它覆盖的盒子里 `Promise.all`, (中文(简体) ), `Promise.allSettled`, (中文(简体) ), `Promise.race`,以及 `Promise.any`. 拥有自己的仓库 受约束的货币援助者必须给他们取名,否则这些呼叫站点将不受限制:

```ts
"@clipboard-health/no-parallel-mongo-session-ops": [
  "warn",
  { additionalPrimitives: ["batchPromiseAllWithLimit", "batchPromiseAllSettledWithLimit"] },
],
```

排除测试: app级会话对象, 如 `session.sessionUserId` 共享名称, 但为 与MongoDB会议无关.

`require-to-declared-error` 服务采用 ORPC。 在一个处理器传递到 ORPC的 `implement(...).handler()`,每个 `throw` 在处理失败的分支中 `ServiceResult` 必须 掷出 `toDeclaredError({ errors, error })` 从 `@clipboard-health/api-nestjs`,或其中的一个 处理器的 `errors` 建筑师,所以反应 保持状态的合同申报。 分支机构 可能还是 `return`。该规则是协同的:其文件注释列出了它承认的条件和 它跳过的形式。 在控制器上启用 :

```ts
{
  files: ["**/*.controller.ts"],
  rules: { "@clipboard-health/require-to-declared-error": "error" },
},
```

## 常见问题

### @clipboard-health/oxlint-plugin 是什么？

剪贴板的Oxlint插件\.

### 如何安装 @clipboard-health/oxlint-plugin？

在项目目录运行 npm install @clipboard-health/oxlint-plugin，或使用 pnpm add / yarn add / bun add。

### @clipboard-health/oxlint-plugin 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @clipboard-health/oxlint-plugin 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @clipboard-health/oxlint-plugin 可以商用吗？

@clipboard-health/oxlint-plugin 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @clipboard-health/oxlint-plugin 的下载量有多少？

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

### @clipboard-health/oxlint-plugin 还在维护吗？

最新版本 1\.8\.7 发布于 2026/11/05（4 天前）；至今共发布 46 个版本，其中过去 12 个月发布了 46 个；首次发布于 2026/08/15。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。