proagents 1.6.20 → 1.6.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (136) hide show
  1. package/.claude/settings.local.json +3 -1
  2. package/.proagents/.cursorrules +1 -1
  3. package/.proagents/.windsurfrules +1 -1
  4. package/.proagents/AGENTS.md +1 -1
  5. package/.proagents/AI_INSTRUCTIONS.md +29 -1
  6. package/.proagents/BOLT.md +1 -1
  7. package/.proagents/CLAUDE.md +1 -1
  8. package/.proagents/GEMINI.md +1 -1
  9. package/.proagents/KIRO.md +1 -1
  10. package/.proagents/LOVABLE.md +1 -1
  11. package/.proagents/REPLIT.md +1 -1
  12. package/.proagents/custom-commands.yaml +1 -2
  13. package/.proagents/docs/command-details.md +1 -2
  14. package/.proagents/getting-started/ai-training-setup.md +0 -1
  15. package/.proagents/performance/README.md +59 -0
  16. package/.proagents/performance/bundle-analysis.md +375 -0
  17. package/.proagents/performance/load-testing.md +563 -0
  18. package/.proagents/performance/runtime-metrics.md +489 -0
  19. package/.proagents/performance/web-vitals.md +425 -0
  20. package/.proagents/proagents.config.yaml +55 -1
  21. package/.proagents/prompts/11-session-tracking.md +100 -0
  22. package/.proagents/prompts/13-commit.md +426 -0
  23. package/.proagents/workflow-modes/entry-modes.md +1 -6
  24. package/COMMANDS.md +19 -0
  25. package/lib/commands/init.js +62 -11
  26. package/package.json +1 -1
  27. package/.proagents/api-versioning/README.md +0 -257
  28. package/.proagents/api-versioning/changelog-template.md +0 -225
  29. package/.proagents/api-versioning/deprecation-workflow.md +0 -470
  30. package/.proagents/api-versioning/versioning-strategy.md +0 -291
  31. package/.proagents/automation/README.md +0 -38
  32. package/.proagents/automation/ai-behavior-rules.md +0 -339
  33. package/.proagents/automation/ai-prompt-injection.md +0 -331
  34. package/.proagents/automation/auto-decisions.md +0 -535
  35. package/.proagents/automation/decision-defaults.yaml +0 -317
  36. package/.proagents/cache/README.md +0 -110
  37. package/.proagents/cache/analysis-metadata.json +0 -76
  38. package/.proagents/cache/conventions.json +0 -125
  39. package/.proagents/cache/dependencies.json +0 -85
  40. package/.proagents/cache/features.json +0 -115
  41. package/.proagents/cache/patterns.json +0 -105
  42. package/.proagents/cache/schemas/conventions-schema.json +0 -138
  43. package/.proagents/cache/schemas/dependencies-schema.json +0 -95
  44. package/.proagents/cache/schemas/features-schema.json +0 -104
  45. package/.proagents/cache/schemas/metadata-schema.json +0 -83
  46. package/.proagents/cache/schemas/patterns-schema.json +0 -136
  47. package/.proagents/cache/schemas/structure-schema.json +0 -72
  48. package/.proagents/cache/structure.json +0 -109
  49. package/.proagents/checklists/README.md +0 -261
  50. package/.proagents/checklists/code-quality.md +0 -137
  51. package/.proagents/checklists/code-review.md +0 -148
  52. package/.proagents/checklists/pr-checklist.md +0 -78
  53. package/.proagents/checklists/pre-deployment.md +0 -132
  54. package/.proagents/checklists/pre-implementation.md +0 -80
  55. package/.proagents/checklists/testing.md +0 -120
  56. package/.proagents/checkpoints.json +0 -13
  57. package/.proagents/cicd/README.md +0 -338
  58. package/.proagents/cicd/azure-devops.md +0 -267
  59. package/.proagents/cicd/github-actions.md +0 -375
  60. package/.proagents/cicd/gitlab-ci.md +0 -278
  61. package/.proagents/cicd/jenkins.md +0 -317
  62. package/.proagents/collaboration/README.md +0 -143
  63. package/.proagents/collaboration/roles.md +0 -248
  64. package/.proagents/collaboration/sessions.md +0 -390
  65. package/.proagents/collaboration/sync.md +0 -358
  66. package/.proagents/cost/README.md +0 -48
  67. package/.proagents/cost/cost-template.md +0 -283
  68. package/.proagents/cost/estimation-framework.md +0 -287
  69. package/.proagents/database/README.md +0 -72
  70. package/.proagents/database/examples/001-create-users.sql +0 -129
  71. package/.proagents/database/examples/002-add-preferences.sql +0 -94
  72. package/.proagents/database/examples/003-add-index.sql +0 -105
  73. package/.proagents/database/examples/004-rename-column.sql +0 -122
  74. package/.proagents/database/examples/005-add-foreign-key.sql +0 -142
  75. package/.proagents/database/examples/006-data-migration.sql +0 -196
  76. package/.proagents/database/examples/007-drop-column.sql +0 -163
  77. package/.proagents/database/examples/README.md +0 -89
  78. package/.proagents/database/migration-workflow.md +0 -478
  79. package/.proagents/database/rollback-scripts.md +0 -487
  80. package/.proagents/database/safety-checks.md +0 -447
  81. package/.proagents/git/README.md +0 -68
  82. package/.proagents/git/branch-strategy.md +0 -164
  83. package/.proagents/git/commit-conventions.md +0 -241
  84. package/.proagents/git/pr-workflow.md +0 -286
  85. package/.proagents/git/rollback-procedures.md +0 -416
  86. package/.proagents/ide-integration/README.md +0 -124
  87. package/.proagents/ide-integration/cline-config.md +0 -429
  88. package/.proagents/ide-integration/continue-config.md +0 -380
  89. package/.proagents/ide-integration/cursor-rules.md +0 -280
  90. package/.proagents/ide-integration/github-copilot.md +0 -384
  91. package/.proagents/ide-integration/windsurf-rules.md +0 -314
  92. package/.proagents/integrations/README.md +0 -97
  93. package/.proagents/integrations/pm/README.md +0 -344
  94. package/.proagents/learning/README.md +0 -136
  95. package/.proagents/learning/adaptation.md +0 -305
  96. package/.proagents/learning/data-collection.md +0 -283
  97. package/.proagents/learning/implementation-guide.md +0 -865
  98. package/.proagents/learning/reports.md +0 -306
  99. package/.proagents/mcp/README.md +0 -133
  100. package/.proagents/mcp/context-providers.md +0 -442
  101. package/.proagents/mcp/server-config.md +0 -306
  102. package/.proagents/mcp/tools-definition.md +0 -513
  103. package/.proagents/pm-integration/README.md +0 -151
  104. package/.proagents/pm-integration/asana.md +0 -346
  105. package/.proagents/pm-integration/github-issues.md +0 -308
  106. package/.proagents/pm-integration/gitlab-issues.md +0 -482
  107. package/.proagents/pm-integration/jira.md +0 -364
  108. package/.proagents/pm-integration/linear.md +0 -409
  109. package/.proagents/pm-integration/notion.md +0 -275
  110. package/.proagents/pm-integration/sync-config.md +0 -533
  111. package/.proagents/pm-integration/trello.md +0 -159
  112. package/.proagents/rules/README.md +0 -179
  113. package/.proagents/rules/custom-rules-template.yaml +0 -286
  114. package/.proagents/rules/custom-rules.md +0 -754
  115. package/.proagents/rules/validation-rules-template.yaml +0 -517
  116. package/.proagents/runbooks/README.md +0 -219
  117. package/.proagents/runbooks/dependency-vulnerability.md +0 -505
  118. package/.proagents/runbooks/incident-response.md +0 -451
  119. package/.proagents/runbooks/performance-degradation.md +0 -584
  120. package/.proagents/runbooks/production-debugging.md +0 -489
  121. package/.proagents/sessions/README.md +0 -5
  122. package/.proagents/sprints/README.md +0 -58
  123. package/.proagents/team/README.md +0 -256
  124. package/.proagents/team/code-ownership.md +0 -306
  125. package/.proagents/team/communication-templates.md +0 -441
  126. package/.proagents/team/handoff-protocol.md +0 -380
  127. package/.proagents/team/ide-setup/README.md +0 -103
  128. package/.proagents/team/ide-setup/cursor.md +0 -276
  129. package/.proagents/team/ide-setup/jetbrains.md +0 -330
  130. package/.proagents/team/ide-setup/neovim.md +0 -640
  131. package/.proagents/team/ide-setup/vscode.md +0 -348
  132. package/.proagents/team/onboarding.md +0 -278
  133. package/.proagents/time-tracking.json +0 -19
  134. package/.proagents/troubleshooting/README.md +0 -730
  135. package/.proagents/troubleshooting/ai-issues.md +0 -601
  136. package/.proagents/troubleshooting/workflow-issues.md +0 -571
