typescript

Coding rules for a TypeScript project running on Node.js, including how to write imports, types, asynchronous code, and errors.

In plain words
What is it for?
Use it when adding or changing TypeScript code in Textrawl, especially imports, type definitions, data validation, asynchronous operations, and error reporting.
Why use it?
They keep code consistent and prevent runtime failures caused by incompatible imports, unsupported Node.js features, or inconsistent error handling.

Cursor rule for Cursor

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/jeffgreendesign/textrawl/typescript
Clone the repo
git clone --depth 1 https://github.com/jeffgreendesign/textrawl

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 279 The whole file, excluding the scripts and references it only reads on demand.
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.00000 $0.00279
Opus 5 $0.00000 $0.00139
Sonnet 5 $0.00000 $0.00056
Haiku 4.5 $0.00000 $0.00028

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

Security

Grade A, and why

typescript 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 yesterday.

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.

.cursor/rules/typescript.mdc · 58 lines

What it actually says

TypeScript Conventions

ESM Imports

This is an ES module project. All imports MUST use .js extensions:

// Correct
import { logger } from '../utils/logger.js';
import { hybridSearch } from '../db/search.js';

// Wrong - will fail at runtime
import { logger } from '../utils/logger';

Node.js Version

Requires Node.js >= 22.0.0. Use modern APIs:

  • fetch (native, no node-fetch)
  • Top-level await in modules
  • ES2023+ features

Type Definitions

  • Define types in src/types/ directory
  • Export types from module index files
  • Use Zod for runtime validation, infer types with z.infer<>

Async/Await

Always use async/await over raw promises:

// Correct
const result = await someAsyncOperation();

// Avoid
someAsyncOperation().then(result => { ... });

Error Handling

Use custom error hierarchy from src/utils/errors.ts:

import { NotFoundError, ValidationError } from '../utils/errors.js';

if (!document) {
  throw new NotFoundError('Document not found');
}
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. yesterday First seen · 58 lines · 0 tokens per session scan A ee8e5e3c026d

Subscribe to this mod's changes

typescript is a cursor rule published in the GitHub repository jeffgreendesign/textrawl (5 stars, last pushed 29d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 279 tokens. 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.