Cursor rule

1---
2description: 
3globs: 
4alwaysApply: true
5---
6---
7description: TypeScript coding standards and best practices for modern web development
8globs: **/*.ts, **/*.tsx, **/*.d.ts
9---
10 
11# TypeScript Best Practices
12 
13## Type System
14- Prefer interfaces over types for object definitions
15- Use type for unions, intersections, and mapped types
16- Avoid using `any`, prefer `unknown` for unknown types
17- Use strict TypeScript configuration
18- Leverage TypeScript's built-in utility types
19- Use generics for reusable type patterns
20 
21## Naming Conventions
22- Use PascalCase for type names and interfaces
23- Use camelCase for variables and functions
24- Use UPPER_CASE for constants
25- Use descriptive names with auxiliary verbs (e.g., isLoading, hasError)
26- Prefix interfaces for React props with 'Props' (e.g., ButtonProps)
27 
28## Code Organization
29- Keep type definitions close to where they're used
30- Export types and interfaces from dedicated type files when shared
31- Use barrel exports (index.ts) for organizing exports
32- Place shared types in a `types` directory
33- Co-locate component props with their components
34 
35## Functions
36- Use explicit return types for public functions
37- Use arrow functions for callbacks and methods
38- Implement proper error handling with custom error types
39- Use function overloads for complex type scenarios
40- Prefer async/await over Promises
41 
42## Best Practices
43- Enable strict mode in tsconfig.json
44- Use readonly for immutable properties
45- Leverage discriminated unions for type safety
46- Use type guards for runtime type checking
47- Implement proper null checking
48- Avoid type assertions unless necessary
49 
50## Error Handling
51- Create custom error types for domain-specific errors
52- Use Result types for operations that can fail
53- Implement proper error boundaries
54- Use try-catch blocks with typed catch clauses
55- Handle Promise rejections properly
56 
57## Patterns
58- Use the Builder pattern for complex object creation
59- Implement the Repository pattern for data access
60- Use the Factory pattern for object creation
61- Leverage dependency injection
62- Use the Module pattern for encapsulation 
63 
64## Module Imports
65- **Always use namespace imports (`import * as name from '...'`).** This style ensures that the origin of any imported symbol is always explicit (e.g., `types.Comment` instead of just `Comment`), which improves code clarity and prevents naming conflicts. This aligns with standard practices in Go.
66- **Existing code using named imports (`import { ... } from '...'`) must be refactored to use namespace imports upon discovery.**
67