Add allowPatterns configuration to enable selective inclusion of files ignored by gitignore patterns

Author: robertpiosik

packages/vscode/package.json

@@ -654,6 +654,13 @@
             "type": "string"
           }
         },
+        "codeWebChat.allowPatterns": {
+          "type": "array",
+          "scope": "resource",
+          "items": {
+            "type": "string"
+          }
+        },
         "codeWebChat.editFormatInstructionsWhole": {
           "type": "string",
           "scope": "resource"

packages/vscode/src/context/providers/open-editors/open-editors-provider.ts

@@ -50,7 +50,10 @@ export class OpenEditorsProvider
 
     this._config_change_handler = vscode.workspace.onDidChangeConfiguration(
       (event) => {
-        if (event.affectsConfiguration('codeWebChat.ignorePatterns')) {
+        if (
+          event.affectsConfiguration('codeWebChat.ignorePatterns') ||
+          event.affectsConfiguration('codeWebChat.allowPatterns')
+        ) {
           this._uncheck_ignored_files()
           this.refresh()
         }

packages/vscode/src/context/providers/workspace/workspace-provider.ts

@@ -45,7 +45,8 @@ export class WorkspaceProvider
   private _checked_items: Map<string, vscode.TreeItemCheckboxState> = new Map()
   private _checked_timestamps: Map<string, number> = new Map()
   private _combined_gitignore = ignore()
-  private _user_ignore: Ignore = ignore()
+  private _user_ignore_patterns: Ignore = ignore()
+  private _user_allow_patterns: Ignore = ignore()
   private _watcher: vscode.FileSystemWatcher
   private _ranges_watcher: vscode.FileSystemWatcher
   private _gitignore_watcher: vscode.FileSystemWatcher
@@ -89,7 +90,10 @@ export class WorkspaceProvider
 
     this._config_change_handler = vscode.workspace.onDidChangeConfiguration(
       (event) => {
-        if (event.affectsConfiguration('codeWebChat.ignorePatterns')) {
+        if (
+          event.affectsConfiguration('codeWebChat.ignorePatterns') ||
+          event.affectsConfiguration('codeWebChat.allowPatterns')
+        ) {
           this._load_ignore_patterns()
           this._uncheck_ignored_files()
           this.refresh()
@@ -1346,19 +1350,29 @@ export class WorkspaceProvider
       return true
     }
 
+    if (this._user_allow_patterns.ignores(relative_path)) {
+      return false
+    }
+
     return this._combined_gitignore.ignores(relative_path)
   }
 
   private _load_ignore_patterns() {
     const config = vscode.workspace.getConfiguration('codeWebChat')
     const patterns = config.get<string[]>('ignorePatterns')
-    this._user_ignore = ignore()
+    this._user_ignore_patterns = ignore()
     if (patterns) {
-      this._user_ignore.add(patterns)
+      this._user_ignore_patterns.add(patterns)
     }
 
-    this._user_ignore.add(IGNORE_PATTERNS)
-    this._user_ignore.add('node_modules')
+    this._user_ignore_patterns.add(IGNORE_PATTERNS)
+    this._user_ignore_patterns.add('node_modules')
+
+    const allow_patterns = config.get<string[]>('allowPatterns')
+    this._user_allow_patterns = ignore()
+    if (allow_patterns) {
+      this._user_allow_patterns.add(allow_patterns)
+    }
 
     // Clear token caches since exclusions have changed
     this._token_calculator.clear_caches()
@@ -1369,10 +1383,16 @@ export class WorkspaceProvider
     if (!workspace_root) {
       // To handle files outside of a workspace, we can only check filename patterns
       const basename = path.basename(file_path)
-      return this._user_ignore.ignores(basename)
+      if (this._user_allow_patterns.ignores(basename)) {
+        return false
+      }
+      return this._user_ignore_patterns.ignores(basename)
     }
     const relative_path = path.relative(workspace_root, file_path)
-    return this._user_ignore.ignores(relative_path)
+    if (this._user_allow_patterns.ignores(relative_path)) {
+      return false
+    }
+    return this._user_ignore_patterns.ignores(relative_path)
   }
 
   public is_partially_checked(path: string): boolean {

packages/vscode/src/views/settings/backend/message-handlers/handle-open-allow-patterns-settings.ts

@@ -0,0 +1,93 @@
+import * as vscode from 'vscode'
+import * as path from 'path'
+
+export const handle_open_allow_patterns_settings = async (): Promise<void> => {
+  const workspaceFolders = vscode.workspace.workspaceFolders
+  if (!workspaceFolders || workspaceFolders.length === 0) {
+    return
+  }
+
+  let selectedFolder: vscode.WorkspaceFolder | undefined
+
+  if (workspaceFolders.length > 1) {
+    const items = workspaceFolders.map((f) => ({ label: f.name, folder: f }))
+    selectedFolder = await new Promise<vscode.WorkspaceFolder | undefined>(
+      (resolve) => {
+        const quick_pick = vscode.window.createQuickPick<(typeof items)[0]>()
+        quick_pick.items = items
+        quick_pick.title = 'Workspaces'
+        quick_pick.placeholder =
+          'Select workspace folder to configure allow patterns'
+        const close_button: vscode.QuickInputButton = {
+          iconPath: new vscode.ThemeIcon('close'),
+          tooltip: 'Close'
+        }
+        quick_pick.buttons = [close_button]
+        let is_accepted = false
+        const disposables: vscode.Disposable[] = []
+        const cleanup = () => {
+          disposables.forEach((d) => d.dispose())
+          quick_pick.dispose()
+        }
+        disposables.push(
+          quick_pick.onDidAccept(() => {
+            is_accepted = true
+            const selected = quick_pick.selectedItems[0]
+            resolve(selected?.folder)
+            quick_pick.hide()
+          }),
+          quick_pick.onDidTriggerButton((button) => {
+            if (button === close_button) {
+              quick_pick.hide()
+            }
+          }),
+          quick_pick.onDidHide(() => {
+            if (!is_accepted) {
+              resolve(undefined)
+            }
+            cleanup()
+          })
+        )
+        quick_pick.show()
+      }
+    )
+  } else {
+    selectedFolder = workspaceFolders[0]
+  }
+
+  if (!selectedFolder) {
+    return
+  }
+
+  // Ensure key exists
+  const config = vscode.workspace.getConfiguration(
+    'codeWebChat',
+    selectedFolder.uri
+  )
+  const inspect = config.inspect('allowPatterns')
+
+  if (inspect?.workspaceFolderValue === undefined) {
+    await config.update(
+      'allowPatterns',
+      [],
+      vscode.ConfigurationTarget.WorkspaceFolder
+    )
+  }
+
+  // Open the file
+  const settingsPath = path.join(
+    selectedFolder.uri.fsPath,
+    '.vscode',
+    'settings.json'
+  )
+  const settingsUri = vscode.Uri.file(settingsPath)
+
+  try {
+    const doc = await vscode.workspace.openTextDocument(settingsUri)
+    await vscode.window.showTextDocument(doc)
+  } catch (e) {
+    vscode.window.showErrorMessage(
+      `Could not open settings file at ${settingsPath}`
+    )
+  }
+}

packages/vscode/src/views/settings/backend/message-handlers/index.ts

@@ -40,5 +40,6 @@ export * from './handle-update-are-automatic-checkpoints-disabled'
 export * from './handle-get-checkpoint-lifespan'
 export * from './handle-upsert-configuration'
 export * from './handle-open-ignore-patterns-settings'
+export * from './handle-open-allow-patterns-settings'
 export * from './handle-get-send-with-shift-enter'
 export * from './handle-update-send-with-shift-enter'

packages/vscode/src/views/settings/backend/settings-provider.ts

@@ -47,7 +47,8 @@ import {
   handle_update_ai_studio_user_id,
   handle_update_send_with_shift_enter,
   handle_upsert_configuration,
-  handle_open_ignore_patterns_settings
+  handle_open_ignore_patterns_settings,
+  handle_open_allow_patterns_settings
 } from './message-handlers'
 
 export class SettingsProvider {
@@ -233,6 +234,8 @@ export class SettingsProvider {
           await vscode.commands.executeCommand('workbench.action.openSettings')
         } else if (message.command == 'OPEN_IGNORE_PATTERNS_SETTINGS') {
           await handle_open_ignore_patterns_settings()
+        } else if (message.command == 'OPEN_ALLOW_PATTERNS_SETTINGS') {
+          await handle_open_allow_patterns_settings()
         } else if (message.command == 'UPSERT_CONFIGURATION') {
           await handle_upsert_configuration(this, message)
         }

packages/vscode/src/views/settings/frontend/Home/Home.tsx

@@ -108,6 +108,7 @@ type Props = {
   ) => void
   on_open_editor_settings: () => void
   on_open_ignore_patterns_settings: () => void
+  on_open_allow_patterns_settings: () => void
   on_add_provider: () => void
   on_delete_provider: (provider_name: string) => void
   on_edit_provider: (provider_name: string) => void
@@ -317,6 +318,9 @@ export const Home: React.FC<Props> = (props) => {
           on_open_ignore_patterns_settings={
             props.on_open_ignore_patterns_settings
           }
+          on_open_allow_patterns_settings={
+            props.on_open_allow_patterns_settings
+          }
           on_stuck_change={general_on_stuck_change}
         />
         <PresetsSection

packages/vscode/src/views/settings/frontend/Home/sections/GeneralSection.tsx

@@ -35,6 +35,7 @@ type Props = {
   ) => void
   on_open_editor_settings: () => void
   on_open_ignore_patterns_settings: () => void
+  on_open_allow_patterns_settings: () => void
   on_stuck_change: (is_stuck: boolean) => void
 }
 
@@ -116,6 +117,15 @@ export const GeneralSection = forwardRef<HTMLDivElement, Props>(
               </TextButton>
             }
           />
+          <Item
+            title="Allow patterns"
+            description="Glob patterns that you want to include despite being ignored by .gitignore."
+            slot_right={
+              <TextButton on_click={props.on_open_allow_patterns_settings}>
+                Open settings file
+              </TextButton>
+            }
+          />
           <Item
             title="Context Size Warning Threshold"
             description="Set the token count threshold for showing a warning about large context sizes."

packages/vscode/src/views/settings/frontend/Settings.tsx

@@ -125,6 +125,9 @@ export const Settings = () => {
       on_open_ignore_patterns_settings={
         settings_hook.handle_open_ignore_patterns_settings
       }
+      on_open_allow_patterns_settings={
+        settings_hook.handle_open_allow_patterns_settings
+      }
       on_reorder_providers={settings_hook.handle_reorder_providers}
       on_add_provider={settings_hook.handle_add_provider}
       on_delete_provider={settings_hook.handle_delete_provider}

packages/vscode/src/views/settings/frontend/hooks/use-settings.ts

@@ -259,6 +259,9 @@ export const use_settings = (vscode: any) => {
   const handle_open_ignore_patterns_settings = () =>
     post_message(vscode, { command: 'OPEN_IGNORE_PATTERNS_SETTINGS' })
 
+  const handle_open_allow_patterns_settings = () =>
+    post_message(vscode, { command: 'OPEN_ALLOW_PATTERNS_SETTINGS' })
+
   const handle_context_size_warning_threshold_change = (threshold: number) =>
     post_message(vscode, {
       command: 'UPDATE_CONTEXT_SIZE_WARNING_THRESHOLD',
@@ -349,6 +352,7 @@ export const use_settings = (vscode: any) => {
     handle_edit_context_system_instructions_change,
     handle_open_editor_settings,
     handle_open_ignore_patterns_settings,
+    handle_open_allow_patterns_settings,
     handle_context_size_warning_threshold_change,
     handle_edit_format_instructions_change,
     handle_automatic_checkpoints_toggle,