effect-ts
Skill5 starsChanged 4 months agoMITView on GitHub
Write idiomatic Effect v4 TypeScript following official best practices from effect-solutions and the Effect source. Use when writing, reviewing, or refactoring Effect code: services (ServiceMap.Service), layers and dependency injection, error handling (Schema.TaggedErrorClass), data modeling (Schema.Class, branded types, variants), testing (@effect/vitest), HTTP clients (effect/unstable/http), CLI tools (effect/unstable/cli), config, observability, and project setup. Triggers on: 'Effect', 'effect-ts', '@effect/', 'Schema', 'ServiceMap', 'Layer', 'Effect.gen', 'Effect.fn', 'TaggedError', 'branded types', or any Effect-TS related code.
- Reads credentials
17 other projects use a version of this, 1 of them edited.
Adopted by
Most recently taken up by
- PaulRBerg/agent-skillstheir own version, first seen Nov 13, 2026
- Scrapybara/agent-skillstheir own version, first seen Nov 8, 2026
- PaulRBerg/dot-agentstheir own version, first seen Nov 6, 2026
- LodyAI/Lodytheir own version, first seen Oct 17, 2026
- c15t/c15ttheir own version, first seen Oct 17, 2026
- malinskibeniamin/skillstheir own version, first seen Oct 17, 2026
Used with
Projects with it also use shadcn, web-design-guidelines and 1 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
DatabricksSkillshadcn
Manages shadcn components and projects — adding, searching, fixing, debugging, styling, and composing UI. Provides project context, component docs, and usage examples. Applies when working with shadcn/ui, component registries, presets, --preset codes, or any project with a components.json file. Also triggers for "shadcn init", "create an app with --preset", or "switch to --preset".
Also in 3 projects that use this
VercelSkillweb-design-guidelines
Review UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "check accessibility", "audit design", "review UX", or "check my site against best practices".
Also in 3 projects that use this
GoogleSkillgrill-me
A relentless interview to sharpen a plan or design.
Also in 3 projects that use this
Other versions17 projects use a version of this.
Word for word · 0
None found.
Edited · 1
- joelhooks/effectts-skills★ 4386% same
Wrote their own version · 16
- c15t/c15t★ 2ksame name
- LodyAI/Lody★ 1.7ksame name
- pedronauck/skills★ 655same name
- arcboxlabs/linkcode★ 147same name
- Effect-TS/skills★ 110same name
- PaulRBerg/agent-skills★ 104same name
- Kastalien-Research/thoughtbox★ 64same name
- Kastalien-Research/thoughtbox-dot-claude★ 9same name
- PaulRBerg/dot-agents★ 6same name
- anis-dr/skills★ 4same name
6 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository10 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- brandkitSkill
- design-taste-frontendSkill
- effect-best-practicesSkill
- effect-reviewSkill
- imagegen-frontend-webSkill
- logging-best-practicesSkill
- panelSkill
- worktree-setupSkill
The file
We split this skill into the rules it gives an agent
7 rules. 0 are common, 0 are distinctive, and 7 are very specific to this project.
0
Common
Most of the 17 edited versions we read keep these.
0
Distinctive
This author's own choices. Worth a look.
7
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 14
Search source for implementations: grep -r "pattern" ./references/effect/packages/effect/src/
- Very specific: line 107
Use Schema.Class for domain records.
- Very specific: line 131
Use Schema.TaggedClass + Schema.Union for variants (OR types):
- Very specific: line 217
Use Layer.sync for synchronous implementations, Layer.effect for effectful ones
- Very specific: line 234
Use it.effect for Effect-based tests (provides TestContext with TestClock)
- Very specific: line 235
Use it.live for real time / real clock
- Very specific: line 237
Use it.layer only when sharing expensive resources across a suite
“Common” is measured: kept by at least 6 in 10 of the 17 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Effect-TS (v4)
Patterns from effect-solutions and the Effect source. This covers the latest v4 APIs.
Local Source References
- effect-solutions (best practices, docs, examples):
./references/effect-solutions/ - effect monorepo (canonical source for all
@effect/*packages):./references/effect/ - Search source for implementations:
grep -r "pattern" ./references/effect/packages/effect/src/
Effect.gen and Effect.fn
Effect.gen provides sequential, readable composition (like async/await for Effect):
import { Effect } from "effect"
const program = Effect.gen(function* () {
const data = yield* fetchData
yield* Effect.logInfo(`Processing: ${data}`)
return yield* processData(data)
})Effect.fn adds call-site tracing and named spans. Use for all service methods:
const processUser = Effect.fn("processUser")(function* (userId: string) {
yield* Effect.logInfo(`Processing user ${userId}`)
const user = yield* getUser(userId)
return yield* processData(user)
})
// Second argument for cross-cutting concerns (retry, timeout)
const fetchWithRetry = Effect.fn("fetchWithRetry")(
function* (url: string) {
const data = yield* fetchData(url)
return yield* processData(data)
},
flow(
Effect.retry(Schedule.recurs(3)),
Effect.timeout("5 seconds")
)
)ServiceMap.Service
Define services as classes with a unique tag and typed interface:
import { Effect, ServiceMap } from "effect"
class Database extends ServiceMap.Service<
Database,
{
readonly query: (sql: string) => Effect.Effect<unknown[]>
readonly execute: (sql: string) => Effect.Effect<void>
}
>()("@app/Database") {}Implement with Layer.effect or Layer.sync, using Effect.fn for all methods:
import { Effect, Layer } from "effect"
class Users extends ServiceMap.Service<
Users,
{
readonly findById: (id: UserId) => Effect.Effect<User, UserNotFoundError>
readonly all: () => Effect.Effect<readonly User[]>
}
>()("@app/Users") {
static readonly layer = Layer.effect(
Users,
Effect.gen(function* () {
const http = yield* HttpClient.HttpClient
const findById = Effect.fn("Users.findById")(function* (id: UserId) {
const response = yield* http.get(`/users/${id}`)
return yield* HttpClientResponse.schemaBodyJson(User)(response)
})
const all = Effect.fn("Users.all")(function* () {
const response = yield* http.get("/users")
return yield* HttpClientResponse.schemaBodyJson(Schema.Array(User))(response)
})
return { findById, all }
})
)
}Rules:
- Tag identifiers must be unique. Use
@app/ServiceNamepattern - Service methods should have
R = never(dependencies via Layer, not method signatures) - Use
readonlyproperties
See references/services-and-layers.md for service-driven development, test layers, layer memoization, and full composition patterns.
Schema.Class and Branded Types
Use Schema.Class for domain records. Brand all entity IDs and domain primitives:
import { Schema } from "effect"
const UserId = Schema.String.pipe(Schema.brand("UserId"))
type UserId = typeof UserId.Type
const Email = Schema.String.pipe(Schema.brand("Email"))
type Email = typeof Email.Type
class User extends Schema.Class("User")({
id: UserId,
name: Schema.String,
email: Email,
createdAt: Schema.Date,
}) {
get displayName() { return `${this.name} (${this.email})` }
}
// Construct with makeUnsafe for brands
const userId = UserId.makeUnsafe("user-123")Use Schema.TaggedClass + Schema.Union for variants (OR types):
import { Match, Schema } from "effect"
class Success extends Schema.TaggedClass("Success")("Success", {
value: Schema.Number,
}) {}
class Failure extends Schema.TaggedClass("Failure")("Failure", {
error: Schema.String,
}) {}
const Result = Schema.Union([Success, Failure])
type Result = typeof Result.Type
// Exhaustive pattern matching
const render = (r: Result) => Match.valueTags(r, {
Success: ({ value }) => `Got: ${value}`,
Failure: ({ error }) => `Error: ${error}`,
})See references/data-modeling.md for JSON encoding, Schema.Literals, validation, and full patterns.
Schema.TaggedErrorClass
Define domain errors with Schema.TaggedErrorClass. They are yieldable (no Effect.fail needed):
import { Schema } from "effect"
class UserNotFoundError extends Schema.TaggedErrorClass("UserNotFoundError")(
"UserNotFoundError",
{ userId: UserId, message: Schema.String }
) {}
// Yieldable: yield directly in generators
const getUser = Effect.fn("getUser")(function* (id: UserId) {
const user = yield* findUser(id)
if (!user) yield* new UserNotFoundError({ userId: id, message: "Not found" })
return user
})Recover with catchTag / catchTags:
// Single tag
const recovered = program.pipe(
Effect.catchTag("UserNotFoundError", (e) =>
Effect.succeed(`User ${e.userId} missing`)
)
)
// Multiple tags
const recovered2 = program.pipe(
Effect.catchTags({
UserNotFoundError: (e) => Effect.succeed("not found"),
ValidationError: (e) => Effect.succeed("invalid"),
})
)See references/error-handling.md for defects, Schema.Defect, and recovery patterns.
Layer Composition
Compose layers with Layer.provideMerge (incremental, flat types) and Layer.merge (parallel):
import { Effect, Layer } from "effect"
// Compose layers for the app
const appLayer = UserService.layer.pipe(
Layer.provideMerge(DatabaseLayer),
Layer.provideMerge(LoggerLayer),
Layer.provideMerge(ConfigLayer),
)
// Provide once at the entry point
const main = program.pipe(Effect.provide(appLayer))
Effect.runPromise(main)Key rules:
- Store parameterized layers in constants (layer memoization by reference identity)
- Provide once at app entry, not scattered throughout code
- Use
Layer.syncfor synchronous implementations,Layer.effectfor effectful ones
Testing Quick Start
import { describe, expect, it } from "@effect/vitest"
import { Effect, Layer } from "effect"
it.effect("queries database", () =>
Effect.gen(function* () {
const db = yield* Database
const results = yield* db.query("SELECT *")
expect(results.length).toBe(2)
}).pipe(Effect.provide(Database.testLayer))
)- Use
it.effectfor Effect-based tests (provides TestContext with TestClock) - Use
it.livefor real time / real clock - Provide fresh layers per test to prevent state leakage
- Use
it.layeronly when sharing expensive resources across a suite
See references/testing.md for the full worked example and advanced patterns.
Pipe for Instrumentation
const program = fetchData.pipe(
Effect.timeout("5 seconds"),
Effect.retry(Schedule.exponential("100 millis").pipe(
Schedule.compose(Schedule.recurs(3))
)),
Effect.tap((data) => Effect.logInfo(`Fetched: ${data}`)),
Effect.withSpan("fetchData"),
)Anti-Patterns
| Do Not | Do Instead |
console.log(...) | Effect.log(...) with structured data |
process.env.KEY | Config.string("KEY") or Config.redacted("KEY") |
throw new Error() inside Effect.gen | yield* new TaggedError({...}) or Effect.fail(...) |
Effect.runSync(...) inside services | Keep everything effectful |
Effect.catchAll(() => ...) losing type info | Effect.catchTag / Effect.catchTags |
null / undefined in domain types | Option<T> with Option.match |
Option.getOrThrow(...) | Option.match({ onNone, onSome }) or Option.getOrElse |
Effect.Service (v3) | ServiceMap.Service (v4) |
Schema.TaggedError<T>() (v3) | Schema.TaggedErrorClass("Tag")("Tag", {...}) (v4) |
Scatter Effect.provide calls | Provide once at app entry |
| Call parameterized layer constructors inline | Store layers in constants (memoization) |
Reference Files
Load these as needed for deeper patterns:
- Services & Layers: ServiceMap.Service, service-driven development, test layers, layer memoization, provide vs provideMerge
- Data Modeling: Schema.Class, branded types, variants, Match.valueTags, JSON encoding
- Schema Decisions: Schema.Class vs Struct vs TaggedClass decision flowchart, migration patterns
- Error Handling: Schema.TaggedErrorClass, catch/catchTag/catchTags, defects, Schema.Defect, TypeId/refail patterns
- Testing: @effect/vitest setup, it.effect/it.live/it.layer, TestClock, Effect.flip, FiberRef isolation, worked example
- HTTP Clients: HttpClient, request building, response decoding, middleware, retries, typed API service
- CLI: Command.make, Arguments, Flags, subcommands, worked task manager example
- Config: Config module, schema validation, ConfigProvider, Redacted, config layers
- Processes & Scopes: Fork types, Scope.extend, Command for child processes, killable background tasks
- Setup: tsconfig, Effect Language Service, project structure, module settings
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

