@devries-cameron20 / t3code Mirror · read-only
Fork 0

The best way to control Claude Code, Codex and more from any computer or phone

Mirrored from https://github.com/Camo67/t3code.git

Synced Nov 21, 07:15 UTC

main
md 1.39 KB

name: effect-development

description: Effect development guidance. Use when implementing or reviewing code that composes Effect APIs or patterns, or that adds or changes API signatures.

Use the repository's AI documentation as targeted reference, not ambient context:

  1. Identify the Effect APIs and concepts involved in the change.
  2. Search LLMS.md and ai-docs/src for those names and concepts, then read the matching sections and examples.
  3. Apply the relevant guidance and inspect nearby source and tests for any repository-internal conventions not covered by the documentation.

The task is ready for implementation when every material Effect API or pattern has matching local guidance, or the search has established that none exists.

API conventions

Write option types inline in the signature by default. Mark fields readonly and add | undefined to optional fields:

export const make = (options: {
  readonly capacity: number
  readonly strategy?: "dropping" | "sliding" | undefined
}): Effect.Effect<Queue> => ...

Declare a named options type only in these cases:

  • A substantial set of options is shared across several APIs, so a named type keeps them in sync.
  • The options type needs complex conditional logic, such as conditional or mapped types driven by type parameters.

A long option list for a single API is not on its own a reason to extract a named type.