feat: add workspace-level toggle for codebase indexing #7927
Conversation
![roomote[bot]](https://avatars.githubusercontent.com/in/1546624?s=60&v=4){kind=small}
- Add workspace-specific indexing settings that override global settings - Implement UI toggle in CodeIndexPopover for workspace-level control - Store workspace settings using VSCode workspace state API - Support multi-root workspaces with per-folder settings - Add comprehensive unit tests for new functionality - Update translations for new UI elements Fixes #7926
dosubot
bot
added
size:L
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
| if (this.context) { | ||
| // Use a hash of the workspace path as the key to avoid issues with special characters | ||
| const key = `codebaseIndexEnabled_${Buffer.from(workspacePath).toString("base64")}` | ||
| await this.context.workspaceState.update(key, enabled) |
There was a problem hiding this comment.
Good implementation of workspace-specific settings. Consider adding a try/catch block around the context.workspaceState.update call (line 529) to log or handle potential errors during saving.
hannesrudolph
added
the
Issue/PR - Triage
| <div className="mb-4 ml-6"> | ||
| <div className="flex items-center gap-2"> | ||
| <VSCodeCheckbox | ||
| checked={currentSettings.workspaceIndexEnabled !== false} |
There was a problem hiding this comment.
The workspace toggle condition currentSettings.workspaceIndexEnabled !== false could be more explicit about handling the three-state logic (true/false/undefined). When undefined, it inherits the global setting, but this implicit behavior might be confusing. Consider using a more explicit check for clearer intent.
| return this.workspaceIndexEnabled.get(workspacePath) | ||
| } | ||
| // Use a hash of the workspace path as the key to avoid issues with special characters | ||
| const key = `codebaseIndexEnabled_${Buffer.from(workspacePath).toString("base64")}` |
There was a problem hiding this comment.
The base64 encoding logic for workspace paths is duplicated here and on line 530. Consider extracting to a private helper method:
private getWorkspaceStateKey(workspacePath: string): string {
return `codebaseIndexEnabled_${Buffer.from(workspacePath).toString("base64")}`;
}This would improve maintainability and ensure consistency.
| @@ -480,4 +501,57 @@ | |||
| public get currentSearchMaxResults(): number { | |||
| return this.searchMaxResults ?? DEFAULT_MAX_SEARCH_RESULTS | |||
| } | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
These new workspace-specific methods would benefit from more detailed JSDoc comments explaining:
- The base64 encoding strategy for workspace paths
- The inheritance model (undefined = inherit global)
- How this interacts with multi-root workspaces
This would help future maintainers understand the design decisions.
| // Initialize config manager with mocks | ||
| configManager = new CodeIndexConfigManager(mockContextProxy, testWorkspacePath, mockContext) | ||
| }) | ||
|
|
There was a problem hiding this comment.
Consider adding edge case tests for workspace paths with special characters (spaces, unicode, etc.) to ensure the base64 encoding handles them correctly. This would increase confidence in the robustness of the implementation.
hannesrudolph
added
PR - Needs Preliminary Review
and removed
Issue/PR - Triage
Fixes #7926
Summary
This PR adds a workspace-level toggle to enable/disable codebase indexing per folder, accessible from the settings pop-up below the chatbox.
Changes
How it works
Testing
Screenshots
The new workspace toggle appears in the Code Index settings popover when indexing is enabled globally.
Important
Adds a workspace-level toggle for codebase indexing, allowing per-workspace control and persistence across sessions, with comprehensive UI and backend support.
CodeIndexPopover.tsx.CodeIndexConfigManagerto manage workspace-specific settings.workspaceIndexEnabledtocodebaseIndexConfigSchemaincodebase-index.ts.CodeIndexPopover.tsxfor workspace-level control.settings.jsonfor new UI elements.workspace-indexing-toggle.spec.tsfor unit tests of new functionality.manager.spec.tsto test integration withCodeIndexManager.This description was created by
for b887bd2. You can customize this summary. It will automatically update as commits are pushed.