AGENT SKILL

typescript-best-practices

TypeScript best practices. Use when reading or editing any .ts or .tsx file.

License 许可
MIT
所属仓库
am-will/gooey-pi
最近更新
2026-10-25
Stars
★ 974
Forks
87

01 前言 Front Matter

name
typescript-best-practices
description
TypeScript best practices. Use when reading or editing any .ts or .tsx file.

02 资源文件 1

03 SKILL.md 正文

TypeScript best practices

Apply the type-system-discipline principle skill first; this skill grounds it in TypeScript syntax.

Rule Summary
Discriminated unions Model variants with a kind literal discriminant so impossible states can't be represented. No optional-field bags.
Branded types Brand primitives with & { readonly __brand: "X" } so they can't be mixed up. Validate once at creation.
Constructive modeling Build the shape so the illegal value can't be constructed. [T, ...T[]] for non-empty, [T, T][] for even length, start plus duration for a range. Not a runtime guard, not a wish for refinement types.
Simplest total type Keep T[] while every operation on it stays total. Strengthen to NonEmpty<T> only where the loose type forces !, a cast, or a "should never happen" throw.
unknown over any External data is unknown. any disables type checking everywhere it touches.
No as casts Every as is a runtime crash waiting. Cast only after validation.
Narrowing hierarchy Discriminant switch > in operator > typeof/instanceof > user-defined type guard > as.
Type guards Must verify the claim. A lying guard is worse than as because the bug hides behind a name that says it's safe. Name them isX or hasX.
Exhaustiveness Inline const _exhaustive: never = x; in default arms so the compiler errors when a new variant is added.
satisfies over as Validates the value without widening literal types.
Boundary validation Parse where data crosses in, into a named domain type. Record<string, unknown> (however spelled) stops at that parse. Trust types inside. See the boundary-discipline principle skill.
Schema-derived types Reach for Pick/Omit/Parameters/ReturnType/Awaited/typeof before declaring a new interface.
Object args Pass objects, not positional, so argument order is self-documenting. Skip on hot paths (per-frame render, tokenizers, parsers).
Real tests Don't mock what you can run. Prefer the framework's real test primitives with leak/disposable checks, and verify UI in a running build. Mock only what you can't run locally.
Structured telemetry Prefer structured logger diagnostics with enough context to debug from an id. No console.log in shipped code.

Examples: references/patterns.md.

04 同仓库更多 Skills

am-will
am-will/gooey-pi

prime-work-schedules

Create, inspect, edit, pause, resume, run, and delete durable GooeyPi scheduled tasks. Use when the user asks to schedule recurring or one-time work in the current project or thread. Use rlm-heartbeat instead for temporary internal polling while actively working.

★ 974
am-will
am-will/gooey-pi

prime-work-browser

Drive the GooeyPi in-app browser for this thread with the browser_* tools - open tabs, navigate, read pages, click, type, scroll, screenshot, and extract data. Use when the user asks to open, test, inspect, or interact with a website or a local dev server inside GooeyPi.

★ 974
am-will
am-will/gooey-pi

gooeypi-computer-use

Drive native applications on macOS, Windows, or Linux through the separately installed TryCUA driver CLI.

★ 974
am-will
am-will/gooey-pi

verify-gooeypi

Launch and drive the GooeyPi desktop (Electron) app to prove user-facing behavior — sidebar navigation, Settings, and Capabilities — capturing screenshots and ARIA snapshots. Reach for this when verifying a GooeyPi UI change or confirming the app still works end to end.

★ 974
am-will
am-will/gooey-pi

review-pr-viability

Review a pull request or issue for value, implementation quality, maintainability, regression risk, and reliance on upstream changes.

★ 974
am-will
am-will/gooey-pi

why

Use for 'why does X work this way', 'why we picked Y', design rationale, regressions, postmortems, or data-backed thresholds. Discovers available MCPs and queries each evidence category (source control, issue tracker, long-form docs, real-time chat, infrastructure observability, error tracking, product analytics warehouse) in parallel, then returns a cited read on decisions and tradeoffs. Use how for runtime behavior.

★ 974