best-practices

A set of rules for writing TypeScript, a programming language that adds type checking to JavaScript.

In plain words
What is it for?
Use it when creating or reviewing TypeScript code, especially its configuration, types, imports, unions, and indexed values.
Why use it?
It keeps code consistent and helps prevent mistakes such as unsafe values, loose compiler settings, and unchecked data shapes.

Cursor rule

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/ofershap/typescript-best-practices/best-practices
Clone the repo
git clone --depth 1 https://github.com/ofershap/typescript-best-practices
Per session 174 This file is loaded in full into every session.
When invoked 174 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00174 $0.00174
Opus 5 $0.00087 $0.00087
Sonnet 5 $0.00035 $0.00035
Haiku 4.5 $0.00017 $0.00017

Measured 2d ago against content hash c1b77c66b6d8, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

best-practices scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

rules/best-practices.mdc · 15 lines

What it actually says

  • Always enable strict mode in tsconfig.json - never set strict: false
  • Use satisfies operator for type checking without widening - never use "as" for type assertions unless absolutely necessary
  • Prefer discriminated unions with a "type" or "kind" field over optional properties
  • Use unknown instead of any for values of uncertain type
  • Use import type for type-only imports
  • Add const assertions when literal types are needed (as const on arrays/objects)
  • Use exhaustive switch with never in default branch when handling union types
  • Prefer type predicates (x is T) over type assertions for runtime type checks
  • When noUncheckedIndexedAccess is enabled, always check for undefined before using indexed access results
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 15 lines · 174 tokens per session scan A c1b77c66b6d8

Subscribe to this mod's changes

best-practices is a cursor rule published in the GitHub repository ofershap/typescript-best-practices (9 stars, last pushed 6mo ago), licensed MIT. It adds 174 tokens to every session, about $0.0009 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.