agentleFS
joaoguimaraesprojoaoguimaraespro/personal-finance/.cursor/rules/typescript-patterns.mdc

personal-finance / rules

Cursor rule1 starsChanged todayMITView on GitHub

TypeScript patterns: typed API client, result shapes, repository and adapter boundaries, discriminated unions

The file

We split this typescript-patterns.mdc into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    All calls to a backend go through one typed client module (a package in a monorepo).

    line 11

≈ “Common” is an estimate: at least 1 in 5 of the 6,809 Cursor rule files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
typescript-patterns.mdc
---
description: "TypeScript patterns: typed API client, result shapes, repository and adapter boundaries, discriminated unions"
globs: **/*.ts,**/*.tsx,**/*.mts,**/*.js,**/*.jsx
alwaysApply: false
---
<!-- Generated by armature from stack-typescript/rules/typescript/patterns.md. Edit the source rule, not this file. -->
# TypeScript patterns

## One typed API client

All calls to a backend go through one typed client module (a package in a monorepo). It sets headers, parses the
response with a schema, maps non-2xx responses to one error class, and handles `204 No Content`. Components and pages
never build URLs or parse responses themselves.

```typescript
export class ApiError extends Error {
  constructor(readonly status: number, readonly code: string, message: string) {
    super(message)
  }
}
```

## Discriminated unions for state

Model states that exclude each other as a union, not as a bag of optional flags.

```typescript
type Load<T> =
  | { status: 'idle' }
  | { status: 'loading' }
  | { status: 'ready'; data: T }
  | { status: 'error'; error: ApiError }
```

Switch on the discriminant and let the compiler check exhaustiveness (`const _never: never = state`).

## Adapters around third-party libraries

A library that may be replaced (chat SDK, charting, analytics, auth client) is used only inside one adapter folder.
The rest of the code depends on our own types, so a switch touches one folder.

## Repository interface for data access

```typescript
interface Repository<T, Id = string> {
  findById(id: Id): Promise<T | null>
  list(filter?: Partial<T>): Promise<T[]>
  create(input: Omit<T, 'id'>): Promise<T>
  update(id: Id, patch: Partial<T>): Promise<T>
  delete(id: Id): Promise<void>
}
```

## Shared types live once

Types shared by several apps or packages live in one types package (or are generated from the API's OpenAPI
document) and are imported, never copied.

<!-- Adapted from affaan-m/ECC rules/typescript/patterns.md (MIT) at d2ef268; merged with the owner's conventions (ordo-frontend api-client and types packages, ai-industry adapter folder rule). -->

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.