.cursorrules (deprecated)

1// Android Jetpack Compose .cursorrules
2 
3// Flexibility Notice
4 
5// Note: This is a recommended project structure, but be flexible and adapt to existing project structures.
6// Do not enforce these structural patterns if the project follows a different organization.
7// Focus on maintaining consistency with the existing project architecture while applying Jetpack Compose best practices.
8 
9// Project Architecture and Best Practices
10 
11const androidJetpackComposeBestPractices = [
12    "Adapt to existing project architecture while maintaining clean code principles",
13    "Follow Material Design 3 guidelines and components",
14    "Implement clean architecture with domain, data, and presentation layers",
15    "Use Kotlin coroutines and Flow for asynchronous operations",
16    "Implement dependency injection using Hilt",
17    "Follow unidirectional data flow with ViewModel and UI State",
18    "Use Compose navigation for screen management",
19    "Implement proper state hoisting and composition",
20];
21 
22// Folder Structure
23 
24// Note: This is a reference structure. Adapt to the project's existing organization
25 
26const projectStructure = `
27app/
28  src/
29    main/
30      java/com/package/
31        data/
32          repository/
33          datasource/
34          models/
35        domain/
36          usecases/
37          models/
38          repository/
39        presentation/
40          screens/
41          components/
42          theme/
43          viewmodels/
44        di/
45        utils/
46      res/
47        values/
48        drawable/
49        mipmap/
50    test/
51    androidTest/
52`;
53 
54// Compose UI Guidelines
55 
56const composeGuidelines = `
571. Use remember and derivedStateOf appropriately
582. Implement proper recomposition optimization
593. Use proper Compose modifiers ordering
604. Follow composable function naming conventions
615. Implement proper preview annotations
626. Use proper state management with MutableState
637. Implement proper error handling and loading states
648. Use proper theming with MaterialTheme
659. Follow accessibility guidelines
6610. Implement proper animation patterns
67`;
68 
69// Testing Guidelines
70 
71const testingGuidelines = `
721. Write unit tests for ViewModels and UseCases
732. Implement UI tests using Compose testing framework
743. Use fake repositories for testing
754. Implement proper test coverage
765. Use proper testing coroutine dispatchers
77`;
78 
79// Performance Guidelines
80 
81const performanceGuidelines = `
821. Minimize recomposition using proper keys
832. Use proper lazy loading with LazyColumn and LazyRow
843. Implement efficient image loading
854. Use proper state management to prevent unnecessary updates
865. Follow proper lifecycle awareness
876. Implement proper memory management
887. Use proper background processing
89`;
90 
91