@@ -1,380 +0,0 @@
1
- # Continue Configuration
2
-
3
- Configure Continue extension to work with ProAgents workflow.
4
-
5
- ---
6
-
7
- ## Overview
8
-
9
- Continue is an open-source AI code assistant that works with VS Code and JetBrains IDEs. It supports multiple AI providers and custom configurations.
10
-
11
- ---
12
-
13
- ## Quick Setup
14
-
15
- ```bash
16
- # Generate Continue configuration
17
- proagents ide generate continue
18
-
19
- # Creates .continuerc.json in project root
20
- ```
21
-
22
- ---
23
-
24
- ## Configuration File
25
-
26
- Create `.continuerc.json` in your project root:
27
-
28
- ```json
29
- {
30
- "name": "ProAgents Workflow",
31
- "version": "1.0.0",
32
-
33
- "models": [
34
- {
35
- "title": "Claude 3.5 Sonnet",
36
- "provider": "anthropic",
37
- "model": "claude-3-5-sonnet-20241022",
38
- "apiKey": "${ANTHROPIC_API_KEY}"
39
- },
40
- {
41
- "title": "GPT-4o",
42
- "provider": "openai",
43
- "model": "gpt-4o",
44
- "apiKey": "${OPENAI_API_KEY}"
45
- }
46
- ],
47
-
48
- "tabAutocompleteModel": {
49
- "title": "Codestral",
50
- "provider": "mistral",
51
- "model": "codestral-latest"
52
- },
53
-
54
- "customCommands": [
55
- {
56
- "name": "feature",
57
- "description": "Start a new feature with ProAgents workflow",
58
- "prompt": "I want to implement a new feature: {{{ input }}}. Follow the ProAgents workflow:\n1. First, analyze existing patterns in the codebase\n2. Propose an implementation plan\n3. Get confirmation before coding\n4. Implement with tests\n5. Document the feature"
59
- },
60
- {
61
- "name": "fix",
62
- "description": "Fix a bug using ProAgents workflow",
63
- "prompt": "Help me fix this bug: {{{ input }}}. Follow the ProAgents bug fix workflow:\n1. Identify the bug location\n2. Analyze the root cause\n3. Propose a minimal fix\n4. Add a regression test"
64
- },
65
- {
66
- "name": "doc",
67
- "description": "Generate documentation",
68
- "prompt": "Generate documentation for {{{ input }}}. Include:\n- Overview\n- API reference\n- Usage examples\n- Error handling"
69
- },
70
- {
71
- "name": "test",
72
- "description": "Generate tests",
73
- "prompt": "Generate comprehensive tests for {{{ input }}}. Include:\n- Unit tests for all functions\n- Edge cases\n- Error scenarios\n- Integration tests if applicable"
74
- },
75
- {
76
- "name": "review",
77
- "description": "Code review",
78
- "prompt": "Review this code following ProAgents quality standards:\n- Code correctness\n- Pattern compliance\n- Error handling\n- Performance\n- Security\n- Accessibility\n\n{{{ input }}}"
79
- }
80
- ],
81
-
82
- "slashCommands": [
83
- {
84
- "name": "proagents",
85
- "description": "ProAgents workflow commands",
86
- "steps": [
87
- {
88
- "type": "prompt",
89
- "prompt": "You are integrated with ProAgents workflow. Available commands:\n- pa:feature <name> - Start new feature\n- pa:fix <bug> - Fix a bug\n- pa:doc - Generate documentation\n- pa:test - Generate tests\n- pa:review - Code review\n\nUser request: {{{ input }}}"
90
- }
91
- ]
92
- }
93
- ],
94
-
95
- "contextProviders": [
96
- {
97
- "name": "proagents-context",
98
- "params": {
99
- "configPath": "./.proagents/proagents.config.yaml",
100
- "includePatterns": true,
101
- "includeStandards": true
102
- }
103
- },
104
- {
105
- "name": "codebase",
106
- "params": {
107
- "nRetrieve": 25,
108
- "nFinal": 10,
109
- "useReranking": true
110
- }
111
- },
112
- {
113
- "name": "folder",
114
- "params": {}
115
- },
116
- {
117
- "name": "diff",
118
- "params": {}
119
- }
120
- ],
121
-
122
- "systemMessage": "You are an AI assistant integrated with the ProAgents development workflow. Follow these principles:\n\n1. **Analyze First**: Always understand existing patterns before suggesting code\n2. **Follow Conventions**: Match the project's coding standards\n3. **Quality Focus**: Include error handling, tests, and documentation\n4. **Explain Reasoning**: Describe your approach before implementing\n5. **Minimal Changes**: Make only necessary modifications\n\nProject Standards:\n- TypeScript with strict mode\n- Functional React components\n- Tailwind CSS for styling\n- Jest for testing\n- Follow existing patterns in the codebase"
123
- }
124
- ```
125
-
126
- ---
127
-
128
- ## Custom Context Providers
129
-
130
- ### ProAgents Context Provider
131
-
132
- Create `.continue/proagents-context.ts`:
133
-
134
- ```typescript
135
- import { ContextProvider, ContextItem } from "@continuedev/core";
136
- import * as fs from "fs";
137
- import * as path from "path";
138
-
139
- export class ProAgentsContextProvider implements ContextProvider {
140
- name = "proagents-context";
141
- description = "Provides ProAgents workflow context";
142
-
143
- async getContextItems(query: string): Promise<ContextItem[]> {
144
- const items: ContextItem[] = [];
145
- const projectRoot = process.cwd();
146
-
147
- // Load ProAgents config
148
- const configPath = path.join(projectRoot, ".proagents/proagents.config.yaml");
149
- if (fs.existsSync(configPath)) {
150
- items.push({
151
- name: "ProAgents Configuration",
152
- description: "Project workflow configuration",
153
- content: fs.readFileSync(configPath, "utf-8"),
154
- });
155
- }
156
-
157
- // Load active feature status
158
- const featuresPath = path.join(projectRoot, ".proagents/active-features");
159
- if (fs.existsSync(featuresPath)) {
160
- const features = fs.readdirSync(featuresPath);
161
- for (const feature of features) {
162
- const statusPath = path.join(featuresPath, feature, "status.json");
163
- if (fs.existsSync(statusPath)) {
164
- items.push({
165
- name: `Feature: ${feature}`,
166
- description: "Active feature status",
167
- content: fs.readFileSync(statusPath, "utf-8"),
168
- });
169
- }
170
- }
171
- }
172
-
173
- // Load coding standards
174
- const standardsPath = path.join(projectRoot, ".proagents/standards");
175
- if (fs.existsSync(standardsPath)) {
176
- const standards = fs.readdirSync(standardsPath).filter(f => f.endsWith('.md'));
177
- for (const standard of standards.slice(0, 3)) {
178
- items.push({
179
- name: `Standard: ${standard}`,
180
- description: "Coding standard",
181
- content: fs.readFileSync(path.join(standardsPath, standard), "utf-8"),
182
- });
183
- }
184
- }
185
-
186
- return items;
187
- }
188
- }
189
- ```
190
-
191
- ---
192
-
193
- ## Workflow Prompts
194
-
195
- ### Feature Development Prompt
196
-
197
- ```json
198
- {
199
- "name": "proagents-feature",
200
- "description": "Complete feature development workflow",
201
- "steps": [
202
- {
203
- "type": "context",
204
- "query": "Find existing patterns related to: {{{ input }}}"
205
- },
206
- {
207
- "type": "prompt",
208
- "prompt": "Based on the existing codebase patterns, create an implementation plan for: {{{ input }}}\n\nInclude:\n1. Files to create/modify\n2. Key components/functions\n3. Integration points\n4. Testing approach"
209
- },
210
- {
211
- "type": "prompt",
212
- "prompt": "Now implement the feature following the plan. Create complete, working code with proper error handling and types."
213
- },
214
- {
215
- "type": "prompt",
216
- "prompt": "Generate comprehensive tests for the implementation."
217
- }
218
- ]
219
- }
220
- ```
221
-
222
- ### Code Review Prompt
223
-
224
- ```json
225
- {
226
- "name": "proagents-review",
227
- "description": "Comprehensive code review",
228
- "steps": [
229
- {
230
- "type": "context",
231
- "query": "Get project coding standards"
232
- },
233
- {
234
- "type": "prompt",
235
- "prompt": "Review the following code against ProAgents quality standards:\n\n## Checklist\n- [ ] Follows project patterns\n- [ ] Proper TypeScript types\n- [ ] Error handling\n- [ ] Performance considerations\n- [ ] Security (no vulnerabilities)\n- [ ] Accessibility\n- [ ] Test coverage\n\n## Code to Review\n{{{ input }}}\n\nProvide detailed feedback with specific suggestions."
236
- }
237
- ]
238
- }
239
- ```
240
-
241
- ---
242
-
243
- ## Model Configuration
244
-
245
- ### For Different Tasks
246
-
247
- ```json
248
- {
249
- "models": [
250
- {
251
- "title": "Claude (Code Analysis)",
252
- "provider": "anthropic",
253
- "model": "claude-3-5-sonnet-20241022",
254
- "roles": ["chat", "edit"]
255
- },
256
- {
257
- "title": "GPT-4 (Documentation)",
258
- "provider": "openai",
259
- "model": "gpt-4o",
260
- "roles": ["chat"]
261
- },
262
- {
263
- "title": "Codestral (Autocomplete)",
264
- "provider": "mistral",
265
- "model": "codestral-latest",
266
- "roles": ["autocomplete"]
267
- }
268
- ],
269
-
270
- "modelRoles": {
271
- "default": "Claude (Code Analysis)",
272
- "summarize": "Claude (Code Analysis)",
273
- "edit": "Claude (Code Analysis)",
274
- "chat": "Claude (Code Analysis)"
275
- }
276
- }
277
- ```
278
-
279
- ### Local Models
280
-
281
- ```json
282
- {
283
- "models": [
284
- {
285
- "title": "Ollama CodeLlama",
286
- "provider": "ollama",
287
- "model": "codellama:13b"
288
- },
289
- {
290
- "title": "Ollama Deepseek",
291
- "provider": "ollama",
292
- "model": "deepseek-coder:6.7b"
293
- }
294
- ]
295
- }
296
- ```
297
-
298
- ---
299
-
300
- ## ProAgents Integration
301
-
302
- ```yaml
303
- # proagents.config.yaml
304
- ide:
305
- continue:
306
- enabled: true
307
-
308
- # Config output
309
- config_path: ".continuerc.json"
310
-
311
- # Custom commands to generate
312
- commands:
313
- - feature
314
- - fix
315
- - doc
316
- - test
317
- - review
318
- - refactor
319
-
320
- # Context providers
321
- context:
322
- include_config: true
323
- include_features: true
324
- include_standards: true
325
- include_patterns: true
326
-
327
- # Model preferences
328
- models:
329
- chat: "anthropic/claude-3-5-sonnet"
330
- autocomplete: "mistral/codestral"
331
-
332
- # System message customization
333
- include_in_system:
334
- - project_overview
335
- - coding_standards
336
- - patterns
337
- ```
338
-
339
- ---
340
-
341
- ## Syncing Configuration
342
-
343
- ```bash
344
- # Generate Continue config
345
- proagents ide generate continue
346
-
347
- # Include all context
348
- proagents ide generate continue --full
349
-
350
- # Sync after changes
351
- proagents ide sync continue
352
-
353
- # Validate configuration
354
- proagents ide validate continue
355
- ```
356
-
357
- ---
358
-
359
- ## VS Code Settings
360
-
361
- Add to `.vscode/settings.json`:
362
-
363
- ```json
364
- {
365
- "continue.enableTabAutocomplete": true,
366
- "continue.showInlineTip": true,
367
- "continue.remoteConfigServerUrl": null,
368
- "continue.customConfigPath": ".continuerc.json"
369
- }
370
- ```
371
-
372
- ---
373
-
374
- ## Best Practices
375
-
376
- 1. **Model Selection**: Use appropriate models for different tasks
377
- 2. **Context Management**: Configure context providers for relevant information
378
- 3. **Custom Commands**: Create commands for common workflows
379
- 4. **System Message**: Keep it concise but comprehensive
380
- 5. **Regular Updates**: Sync config when project evolves
@@ -1,280 +0,0 @@
1
- # Cursor Rules Configuration
2
-
3
- Configure Cursor IDE to work with ProAgents workflow.
4
-
5
- ---
6
-
7
- ## Overview
8
-
9
- Cursor uses a `.cursorrules` file in the project root to provide context and instructions to its AI assistant.
10
-
11
- ---
12
-
13
- ## Quick Setup
14
-
15
- ```bash
16
- # Generate Cursor rules from ProAgents config
17
- proagents ide generate cursor
18
-
19
- # This creates .cursorrules in your project root
20
- ```
21
-
22
- ---
23
-
24
- ## Complete .cursorrules Template
25
-
26
- Create `.cursorrules` in your project root:
27
-
28
- ```markdown
29
- # ProAgents Development Workflow
30
-
31
- You are an AI assistant integrated with the ProAgents development workflow. Follow these guidelines for all development tasks.
32
-
33
- ## Workflow Commands
34
-
35
- When the user types a command, follow the corresponding workflow:
36
-
37
- - `pa:init` - Initialize ProAgents in this project
38
- - `pa:feature <name>` - Start a new feature with full workflow
39
- - `pa:fix <description>` - Start bug fix workflow
40
- - `pa:doc` - Generate documentation
41
- - `pa:test` - Run tests
42
- - `pa:qa` - Quality assurance checks
43
- - `pa:deploy` - Deployment workflow
44
- - `pa:status` - Show current workflow status
45
-
46
- ## Development Phases
47
-
48
- For new features, follow these phases in order:
49
-
50
- 1. **Analysis** - Understand existing codebase patterns
51
- 2. **Requirements** - Clarify feature requirements
52
- 3. **Design** - Plan UI/architecture
53
- 4. **Planning** - Create implementation plan
54
- 5. **Implementation** - Write code following project patterns
55
- 6. **Testing** - Write comprehensive tests
56
- 7. **Review** - Self-review against checklist
57
- 8. **Documentation** - Document the feature
58
-
59
- ## Code Standards
60
-
61
- ### TypeScript/JavaScript
62
- - Use TypeScript strict mode
63
- - Prefer functional components
64
- - Use named exports
65
- - Follow existing naming conventions
66
-
67
- ### File Naming
68
- - Components: PascalCase (e.g., `UserProfile.tsx`)
69
- - Utilities: kebab-case (e.g., `string-utils.ts`)
70
- - Tests: `{name}.test.ts`
71
-
72
- ### Imports
73
- - Use absolute imports with `@/` prefix
74
- - Order: React → Third-party → Local → Styles
75
-
76
- ## Project Patterns
77
-
78
- ### State Management
79
- - Use Zustand for global state
80
- - Use React hooks for local state
81
- - Use React Query for server state
82
-
83
- ### Styling
84
- - Use Tailwind CSS utility classes
85
- - Follow mobile-first responsive design
86
-
87
- ### Error Handling
88
- - Use try-catch for async operations
89
- - Use Error Boundaries for components
90
- - Log errors with proper context
91
-
92
- ### Testing
93
- - Write unit tests for utilities and hooks
94
- - Write integration tests for components
95
- - Aim for 80% coverage on new code
96
-
97
- ## Before Writing Code
98
-
99
- Always:
100
- 1. Check existing patterns in the codebase
101
- 2. Look for similar implementations to follow
102
- 3. Verify the approach aligns with project architecture
103
- 4. Consider edge cases and error handling
104
-
105
- ## Code Quality Checklist
106
-
107
- Before completing any implementation:
108
- - [ ] Code follows project conventions
109
- - [ ] No TypeScript errors
110
- - [ ] Tests written and passing
111
- - [ ] Error handling implemented
112
- - [ ] No hardcoded values
113
- - [ ] Accessible (ARIA labels, keyboard nav)
114
-
115
- ## Communication
116
-
117
- - Explain your reasoning before making changes
118
- - Ask clarifying questions if requirements are unclear
119
- - Suggest alternatives when appropriate
120
- - Warn about potential breaking changes
121
-
122
- ## File Locations
123
-
124
- - Components: `src/components/`
125
- - Pages: `src/pages/` or `src/app/`
126
- - Hooks: `src/hooks/`
127
- - Utils: `src/utils/` or `src/lib/`
128
- - Types: `src/types/`
129
- - Tests: `__tests__/` or colocated with source
130
-
131
- ## Don't
132
-
133
- - Don't create files outside the project structure
134
- - Don't modify configuration files without asking
135
- - Don't remove existing functionality without confirmation
136
- - Don't skip tests for "simple" changes
137
- - Don't use deprecated APIs or patterns
138
- ```
139
-
140
- ---
141
-
142
- ## Dynamic Rules Generation
143
-
144
- ProAgents can generate rules based on your project analysis:
145
-
146
- ```bash
147
- # Generate with detected patterns
148
- proagents ide generate cursor --include-patterns
149
-
150
- # Generate with learned preferences
151
- proagents ide generate cursor --include-learning
152
-
153
- # Full generation with everything
154
- proagents ide generate cursor --full
155
- ```
156
-
157
- ---
158
-
159
- ## Project-Specific Additions
160
-
161
- Add to `.cursorrules` based on your project:
162
-
163
- ### For React Projects
164
- ```markdown
165
- ## React Patterns
166
-
167
- - Use functional components exclusively
168
- - Implement React.memo for expensive renders
169
- - Use useCallback for event handlers passed to children
170
- - Use useMemo for expensive calculations
171
- ```
172
-
173
- ### For Next.js Projects
174
- ```markdown
175
- ## Next.js Patterns
176
-
177
- - Use App Router conventions
178
- - Implement loading.tsx for suspense boundaries
179
- - Use server components by default
180
- - Client components only when needed (use 'use client')
181
- ```
182
-
183
- ### For API Projects
184
- ```markdown
185
- ## API Patterns
186
-
187
- - Use controller → service → repository pattern
188
- - Validate all inputs with Zod/Joi
189
- - Return consistent error responses
190
- - Document endpoints with JSDoc
191
- ```
192
-
193
- ---
194
-
195
- ## Cursor-Specific Features
196
-
197
- ### Composer Mode
198
- ```markdown
199
- ## Composer Guidelines
200
-
201
- When using Cursor Composer:
202
- - Create files in correct locations
203
- - Follow import conventions
204
- - Include all necessary dependencies
205
- - Add appropriate tests
206
- ```
207
-
208
- ### Chat Mode
209
- ```markdown
210
- ## Chat Guidelines
211
-
212
- When answering questions:
213
- - Reference specific files when relevant
214
- - Provide code snippets with context
215
- - Explain trade-offs of different approaches
216
- ```
217
-
218
- ---
219
-
220
- ## Syncing with ProAgents Config
221
-
222
- ```yaml
223
- # proagents.config.yaml
224
- ide:
225
- cursor:
226
- enabled: true
227
-
228
- # Sections to include
229
- include:
230
- - workflow_commands
231
- - code_standards
232
- - project_patterns
233
- - checklists
234
-
235
- # Custom additions
236
- custom_sections:
237
- - name: "API Guidelines"
238
- content: |
239
- - All API calls go through /src/api/
240
- - Use React Query for data fetching
241
- - Handle loading and error states
242
- ```
243
-
244
- ---
245
-
246
- ## Updating Rules
247
-
248
- When your project evolves:
249
-
250
- ```bash
251
- # Regenerate rules after config changes
252
- proagents ide sync cursor
253
-
254
- # Diff current rules with generated
255
- proagents ide diff cursor
256
-
257
- # Backup and update
258
- proagents ide update cursor --backup
259
- ```
260
-
261
- ---
262
-
263
- ## Troubleshooting
264
-
265
- | Issue | Solution |
266
- |-------|----------|
267
- | Rules not loading | Restart Cursor IDE |
268
- | Rules too long | Use `--compact` flag |
269
- | Missing patterns | Run `proagents analyze` first |
270
- | Conflicts with manual rules | Use `include` blocks |
271
-
272
- ---
273
-
274
- ## Best Practices
275
-
276
- 1. **Keep Rules Focused**: Don't overload with too many instructions
277
- 2. **Update Regularly**: Sync rules when project patterns change
278
- 3. **Test Rules**: Verify AI follows rules correctly
279
- 4. **Version Control**: Commit `.cursorrules` with your project
280
- 5. **Team Alignment**: Ensure all team members use same rules