Cursor rule

1---
2description: "Code quality standards including TypeScript, testing, and formatting guidelines"
3globs: ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.jsx", "**/*.test.*", "**/*.spec.*"]
4alwaysApply: true
5---
6 
7# Code Quality Standards
8 
9Comprehensive code quality guidelines for the AI setup repository.
10 
11## Core Development Principles
12 
13### 1. TypeScript Guidelines
14- Use strict type checking
15- Define interfaces for all AI API responses
16- Use union types for AI model selections
17- Implement proper error type definitions
18 
19### 2. TypeScript Patterns
20```typescript
21// Define interfaces for AI responses
22interface AIResponse {
23  content: string;
24  model: string;
25  usage: {
26    prompt_tokens: number;
27    completion_tokens: number;
28  };
29}
30 
31// Use union types for model selection
32type AIModel = 'gpt-4' | 'gpt-3.5-turbo' | 'claude-3' | 'claude-2';
33```
34 
35### 3. React Best Practices
36- Use functional components with hooks
37- Implement proper cleanup for AI subscriptions
38- Use React.memo for expensive AI-powered components
39- Handle loading and error states consistently
40 
41### 4. Testing Patterns
42```javascript
43// Example AI component test pattern
44describe('AI Chat Component', () => {
45  it('handles API errors gracefully', async () => {
46    // Mock AI service failure
47    mockAIService.mockRejectedValue(new Error('API Error'));
48    
49    render(<ChatComponent />);
50    
51    // Test error handling and user feedback
52    expect(screen.getByText(/error/i)).toBeInTheDocument();
53  });
54});
55```
56 
57### 5. Error Handling Standards
58- Write comprehensive error handling and logging
59- Implement proper error boundaries for React components
60- Use custom error types for different failure scenarios
61- Provide meaningful error messages to users
62 
63### 6. Documentation Requirements
64- Document all AI-related functions and components
65- Include usage examples for AI integrations
66- Explain prompt engineering decisions
67- Document environment setup requirements
68 
69### 7. Code Style Guidelines
70- Write clean, readable, and well-documented code
71- Follow established linting and formatting rules
72- Write meaningful commit messages and documentation
73- Use descriptive variable and function names
74 
75### 8. API Development Standards
76- Follow RESTful principles for AI service endpoints
77- Implement proper rate limiting and authentication
78- Use middleware for common AI service operations
79- Document API endpoints with clear examples