Skip to content

Commit b52a76b

Browse files
feat: add Diagnostics Integration documentation and related feature, 3.23.7 to .12 (#253)
1 parent 80ece27 commit b52a76b

File tree

12 files changed

+362
-1
lines changed

12 files changed

+362
-1
lines changed

docs/basic-usage/context-mentions.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ Context mentions are a powerful way to provide Roo Code with specific informatio
6363
| **Groups** | Problems organized by file for better clarity |
6464
| **Best for** | Fixing errors without manual copying |
6565

66+
For comprehensive details on how Roo Code integrates with VSCode's diagnostics system, see [Diagnostics Integration](/features/diagnostics-integration).
67+
6668
### Terminal Mention
6769
<img src="/img/context-mentions/context-mentions-4.png" alt="Terminal mention example showing terminal output being included in Roo's context" width="600" />
6870

@@ -129,4 +131,11 @@ The dropdown automatically filters out common directories like `node_modules`, `
129131
| **`.gitignore` bypass** | Similarly, file and folder `@mentions` do not respect `.gitignore` rules when fetching content. |
130132
| **Git command respect** | Git-related mentions (`@git-changes`, `@commit-hash`) do respect `.gitignore` since they rely on Git commands. |
131133

134+
---
135+
136+
## Related Features
137+
138+
- [Diagnostics Integration](/features/diagnostics-integration) - Learn about automatic error detection and smart severity filtering
139+
- [Code Actions](/features/code-actions) - Discover quick fixes and AI assistance directly in your editor
140+
- [Shell Integration](/features/shell-integration) - Understand how terminal mentions work with shell integration
132141

docs/features/code-actions.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ The lightbulb menu intelligently shows different actions based on your code's cu
4141
- **Improve Code** - Receive optimization suggestions and best practices
4242
- **Add to Context** - Add the code to Roo's context for further work
4343

44+
For more details on how diagnostics are integrated with Code Actions, see [Diagnostics Integration](/features/diagnostics-integration).
45+
4446
### Add to Context Deep Dive
4547

4648
The **Add to Context** action is listed first in the Code Actions menu so you can quickly add code snippets to your conversation. When you use it, Roo Code includes the filename and line numbers along with the code.
@@ -124,7 +126,7 @@ You can customize the prompts used for each Code Action by modifying the "Suppor
124126
3. **Edit the Prompts:** Modify the text in the text area for the prompt you want to customize. The prompts use placeholders in the format `${placeholder}`:
125127
- `${filePath}` - The path of the current file
126128
- `${selectedText}` - The currently selected text
127-
- `${diagnostics}` - Any error or warning messages (for Fix Code)
129+
- `${diagnostics}` - Any error or warning messages (for Fix Code) - see [Diagnostics Integration](/features/diagnostics-integration) for details
128130
4. **Click "Done":** Save your changes.
129131

130132
### Example Prompt Template
@@ -135,3 +137,10 @@ ${selectedText}
135137
```
136138

137139
By using Roo Code's Code Actions, you can quickly get AI-powered assistance directly within your coding workflow. This can save you time and help you write better code.
140+
141+
---
142+
143+
## Related Features
144+
145+
- [Diagnostics Integration](/features/diagnostics-integration) - Learn how Roo Code integrates with VSCode's Problems panel
146+
- [Context Mentions](/basic-usage/context-mentions) - Discover other ways to provide context to Roo Code
Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
# Diagnostics Integration
2+
3+
Roo Code provides intelligent integration with VSCode's Problems panel, allowing the AI assistant to understand and help fix code errors, warnings, and other issues detected by language servers, linters, and other diagnostic providers.
4+
5+
---
6+
7+
## Overview
8+
9+
The diagnostics feature seamlessly integrates with VSCode's diagnostic system to provide context-aware assistance for code issues. When you make edits or encounter problems in your code, Roo Code can automatically detect and help resolve them.
10+
11+
### Key Capabilities
12+
- **Automatic Error Detection**: Captures new errors introduced during code edits
13+
- **Context-Aware Fixes**: Provides targeted fixes based on diagnostic information
14+
- **Workspace Problems Mention**: Access all workspace diagnostics through a simple mention
15+
- **Smart Filtering**: Uses predefined severity levels for different contexts
16+
17+
---
18+
19+
## Key Features
20+
21+
### 1. Automatic Error Detection
22+
When Roo Code makes edits to files, it automatically:
23+
- Captures diagnostics before editing
24+
- Waits for diagnostics to update after editing
25+
- Detects new problems introduced by the changes
26+
- Only reports new errors (not pre-existing ones)
27+
28+
This ensures you're immediately aware of any issues introduced by code changes, allowing for quick resolution.
29+
30+
### 2. Workspace Problems Mention
31+
Users can include `@problems` in their messages to:
32+
- Get a complete list of workspace errors and warnings
33+
- Provide context for debugging tasks
34+
- Request fixes for specific issues
35+
36+
Example usage:
37+
```
38+
@problems Fix all TypeScript errors in my project
39+
```
40+
41+
For more details on using `@problems`, see [Context Mentions](/basic-usage/context-mentions#problems-mention).
42+
43+
### 3. Code Actions Integration
44+
When diagnostics exist at a cursor position:
45+
- "Fix with Roo Code" action appears in quick fix menu
46+
- Includes diagnostic details in the fix request
47+
- Provides targeted solutions based on error context
48+
49+
Learn more about this integration in [Code Actions](/features/code-actions#context-aware-actions).
50+
51+
### 4. Smart Severity Filtering
52+
Different features use different severity filters to provide the most relevant information:
53+
- **Workspace Problems mention**: Shows errors and warnings
54+
- **Automatic detection**: Shows only errors (to avoid distraction)
55+
- **Context-Aware**: Different features use different hardcoded severity filters
56+
57+
---
58+
59+
## Severity Levels
60+
61+
The diagnostics system recognizes four severity levels from VSCode:
62+
63+
| Level | Value | Description | Workspace Problems | Auto-detection |
64+
|-------|-------|-------------|-------------------|----------------|
65+
| Error | 0 | Syntax errors, type errors, breaking issues | ✅ Included | ✅ Included |
66+
| Warning | 1 | Code quality issues, deprecations, style violations | ✅ Included | ❌ Not included |
67+
| Information | 2 | Suggestions, hints, informational messages | ❌ Not included | ❌ Not included |
68+
| Hint | 3 | Minor suggestions, refactoring opportunities | ❌ Not included | ❌ Not included |
69+
70+
### Why Different Filters?
71+
72+
- **Workspace Problems (`@problems`)**: Includes both errors and warnings to give you a complete picture of code health when explicitly requested
73+
- **Automatic Detection**: Only includes errors to avoid interrupting your workflow with non-critical issues
74+
75+
---
76+
77+
## Using Diagnostics Effectively
78+
79+
### For Debugging Sessions
80+
When starting a debugging session, include `@problems` to give Roo Code full context:
81+
```
82+
@problems Help me debug why my application is crashing
83+
```
84+
85+
### For Code Reviews
86+
Use diagnostics to ensure code quality:
87+
```
88+
@problems Review my code and fix any linting issues
89+
```
90+
91+
### For Refactoring
92+
Let diagnostics guide safe refactoring:
93+
```
94+
I want to refactor this function. @problems shows current issues to address.
95+
```
96+
97+
---
98+
99+
## Integration with Other Features
100+
101+
### Code Actions
102+
Diagnostics power the context-aware [Code Actions](/features/code-actions) that appear in VSCode's lightbulb menu. When errors are present, you'll see "Fix Code" options that include the specific diagnostic information.
103+
104+
### Context Mentions
105+
The [`@problems` mention](/basic-usage/context-mentions#problems-mention) provides a convenient way to include all workspace diagnostics in your conversation without manually copying error messages.
106+
107+
### Automatic Error Reporting
108+
When Roo Code edits files, any new errors introduced are automatically reported in the response, helping maintain code quality throughout the editing process.
109+
110+
---
111+
112+
## Best Practices
113+
114+
1. **Use `@problems` for Context**: When debugging, always include `@problems` to give Roo Code full visibility into current issues
115+
116+
2. **Address Errors First**: Focus on fixing errors before warnings, as errors typically prevent code from running
117+
118+
3. **Leverage Code Actions**: Use the quick fix menu for targeted fixes to specific diagnostics
119+
120+
4. **Monitor Auto-Detection**: Pay attention to new errors reported after edits to catch issues early
121+
122+
5. **Combine with Other Tools**: Use diagnostics alongside other Roo Code features like codebase search and file mentions for comprehensive problem-solving
123+
124+
---
125+
126+
## Troubleshooting
127+
128+
### Diagnostics Not Appearing
129+
- Ensure your language server or linter is properly configured and running
130+
- Check that the file type is supported by your diagnostic providers
131+
- Verify that VSCode's Problems panel shows the issues
132+
133+
### `@problems` Shows Nothing
134+
- Confirm there are actually problems in the Problems panel
135+
- Check that you're in the correct workspace
136+
- Some diagnostic providers may take time to initialize
137+
138+
### Auto-Detection Missing Errors
139+
- Only new errors (introduced by edits) are reported
140+
- Pre-existing errors won't be shown in auto-detection
141+
- Use `@problems` to see all current issues
142+
143+
---
144+
145+
## Related Features
146+
147+
- [Context Mentions](/basic-usage/context-mentions) - Learn about all mention types including `@problems`
148+
- [Code Actions](/features/code-actions) - Discover how diagnostics integrate with quick fixes
149+
- [Codebase Search](/features/codebase-indexing) - Find code related to specific errors

docs/update-notes/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ This section contains notes about recent updates to Roo Code, listed by version
55

66
## Version 3.23
77

8+
* [3.23.12](/update-notes/v3.23.12) (2025-01-13)
9+
* [3.23.11](/update-notes/v3.23.11) (2025-01-13)
10+
* [3.23.10](/update-notes/v3.23.10) (2025-01-13)
11+
* [3.23.9](/update-notes/v3.23.9) (2025-01-13)
12+
* [3.23.8](/update-notes/v3.23.8) (2025-01-13)
13+
* [3.23.7](/update-notes/v3.23.7) (2025-01-13)
814
* [3.23.6](/update-notes/v3.23.6) (2025-07-10)
915
* [3.23.5](/update-notes/v3.23.5) (2025-07-10)
1016
* [3.23.4](/update-notes/v3.23.4) (2025-07-10)

docs/update-notes/v3.23.10.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Roo Code 3.23.10 Release Notes (2025-01-13)
2+
3+
This release improves codebase indexing reliability and enhances the user interface.
4+
5+
## Bug Fixes
6+
7+
* **Code Indexing**: Fixed code indexing to use optimal model dimensions, improving indexing reliability and performance (thanks daniel-lxs!) ([#5705](https://github.com/RooCodeInc/Roo-Code/pull/5705))
8+
9+
## QOL Improvements
10+
11+
* **Model Selection Interface**: Improved visual appearance and spacing in the code index model selection interface for better usability

docs/update-notes/v3.23.11.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Roo Code 3.23.11 Release Notes (2025-01-13)
2+
3+
This release adds new provider options and improves mode navigation.
4+
5+
## Provider Updates
6+
7+
* **Groq Kimi K2**: Added Kimi K2 model option for Groq users with improved token handling reliability for models with equal max tokens and context window
8+
9+
## QOL Improvements
10+
11+
* **Mode Navigation**: Added bidirectional mode cycling with Cmd+Shift+. keyboard shortcut to switch to previous mode, making mode navigation more efficient when you overshoot your target mode (thanks mkdir700!) ([#5695](https://github.com/RooCodeInc/Roo-Code/pull/5695))
12+
13+
## Misc Improvements
14+
15+
* **GitHub Actions**: Fixed GitHub Actions workflow warnings by removing invalid parameters from CI/CD configuration (thanks hamirmahal!) ([#5676](https://github.com/RooCodeInc/Roo-Code/pull/5676))

docs/update-notes/v3.23.12.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Roo Code 3.23.12 Release Notes (2025-01-13)
2+
3+
This release improves token handling consistency across API providers.
4+
5+
## Misc Improvements
6+
7+
* **Token Handling**: Improved consistency in token handling across API providers with centralized max-token calculation logic for better reliability

docs/update-notes/v3.23.7.mdx

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Roo Code 3.23.7 Release Notes (2025-01-13)
2+
3+
This release improves codebase indexing reliability, adds new provider options, and enhances the user interface.
4+
5+
## Provider Updates
6+
7+
* **Devstral Medium**: Added support for Mistral's Devstral Medium model with 131,000 token context window and image support capabilities
8+
* **Claude Code**: Added configurable maximum output tokens setting (8,000-64,000 tokens) for complex code generation tasks
9+
* **Vertex AI**: Expanded region configuration to include all available GCP Vertex AI regions for better compliance and access to third-party models like Anthropic Claude (thanks shubhamgupta731!) ([#5557](https://github.com/RooCodeInc/Roo-Code/pull/5557))
10+
11+
## Bug Fixes
12+
13+
* **Context Token Display**: Fixed inflated context token count displays by excluding cache tokens from calculation, showing accurate context window usage (thanks daniel-lxs!) ([#5603](https://github.com/RooCodeInc/Roo-Code/pull/5603))
14+
* **Codebase Indexing Errors**: Fixed cryptic error messages when configuring codebase indexing - users now see clear, understandable error messages instead of translation keys (thanks daniel-lxs, nikhil-swamix!) ([#5574](https://github.com/RooCodeInc/Roo-Code/pull/5574))
15+
* **Embedding Model Switching**: Fixed issues when switching between embedding models with different vector dimensions, allowing use of models beyond 1536 dimensions like Google Gemini's text-embedding-004 (thanks daniel-lxs, mkdir700!) ([#5565](https://github.com/RooCodeInc/Roo-Code/pull/5565))
16+
* **Mermaid Diagrams**: Fixed Mermaid diagram rendering issues in architect mode by preventing common syntax errors (thanks MuriloFP, joshmouch!) ([#5530](https://github.com/RooCodeInc/Roo-Code/pull/5530))
17+
* **UI Button Overlap**: Fixed overlapping enhancement and text-to-speech buttons, making both features accessible when text-to-speech is enabled (thanks sensei-woo!) ([#5586](https://github.com/RooCodeInc/Roo-Code/pull/5586))
18+
19+
## QOL Improvements
20+
21+
* **Marketplace Access**: Added Marketplace buttons to both MCP and modes tabs for easier discovery and access
22+
* **MCP Interface**: Improved MCP UI with toggle switches instead of eye buttons for enabling/disabling tools and servers, providing clearer visual feedback
23+
* **Codebase Search**: Cleaner and more readable codebase search results with improved visual styling and better internationalization
24+
* **Error Messages**: Friendlier error messages when API configuration profiles aren't compatible with organization settings
25+
* **Architect Mode**: Intelligently selects the best available tools for context discovery, including semantic search when available
26+
27+
## Misc Improvements
28+
29+
* **Error Telemetry**: Improved debugging capabilities for better reliability and faster issue resolution, with enhanced privacy protection through hashed file paths (thanks daniel-lxs!) ([#5595](https://github.com/RooCodeInc/Roo-Code/pull/5595))
30+
31+
## Documentation Updates
32+
33+
* **Typo Fixes**: Improved accuracy and clarity of documentation and code comments across multiple files (thanks noritaka1166!) ([#5569](https://github.com/RooCodeInc/Roo-Code/pull/5569))

docs/update-notes/v3.23.8.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Roo Code 3.23.8 Release Notes (2025-01-13)
2+
3+
This release adds command workflow controls and improves the user interface.
4+
5+
## Command Denylist
6+
7+
We've added the ability to automatically reject unwanted commands in your workflows (thanks hannesrudolph!) ([#5614](https://github.com/RooCodeInc/Roo-Code/pull/5614)):
8+
9+
- **Always Reject**: Mark commands as "always reject" to prevent accidental execution
10+
- **Time Saving**: No need to manually reject the same commands repeatedly
11+
- **Workflow Control**: Complements existing auto-approval functionality with "always reject" option
12+
13+
This gives you better control over command execution in automated workflows.
14+
15+
## QOL Improvements
16+
17+
* **Codebase Indexing Toggle**: Added enable/disable checkbox for codebase indexing in settings with state persistence across sessions (thanks daniel-lxs, elasticdotventures!) ([#5599](https://github.com/RooCodeInc/Roo-Code/pull/5599))
18+
* **Chat Interface**: Improved chat layout with better organization and increased task history visibility (3 tasks instead of 2)
19+
* **Command Messaging**: Clearer messaging when command prefixes are denied - users now see that denial is due to their settings rather than automatic system behavior
20+
* **History Navigation**: Added "View all history" link to the HistoryPreview component for easier access to full task history when the history tab is hidden
21+
22+
## Misc Improvements
23+
24+
* **Type Definitions**: Updated internal type definitions for improved compatibility and development experience

docs/update-notes/v3.23.9.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Roo Code 3.23.9 Release Notes (2025-01-13)
2+
3+
This release adds Windows support for Claude Code, introduces configurable command timeouts, and fixes critical workflow issues.
4+
5+
## Windows Support
6+
7+
We've added native Windows support for the Claude Code provider (thanks SannidhyaSah, kwk9892!) ([#5615](https://github.com/RooCodeInc/Roo-Code/pull/5615)):
8+
9+
- **Fixed Windows Compatibility**: Claude Code provider no longer gets stuck on Windows systems
10+
- **Improved Input Handling**: Uses stdin-based input to eliminate command-line length limitations
11+
- **Cross-Platform**: Works reliably across Windows, macOS, and Linux
12+
13+
## Command Execution Improvements
14+
15+
We've added configurable timeout settings for command execution:
16+
17+
- **Timeout Control**: Set timeouts from 0-600 seconds to prevent long-running commands from blocking workflows
18+
- **Clear Error Messages**: Commands that timeout display helpful error messages
19+
- **Better Visual Feedback**: Timeout errors now appear in red for better visibility
20+
21+
## Bug Fixes
22+
23+
* **Directory Tracking**: Fixed command execution directory tracking - Roo Code now properly maintains awareness of the current working directory when executing commands, preventing issues where subsequent commands would run in the wrong location after using `cd` commands (thanks chris-garrett!) ([#5667](https://github.com/RooCodeInc/Roo-Code/pull/5667))
24+
* **Embedding Model Switching**: Fixed vector dimension mismatch errors when switching between embedding models with different dimensions, allowing successful transitions from high-dimensional models to lower-dimensional models like Google Gemini (thanks hubeizys!) ([#5617](https://github.com/RooCodeInc/Roo-Code/pull/5617))
25+
26+
## Provider Updates
27+
28+
* **Google Gemini**: Added support for Google's new gemini-embedding-001 model with improved performance and higher dimensional embeddings (3072 vs 768) for better codebase indexing and search (thanks daniel-lxs!) ([#5698](https://github.com/RooCodeInc/Roo-Code/pull/5698))

0 commit comments

Comments
 (0)