Add matchOnDetail and matchOnDescription to all quick picks

iterative · Jul 19, 2023 · 5e97e92 · 5e97e92
1 parent 996c610
commit 5e97e92
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 17 deletions.
diff --git a/extension/src/experiments/model/quickPick.test.ts b/extension/src/experiments/model/quickPick.test.ts
@@ -83,8 +83,7 @@ describe('pickExperimentsToPlot', () => {
         }
       ],
       MAX_SELECTED_EXPERIMENTS,
-      Title.SELECT_EXPERIMENTS_TO_PLOT,
-      { matchOnDescription: true, matchOnDetail: true }
+      { title: Title.SELECT_EXPERIMENTS_TO_PLOT }
     )
   })
 
@@ -192,8 +191,7 @@ describe('pickExperimentsToPlot', () => {
       ],
       [],
       MAX_SELECTED_EXPERIMENTS,
-      Title.SELECT_EXPERIMENTS_TO_PLOT,
-      { matchOnDescription: true, matchOnDetail: true }
+      { title: Title.SELECT_EXPERIMENTS_TO_PLOT }
     )
   })
 })

diff --git a/extension/src/experiments/model/quickPick.ts b/extension/src/experiments/model/quickPick.ts
@@ -84,8 +84,7 @@ export const pickExperimentsToPlot = (
     items,
     selectedItems,
     MAX_SELECTED_EXPERIMENTS,
-    Title.SELECT_EXPERIMENTS_TO_PLOT,
-    { matchOnDescription: true, matchOnDetail: true }
+    { title: Title.SELECT_EXPERIMENTS_TO_PLOT }
   )
 }
 

diff --git a/extension/src/test/suite/experiments/index.test.ts b/extension/src/test/suite/experiments/index.test.ts
@@ -1000,7 +1000,12 @@ suite('Experiments Test Suite', () => {
           picked: column.selected,
           value: column
         })),
-        { canPickMany: true, title: Title.SELECT_COLUMNS }
+        {
+          canPickMany: true,
+          matchOnDescription: true,
+          matchOnDetail: true,
+          title: Title.SELECT_COLUMNS
+        }
       )
 
       await tableChangePromise

diff --git a/extension/src/test/suite/experiments/model/filterBy/tree.test.ts b/extension/src/test/suite/experiments/model/filterBy/tree.test.ts
@@ -193,7 +193,12 @@ suite('Experiments Filter By Tree Test Suite', () => {
             })
           }
         ],
-        { canPickMany: true, title: Title.SELECT_FILTERS_TO_REMOVE }
+        {
+          canPickMany: true,
+          matchOnDescription: true,
+          matchOnDetail: true,
+          title: Title.SELECT_FILTERS_TO_REMOVE
+        }
       )
 
       mockShowInputBox.resetHistory()

