.cursorrules (deprecated)

1# Project: Vitest Unit Testing Framework
2 
3## Framework Structure
4- Use Vitest as the primary test runner for Vite-based projects
5- Organize tests alongside source files or in dedicated __tests__ directories
6- Use TypeScript for type-safe test implementations
7- Leverage Vite's native ESM support for fast test execution
8 
9## Coding Standards
10- Follow JavaScript/TypeScript best practices
11- Use meaningful test and variable naming
12- Implement clean code principles
13- Limit describe block nesting to 3 levels maximum
14 
15## Test Organization
16- Group related tests using describe blocks
17- Use it/test functions for individual test cases
18- Implement beforeEach/afterEach for setup and teardown
19- Separate unit, integration, and component tests into distinct directories
20 
21## Best Practices
22- Follow Arrange-Act-Assert (AAA) pattern
23- Write focused, single-responsibility tests
24- Avoid test interdependencies and shared mutable state
25- Use vi.fn() for mocking instead of manual mocks
26- Leverage in-source testing for utility functions when appropriate
27 
28## Mocking Strategies
29- Use vi.mock() for module-level mocking
30- Implement vi.spyOn() for method-level spying
31- Use vi.useFakeTimers() for time-dependent tests
32- Mock HTTP requests with msw (Mock Service Worker) or vi.mock()
33- Restore mocks after each test with vi.restoreAllMocks()
34 
35## Assertions
36- Use expect() with specific, descriptive matchers
37- Implement custom matchers for domain-specific assertions
38- Use toMatchSnapshot() for stable UI component output testing
39- Prefer toEqual for deep equality over toBe for object comparisons
40 
41## Coverage
42- Configure coverage with v8 or istanbul provider
43- Set meaningful coverage thresholds (statements, branches, functions, lines)
44- Use exclude patterns for generated or non-testable code
45- Generate HTML reports for local visualization
46 
47## Performance
48- Use it.concurrent for independent parallel tests
49- Implement proper test isolation to enable safe parallel execution
50- Minimize unnecessary setup/teardown operations
51- Configure poolOptions for optimal worker usage
52 
53## Component Testing
54- Use @vitest/browser for browser-based component tests
55- Integrate with Testing Library (@testing-library/vue, /react, /svelte) for user-centric assertions
56- Mock child components only when testing in isolation is critical
57- Snapshot test stable, presentational components
58 
59## Test Data Management
60- Use factory functions or fixtures for reusable test data
61- Define TypeScript types for all test data structures
62- Avoid hardcoded magic values; use named constants
63- Generate dynamic or random data with @faker-js/faker when needed
64 
65## CI/CD Integration
66- Configure reporters for CI environments (--reporter=verbose or junit)
67- Use --reporter=junit for CI pipeline compatibility
68- Enable test result caching with vitest cache
69- Upload coverage reports to services like Codecov or SonarQube
70 
71## Environment Configuration
72- Use environment-specific vitest.config files
73- Configure test globals (describe, it, expect) via globals: true
74- Handle environment variables with dotenv integration
75- Use setupFiles for global test setup and teardown logic
76 
77## Error Handling
78- Test both success and failure code paths
79- Assert on specific error messages and types
80- Use expect().rejects for async error assertions
81- Implement retry logic tests for flaky network operations
82 
83## Documentation
84- Document complex test scenarios with brief inline comments
85- Maintain a test helper and fixture README
86- Include examples for custom matchers
87- Document project-specific mock strategies
88 
89Remember to leverage Vitest's native Vite integration and HMR-based watch mode for fast, reliable unit testing.
90