@aureienbn/克林特-插座效应

42 oxlint规则的效应代码:运行时边界,故障通道,通币,服务,Schema. 只不过什么 @effect/tsgo 不拥有.

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

{
  "jsPlugins": ["@aurelienbbn/oxlint-plugin-effect"],
  "rules": {
    "effect/require-all-concurrency": "error",
    "effect/require-tagged-effect-fail": "error",
    "effect/no-run-promise-in-runtime": ["error", { "allow": ["**/src/main.ts"] }]
  }
}

没有预设: 启用每个规则的名称 .

第一个上游, 第二个插件

@effect/tsgo recommended oxlint preset   ← enable FIRST, wins every overlap (type-aware)
  floating Effects · missing yield* / return yield* · Effect-native globals & JSON
  Effect.fn opportunities · try/catch and timers in generators · class Self mismatch
        +
withEffectTsgoLayer extras               ← @aurelienbbn/oxlint-config; off in recommended
  any/unknown in error & requirements channels · unsafe Effect type assertions
  deterministic service/error keys · Effect.provide outside entry points
        │
        ▼
@aurelienbbn/oxlint-plugin-effect        ← policies and syntactic failure modes tsgo doesn't own

带线的 withEffectTsgoLayer 从 @aurelienbbn/oxlint-config:它添加了四个外加,并在一个表格中解决与这个插件的所有重叠. 注意其版本锁定 : @effect/tsgo 0.45.0只接受牛林1.81.0/1.82.0和牛林-tsgolint 7.0.2001.

取决于类型的结论保持不变 @effect/tsgo。 。 。 . 所有权: docs/rule-ownership.md;目录门执行盘点.

什么火吗

const values = Effect.all(programs); // ❌ require-all-concurrency
const values = Effect.all(programs, { concurrency: 1 }); // ✅ explicit choice

const program = Effect.fail("boom"); // ❌ require-tagged-effect-fail
const program = Effect.fail(new DomainError({ reason })); // ✅ tagged error

const load = (id: string) => Effect.fn(`users.load.${id}`)(body); // ❌ no-dynamic-span-name
const load = Effect.fn("users.load")(body); // ✅ ids go in span attributes

class NotFound extends Schema.TaggedError<NotFound>()("Missing", {}) {} // ❌ tagged-error-name, twice
class NotFoundError extends Schema.TaggedError<NotFoundError>()("NotFoundError", {}) {} // ✅ catchTag greps to the class

const Status = Schema.Literals(["Pending", "partially-refunded"]); // ❌ schema-literal-case, twice
const Status = Schema.Literals(["pending", "partially_refunded"]); // ✅ one case on the wire

// orders/domain/order.ts
export interface Order {
  readonly id: OrderId;
} // ❌ schema-domain-types
export const Order = Schema.Struct({ id: OrderId }); // ✅ the schema owns the shape
export type Order = typeof Order.Type;
const Concurrency = Schema.Int.pipe(Schema.check(Schema.isGreaterThanOrEqualTo(1))); // ❌ schema-check-branded
const Concurrency = Schema.Int.pipe(Schema.check(Schema.isGreaterThanOrEqualTo(1)), Schema.brand("Concurrency")); // ✅ only make or a decode builds one

const sync = Effect.fn("OrderSync.run")(body); // ❌ telemetry-name-format
const sync = Effect.fn("orders.sync")(body); // ✅ <area>.<operation>, lowercase snake_case

Effect.tryPromise(() => fetch(url)); // ❌ no-untyped-try-promise-catch, require-abort-signal
Effect.tryPromise({
  try: (signal) => fetch(url, { signal }),
  catch: (cause) => new HttpError({ cause }), // ✅ typed, cause kept, signal forwarded
});

