tagged-error

legacy3 的头像作者 legacy3

生成Effect TaggedError类型用于错误处理。在添加新错误类型或改进错误处理时使用。

📖 中文导读:生成Effect TaggedError类型用于错误处理。在添加新错误类型或改进错误处理时使用。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: tagged-error description: Generate Effect TaggedError types for error handling. Use when adding new error types or improving error handling.

Tagged Error Generator

Generate Effect Data.TaggedError types following project conventions.

Error Location

packages/wowlab-core/src/internal/errors/Errors.ts

Basic Error Template

import * as Data from "effect/Data";

export class MyError extends Data.TaggedError("MyError")<{
  readonly message: string;
  readonly cause?: unknown;
}> {}

Error with Context

import * as Branded from "../schemas/Branded.js";
import * as Entities from "../entities/index.js";

export class SpellNotFound extends Data.TaggedError("SpellNotFound")<{
  readonly unitId: Branded.UnitID;
  readonly spellId: number;
}> {}

export class CastFailed extends Data.TaggedError("CastFailed")<{
  readonly reason: string;
  readonly spell: Entities.Spell.Spell;
  readonly caster?: Entities.Unit.Unit;
}> {}

Error Union Types

Group related errors:

export type RotationError =
  | NoChargesAvailable
  | SpellNotFound
  | SpellOnCooldown
  | UnitNotFound;

export type CombatLogError = QueueEmpty | HandlerError | EventValidationError;

Naming Conventions

  • Error class: {Thing}{Problem} - e.g., SpellNotFound, CastFailed
  • Tag: Same as class name
  • Include relevant context in payload (IDs, entities, messages)

Usage in Effects

import * as Errors from "@wowlab/core/Errors";

// Failing with error
yield *
  Effect.fail(
    new Errors.SpellNotFound({
      unitId,
      spellId,
    }),
  );

// In function signature
const cast = (
  spellId: number,
): Effect.Effect<CastResult, Errors.SpellNotFound | Errors.SpellOnCooldown> =>
  Effect.gen(function* () {
    // ...
  });

Instructions

  1. Identify what can fail
  2. Design payload with useful context
  3. Create error class with TaggedError
  4. Add to union type if applicable
  5. Update function signatures to include error