@aureienbn/克林特-插座-核心

18克林特规则适用于任何TypeScript代码库:吞入错误,片状或空心测试,生产中的测试代码,匿名公共合同,工作空间成员互相泄露,口语收缩.

pnpm add -D @aurelienbbn/oxlint-plugin-core oxlint   # oxlint >=1.82.0 <2.0.0

{
  "jsPlugins": ["@aurelienbbn/oxlint-plugin-core"],
  "rules": {
    "core/no-discarded-caught-error": "error",
    "core/no-weak-test-assertions": ["error", { "assertionHelpers": ["assertValid"] }],
    "core/no-test-sleeps": "error"
  }
}

无预设,一种自定义. 启用每个规则的名称; 每一个修补, 但补丁规则的空白行需要一个工具无法做出的决定 .

QQ 处理或解释发现的错误

try {
  await sync();
} catch (error) {
  console.error(error);
  return [];
} // ❌ only logged
promise.catch(() => null); // ❌ discarded
promise.catch(handleFailure); // ✅ handed to a function
try {
  access(path);
  return true;
} catch {
  // REASON: a missing file is the negative answer here
  return false; // ✅ reasoned
}

return err.message === "Not found"; // ❌ no-error-message-matching
return error instanceof TimeoutError; // ✅ class, tag, or code

try {
  return await load(id);
} catch (error) {
  throw new LoadError({ id, cause: error });
} // ✅ rethrown
try {
  return await load();
} catch (error) {
  if (isNotFound(error)) return undefined;
  throw error;
} // ✅ inspected

测试证明行为,决定性

no-weak-test-assertions 法官每个测试:一个强有力的断言可以澄清这一点.

await new Promise((r) => setTimeout(r, 500)); // ❌ no-test-sleeps
await vi.waitFor(() => expect(state()).toBe("done")); // ✅ poll the condition

// cart.test.ts
vi.spyOn(cart, "total").mockReturnValue(30); // ❌ no-stubbed-subject
vi.spyOn(pricing, "rate").mockReturnValue(2); // ✅ another module

export const send = (mail) => (process.env.NODE_ENV === "test" ? undefined : deliver(mail)); // ❌ no-test-logic-in-production

使用 Vitest 内源测试回合的项目 no-test-logic-in-production 离开那些文件.

await new Promise((r) => setTimeout(r, 500)); // ❌ timer-only executor
import { setTimeout as sleep } from "node:timers/promises"; // ❌ also `scheduler`
await sleep(250); // ❌ sleep / delay / wait / pause + numeric literal

import * as cart from "./cart"; // also ./cart.js, ../cart/index
vi.spyOn(cart, "total"); // ✅ pass-through spy

export const send = (mail) => (process.env.NODE_ENV === "test" ? undefined : deliver(mail)); // ❌ also import.meta.env.MODE === "test"
export const retries = process.env.VITEST ? 0 : 3; // ❌ also VITEST_WORKER_ID, JEST_WORKER_ID, import.meta.vitest
export const __testing__ = { parse }; // ❌ name marks it test-only
/** Visible only for unit tests. */
export const parse = (input) => input; // ❌ comment marks it test-only

公共合同的名称

export const getUser = () => ({ id: user.id }); // ❌ no-exported-anonymous-object-return
export const load: Load = () => ({ id: user.id }); // ✅ named contract

const loadUser = (userId: UserId, includePosts: boolean) => userId; // ❌ no-multi-positional-parameters
export function loadUser(input: { userId: UserId; includePosts: boolean }) {} // ✅ object input

export let currentUserId = undefined; // ❌ no-mutable-exported-state
export * from "./user.js"; // (whole file)                    // ❌ no-reexport-only-modules, unless listed in `allow`
let total = 0; // ❌ no-let (also `var`)

工作空间成员仅通过出口开会

