typescript-and-javascript
Typescript和JavaScript协议和代码风格
📖 中文导读:Typescript和JavaScript协议和代码风格 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: typescript-and-javascript description: Writes TypeScript and JavaScript code following best practices and style rules. Use when writing TS/JS code or reviewing code style.
TypeScript/JavaScript Protocol
Type Checking
When iterating solutions (not reviewing), run type check:
pnpm tsc --noEmit
# monorepo: cd apps/demo-app && pnpm tsc --noEmit
Code Block Types
- Pure TypeScript:
ts - TypeScript with JSX:
tsx
Style Rules
- Early returns over nested conditionals
- Named functions over arrows (except callbacks/one-liners)
- Strict equality:
===,!==only constfor non-mutated variablesasync/awaitover.then()- Never use
any— find specific types import typefor type-only imports- Always use curly braces for
if - Never barrel exports in index.ts (harms tree-shaking)
- Never write code in index.ts(x) — use specific names
satisfies neverin switch default for exhaustivenesssatisfies <Type>over type casting for traceability
Examples
// ✓ Early return
function process(data: Data | null) {
if (!data) {
return;
}
// process
}
// ✗ Nested
function process(data: Data | null) {
if (data) {
// process
}
}
// ✓ Named function
function add(a: number, b: number): number {
return a + b;
}
// ✓ One-liner arrow acceptable
const add = (a: number, b: number): number => a + b;
// ✗ Multi-line arrow
const add = (a: number, b: number): number => {
return a + b;
};
// ✓ Type imports
import type { MyType } from './types';
import { type ReactNode } from 'react';
// ✓ Exhaustiveness + satisfies
function factory(target: 'a' | 'b'): A | B | null {
switch (target) {
case 'a':
return new A();
case 'b':
return new B();
default:
target satisfies never;
return null;
}
}
// ✓ satisfies for traceability
const obj = { key: 'value' } satisfies Record<string, string>;
// ✗ Type casting loses inference
const obj: Record<string, string> = { key: 'value' };
// ✓ Always curly braces
if (!condition) {
return;
}
// ✗ No braces
if (!condition) return;