home / skills / gentleman-programming / gentleman.dots / typescript
This skill helps you apply TypeScript strict patterns and best practices by promoting const-based enums, flat interfaces, and safe typing.
npx playbooks add skill gentleman-programming/gentleman.dots --skill typescriptReview the files below or copy the command above to add this skill to your agents.
---
name: typescript
description: >
TypeScript strict patterns and best practices.
Trigger: When writing TypeScript code - types, interfaces, generics.
license: Apache-2.0
metadata:
author: gentleman-programming
version: "1.0"
---
## Const Types Pattern (REQUIRED)
```typescript
// ✅ ALWAYS: Create const object first, then extract type
const STATUS = {
ACTIVE: "active",
INACTIVE: "inactive",
PENDING: "pending",
} as const;
type Status = (typeof STATUS)[keyof typeof STATUS];
// ❌ NEVER: Direct union types
type Status = "active" | "inactive" | "pending";
```
**Why?** Single source of truth, runtime values, autocomplete, easier refactoring.
## Flat Interfaces (REQUIRED)
```typescript
// ✅ ALWAYS: One level depth, nested objects → dedicated interface
interface UserAddress {
street: string;
city: string;
}
interface User {
id: string;
name: string;
address: UserAddress; // Reference, not inline
}
interface Admin extends User {
permissions: string[];
}
// ❌ NEVER: Inline nested objects
interface User {
address: { street: string; city: string }; // NO!
}
```
## Never Use `any`
```typescript
// ✅ Use unknown for truly unknown types
function parse(input: unknown): User {
if (isUser(input)) return input;
throw new Error("Invalid input");
}
// ✅ Use generics for flexible types
function first<T>(arr: T[]): T | undefined {
return arr[0];
}
// ❌ NEVER
function parse(input: any): any { }
```
## Utility Types
```typescript
Pick<User, "id" | "name"> // Select fields
Omit<User, "id"> // Exclude fields
Partial<User> // All optional
Required<User> // All required
Readonly<User> // All readonly
Record<string, User> // Object type
Extract<Union, "a" | "b"> // Extract from union
Exclude<Union, "a"> // Exclude from union
NonNullable<T | null> // Remove null/undefined
ReturnType<typeof fn> // Function return type
Parameters<typeof fn> // Function params tuple
```
## Type Guards
```typescript
function isUser(value: unknown): value is User {
return (
typeof value === "object" &&
value !== null &&
"id" in value &&
"name" in value
);
}
```
## Import Types
```typescript
import type { User } from "./types";
import { createUser, type Config } from "./utils";
```
## Keywords
typescript, ts, types, interfaces, generics, strict mode, utility types
This skill documents strict TypeScript patterns and best practices for defining types, interfaces, and generics. It focuses on maintainable, type-safe code: const-backed unions, flat interfaces, avoiding any, utility types, type guards, and import-time type syntax. Use it as a checklist when writing or reviewing TypeScript in strict mode.
Define runtime constant objects first and derive union types from them to keep a single source of truth and enable autocomplete. Keep interfaces flat by extracting nested shapes into their own interfaces. Replace any with unknown, type guards, or generics. Leverage built-in utility types and import types explicitly to keep type-only imports clear.
Why derive unions from const objects instead of writing string unions?
Deriving unions from const objects provides a single source of truth, preserves runtime values, enables autocomplete, and makes refactoring safer.
When should I use unknown vs generics?
Use unknown when input can be any external value and needs explicit runtime validation. Use generics when the type should be preserved and propagated across functions.