workspace-boundaries 读取最近的成员 pnpm-workspace.yaml (或 package.json workspaces评议 import, (中文(简体) ), export … from,以及 import() 两名委员之间:

// packages/kernel/src/tick.ts
import { boot } from "@game/client"; // ❌ packages never import apps (members under `apps`)
import { arrow } from "../../ranger/src/arrow.ts"; // ❌ relative path into another member
import { body } from "@game/physics/src/body.ts"; // ❌ not opened by @game/physics `exports`
import { body } from "@game/physics"; // ✅ an exported subpath

{
  "core/workspace-boundaries": [
    "error",
    {
      "apps": ["apps/**", "infra/**"],
      "forbidden": [
        { "from": "packages/features/*", "to": "packages/features/*", "message": "features meet through the kernel" },
        { "from": "packages/kernel", "to": "packages/adapters/**" }
      ]
    }
  ]
}

一个没有子路的表象 exports 只打开其根;一个子路径映射到 null 关闭; * 匹配至少一个字符,如节点。 仅按类型进口和再出口被判断为价值进口:一种类型的依赖仍然是依赖. require() 财务报告和审定财务报表 import x = require() 未读。 每个成员以外的文件(root configs,脚本)从不被判断. 目录模式 : * 在一个部分之内, ** 横跨各段。 成员每个 lint 进程读取一次: 添加一个后重新启动编辑器的语言服务器 。 循环与 import/no-cycleKnip的死档案.

QQ 评论描述代码,而非其历史

// Updated to use the new pricing API    ❌ change narration (line comments)
// TODO: rename this contract            ❌ untracked
// TODO(#123): rename this contract      ✅ tracked (also CART-42 or a link)
/** Updated when the cache expires */    ✅ docblock describing behavior

QQ 块、 声明运行和退出站相隔

padding-line-between-statements 选择 ESLint 的选项( 列表 { blankLine, prev, next })及其语句类型. 一个声明上方的评论块属于它: 空白行位于注释上方,对行的评论则以该说明结尾. 自动插入或去除空白行.

function start(runtime) {
  const config = load();
  // Planning runs need no config.
  if (runtime.planning) {
    return;
  }
  runtime.apply(config); // ❌ twice: above the comment, and below the block
}

function start(runtime) {
  const config = load();

  // Planning runs need no config.
  if (runtime.planning) {
    return;
  }

  runtime.apply(config); // ✅
}

在没有选项的情况下启用,它应用了此配置; 任何选项全部替换:

{
  "core/padding-line-between-statements": [
    "error",
    { "blankLine": "always", "prev": "*", "next": ["block-like", "multiline-expression"] },
    { "blankLine": "always", "prev": ["block-like", "multiline-expression"], "next": "*" },
    { "blankLine": "always", "prev": ["const", "let"], "next": "*" },
    { "blankLine": "any", "prev": ["const", "let"], "next": ["const", "let"] },
    { "blankLine": "always", "prev": "*", "next": ["return", "throw"] }
  ]
}

* 移徙

登记的合同库存

从软件包导出 pnpm catalog. 规则特定选项和限制在上文和源测试中都有描述.

信用概念

• 马丁·福勒所著"在测试中消除非决定性"(概念)
• “生产中的试验逻辑”(G. Meszaros,xUnit测试模式)(概念)
• KeepCart/应用工具/工作空间界限(相同的作者;一般带有可配置应用程序和禁止进口矩阵)
• 代码由 Asyrafhussin (MIT,概念被重新执行)
• 由 Asyrafhussin (麻省理工学院,概念被重新执行) 所输入的代码- 关闭- 括号标签和占位符
• https://eslint.org/docs/latest/rules/padding-line-inter-statements 页面存档备份,存于互联网档案馆 (麻省理工学院;概念,独立实施)
• https://eslint.org/docs/latest/rules/padding-line-inter-statements 页面存档备份,存于互联网档案馆 (MIT;选项计划和语句类型,独立执行)