diff --git a/extension/src/test/suite/vscode/quickPick.test.ts b/extension/src/test/suite/vscode/quickPick.test.ts
@@ -89,7 +89,7 @@ suite('Quick Pick Test Suite', () => {
         items,
         items.slice(0, maxSelectedItems),
         maxSelectedItems,
-        'select up to 3 values' as Title
+        { title: 'select up to 3 values' as Title }
       )
 
       expect(
@@ -130,7 +130,7 @@ suite('Quick Pick Test Suite', () => {
         items,
         items.slice(0, maxSelectedItems - 1),
         maxSelectedItems,
-        'select up to 5 values' as Title
+        { title: 'select up to 5 values' as Title }
       )
 
       expect(

diff --git a/extension/src/vscode/quickPick.test.ts b/extension/src/vscode/quickPick.test.ts
@@ -55,6 +55,8 @@ describe('quickPickValue', () => {
     const probablyC = await quickPickValue(items, { placeHolder, title })
     expect(mockedShowQuickPick).toHaveBeenCalledWith(items, {
       canPickMany: false,
+      matchOnDescription: true,
+      matchOnDetail: true,
       placeHolder,
       title
     })
@@ -93,6 +95,8 @@ describe('quickPickManyValues', () => {
     const result = await quickPickManyValues(items, { placeHolder, title })
     expect(mockedShowQuickPick).toHaveBeenCalledWith(items, {
       canPickMany: true,
+      matchOnDescription: true,
+      matchOnDetail: true,
       placeHolder,
       title
     })
@@ -109,6 +113,8 @@ describe('quickPickOne', () => {
 
     expect(mockedShowQuickPick).toHaveBeenCalledWith(['a', 'b', 'c'], {
       canPickMany: false,
+      matchOnDescription: true,
+      matchOnDetail: true,
       title
     })
     expect(noResponse).toStrictEqual(undefined)
@@ -140,6 +146,8 @@ describe('quickPickYesOrNo', () => {
       ],
       {
         canPickMany: false,
+        matchOnDescription: true,
+        matchOnDetail: true,
         placeHolder,
         title
       }

diff --git a/extension/src/vscode/quickPick.ts b/extension/src/vscode/quickPick.ts
@@ -2,6 +2,8 @@ import { QuickPickOptions, QuickPickItem, window, QuickPick } from 'vscode'
 import { Response } from './response'
 import { Title } from './title'
 
+const DEFAULT_OPTIONS = { matchOnDescription: true, matchOnDetail: true }
+
 export interface QuickPickItemWithValue<T = string> extends QuickPickItem {
   value: T
 }
@@ -16,6 +18,7 @@ export const quickPickValue: <T = string>(
 ) => Thenable<T | undefined> = async (items, options) => {
   const result = await window.showQuickPick(items, {
     canPickMany: false,
+    ...DEFAULT_OPTIONS,
     ...options
   })
   return result?.value
@@ -26,6 +29,7 @@ export const quickPickManyValues: <T = string>(
   options: Omit<QuickPickOptionsWithTitle, 'canPickMany'>
 ) => Thenable<T[] | undefined> = async (items, options = {}) => {
   const result = await window.showQuickPick(items, {
+    ...DEFAULT_OPTIONS,
     ...options,
     canPickMany: true
   })
@@ -38,6 +42,7 @@ export const quickPickOne = (
   title: string
 ): Thenable<string | undefined> =>
   window.showQuickPick(items, {
+    ...DEFAULT_OPTIONS,
     canPickMany: false,
     title
   })
@@ -49,17 +54,17 @@ const createQuickPick = <T>(
     canSelectMany: boolean
     placeholder?: string
     title: Title
-    matchOnDescription?: boolean
-    matchOnDetail?: boolean
+    matchOnDescription: boolean
+    matchOnDetail: boolean
   }
 ): QuickPick<QuickPickItemWithValue<T>> => {
   const quickPick = window.createQuickPick<QuickPickItemWithValue<T>>()
 
   quickPick.canSelectMany = options.canSelectMany
   quickPick.placeholder = options.placeholder
   quickPick.title = options.title
-  quickPick.matchOnDescription = options.matchOnDescription || false
-  quickPick.matchOnDetail = options.matchOnDetail || false
+  quickPick.matchOnDescription = options.matchOnDescription
+  quickPick.matchOnDetail = options.matchOnDetail
 
   quickPick.items = items
   if (selectedItems) {
@@ -75,6 +80,7 @@ export const quickPickOneOrInput = (
   new Promise(resolve => {
     const quickPick = createQuickPick<string>(items, undefined, {
       canSelectMany: false,
+      ...DEFAULT_OPTIONS,
       ...options
     })
 
@@ -189,13 +195,12 @@ export const quickPickLimitedValues = <T>(
   items: QuickPickItemWithValue<T>[],
   selectedItems: readonly QuickPickItemWithValue<T>[],
   maxSelectedItems: number,
-  title: Title,
-  options?: { matchOnDescription?: boolean; matchOnDetail?: boolean }
+  options: QuickPickOptions & { title: Title }
 ): Promise<Exclude<T, undefined>[] | undefined> =>
   new Promise(resolve => {
     const quickPick = createQuickPick(items, selectedItems, {
+      ...DEFAULT_OPTIONS,
       canSelectMany: true,
-      title,
       ...options
     })