Cursor rule

1---
2description: TypeScript code style standards
3globs: web/src/**/*.ts
4alwaysApply: false
5---
6 
7# Code Style
8 
9## Clarity Above All
10 
11- Variable, function, and class names must be self-explanatory
12- Avoid obscure abbreviations. Prefer `calculateTotalGain` over `calcTG`
13- Small functions with a single responsibility (< 30 lines ideally)
14- No unnecessary comments. The code should explain itself
15 
16```typescript
17// ❌ Bad: comment that repeats the code
18// Calculate the total gain
19const totalGain = this.calculateTotalGain(positions);
20 
21// ✅ Good: self-explanatory name, no comment needed
22const totalGain = this.calculateTotalGain(positions);
23```
24 
25## When to Comment
26 
27Comment only:
28- Non-obvious business decisions (e.g., a specific tax rule)
29- Temporary workarounds with a link to the issue
30- Public interfaces (concise JSDoc)
31 
32## Strict TypeScript
33 
34- `strict: true` is active. Never use `any` (ESLint rule enforced)
35- Use discriminated unions instead of boolean flags
36- Prefer `readonly` for immutable properties
37- Use `interface` for contracts, `type` for unions and utility types
38 
39```typescript
40// ❌ Bad
41function process(data: any): any { ... }
42 
43// ✅ Good
44function processOperations(operations: readonly Operation[]): PortfolioSnapshot { ... }
45```
46 
47## Conventions
48 
49- Imports use the `@/` alias for `src/`
50- One main class/type per file
51- Files named after the class/type they export
52- Private methods prefixed with clear purpose, not underscore
53