• 货币规则要求明确选择他们不主张省略的货币没有约束.
• 一样 allow 路径 no-run-promise-in-runtime 财务报告和审定财务报表 no-unscoped-runtime-launch数字 : 共享边界匹配 .
• tagged-error-name 与tsgo冲突 deterministic-keys 只有在tsgo的时候 keyPatterns 获得一个 error 目标:该目标需要一个符合软件包资格的标签(pkg/file/NotFoundError) (中文(简体) ). 避免出错 keyPatterns,或关闭此规则.
• schema-literal-case 保留 Schema.Literals([...]) 数值,默认为蛇 大小写: 他们作为数据旅行(URLs,SQL,日志,电线合同),而蛇-case就是Postgres, Shopify REST(partially_refunded)和条纹(requires_payment_method(a) 使用. Schema.Literal("..."), (中文(简体) ), _tags和非字符串的字句超出了范围。 无修:重命名一线值需要协调改变.
• schema-domain-types 创建一个仅包含Schema的域文件夹 : 内 **/domain/** (选项) files),一个接口,一个对象类型(空白,在 Readonly<>(a) 在工会或交叉点,报告立体工会或圆柱 Schema.Struct, (中文(简体) ), Schema.TaggedStruct, (中文(简体) ), Schema.Union 或者说 Schema.Literals 并获得类型 typeof X.Type. 沉默:通用声明、持有行为的声明(方法、功能类型成员)或运行时的手柄(Schema.*, (中文(简体) ), Effect.*, (中文(简体) ), Layer.*, (中文(简体) ), Stream.* 成员),命名类型的联盟,以及一个能扩展出一个计划类型的空界面. 不修:计是决定.
• schema-check-branded 在类型中设置域检查 : 当一个值被解码、编码或构建时,检查才运行 make,所以没有品牌代码仍然可以写 { concurrency: 0 }内 **/domain/** (选项) files页:1 Schema.check(...) 或者说 .check(...) 连锁店都没有 Schema.brand 报告。 一个有线DTO不需要品牌(解码和编码两个都检查),所以规则默认不在其他文件夹中;内置的用法如实使用(英语:Schema.Int, (中文(简体) ), Schema.NonEmptyString不是它看到的检查。 一个只长出(attempts + 1)是通常的例外:压制它在那里.
• telemetry-name-format 想要索引名称为 <area>.<operation> 小写点蛇 case (单位:千美元)mcp.auth.verify_api_key: 横跨地名, Rpc.make 标记和 annotateLogs, (中文(简体) ), annotateSpans, (中文(简体) ), annotateCurrentSpan 财务报告和审定财务报表 withSpan是因为 attributes (允许一段: event) (中文(简体) ). 仅字符串; no-dynamic-span-name 拥有运行时间名称.
• telemetry-name-format 与 logMessages: true 将日志消息作为事件名 : 第一个论点是: Effect.log, (中文(简体) ), logTrace, (中文(简体) ), logDebug, (中文(简体) ), logInfo, (中文(简体) ), logWarning, (中文(简体) ), logError 财务报告和审定财务报表 logFatal (通过) Effect,别名,或从 effect/Effect)必须是名称格式的文字,如 Effect.logInfo("webhook.rejected", { attempt }),因此日志后端可以搜索并按它数. 变量、带有值或连结的模板也被报告: 值进入后面的参数或 Effect.annotateLogs。 。 。 .
• 启用 telemetry-name-format 或者说 effect-fn-name-matches-binding,而不是两者: 约束性规则将最后一段与约束性相联系(const syncAll = Effect.fn("orders.syncAll")),蛇 案例拒绝.
• 🎨 dependencies-first, (中文(简体) ), padding-after-dependencies, (中文(简体) ), no-switch, (中文(简体) ), prefer-match, (中文(简体) ), prefer-effect-array-helpers, (中文(简体) ), schema-type-adjacent, (中文(简体) ), schema-literal-case, (中文(简体) ), schema-domain-types, (中文(简体) ), schema-check-branded, (中文(简体) ), tagged-error-name, (中文(简体) ), telemetry-name-format 有意见. 在特殊呼叫地点进行镇压,而不是在共享配置中.

1个自定义, 5个建议

仅 padding-after-dependencies 有一个保留行为重写: 在主要服务依赖关系下插入空白行。 每个其它的固定需要项目知识:出错类型,运行时边界,货币政策,层所有者,追踪名称,平台适配器.

Effect.gen(function* () {
  const repo = yield* UserRepo;
  const user = yield* repo.findUser(id); // ❌ padding-after-dependencies
});

Effect.gen(function* () {
  const repo = yield* UserRepo;

  const user = yield* repo.findUser(id); // ✅ dependencies stand apart
});

移徙

合同

登记的合同库存

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

信用概念

• 效果捆绑 AGENTS.md “名称字符串应该与函数名称相匹配”(概念)
• 效果捆绑的 AI- docs “ 被紧扣的指数倒置, 并带有紧张和最大尝试” 模式( 概念)
• 效果捆绑的辅助文件 04_integration/10_managed-runtime.ts 模块级别运行时间(概念)
• 效果捆绑的辅助文件 09_testing/10_effect-tests.ts "用TestClock控制时间"(概念)
• 效果捆绑的辅助文件 catch: (cause) => new X({ cause }) 公约(概念)
• OpenTeleometry Tracking API规格,横跨名称指导"最普通的字符串. 低红度"(Apache-2.0,概念)
• 由Sandro Maglione(启发、独立重新执行)自动操作
• 由Dillon Mulroy(麻省理工学院,概念重新实施)
• 斯林特-插孔-独角兽 no-array-callback-reference (MIT;规则概念,独立地重新执行)
• 斯林特-插孔-独角兽 no-array-for-each (MIT;规则概念,独立地重新执行)
• 斯林特-插孔-独角兽 no-array-method-this-argument (MIT;规则概念,独立地重新执行)
• 斯林特-插孔-独角兽 no-array-sort (MIT;规则概念,独立地重新执行)
• 由 Rhys Sullivan 执行器, 点缀的蛇 case 跨度和属性名称, 例如 mcp.auth.verify_api_key (MIT,命名风格的灵感)