@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. 拥有自己的仓库 受约束的货币援助者必须给他们取名,否则这些呼叫站点将不受限制:

"@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。该规则是协同的:其文件注释列出了它承认的条件和 它跳过的形式。 在控制器上启用 :

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