Adopt new VS Code APIs to improve QuickPicks (#1709)

Author: isc-bsaviano

package-lock.json

@@ -48,7 +48,7 @@
     }
   ],
   "engines": {
-    "vscode": "^1.104.0"
+    "vscode": "^1.109.0"
   },
   "enabledApiProposals": [
     "fileSearchProvider",
@@ -1775,7 +1775,7 @@
     "test": "node ./out/test/runTest.js",
     "lint": "eslint src/**",
     "lint-fix": "eslint --fix src/**",
-    "download-api": "dts dev 1.104.0",
+    "download-api": "dts dev 1.109.0",
     "postinstall": "npm run download-api"
   },
   "devDependencies": {
@@ -1786,7 +1786,7 @@
     "@types/mocha": "^7.0.2",
     "@types/node": "22.13.14",
     "@types/semver": "7.5.4",
-    "@types/vscode": "1.104.0",
+    "@types/vscode": "1.109.0",
     "@types/ws": "8.18.0",
     "@types/xmldom": "^0.1.34",
     "@typescript-eslint/eslint-plugin": "^8.15.0",

package.json

@@ -239,7 +239,7 @@ export async function exportAll(): Promise<any> {
       files = await vscode.window.showQuickPick(files, {
         canPickMany: true,
         ignoreFocusOut: true,
-        placeHolder: "Uncheck a file to exclude it. Press 'Escape' to cancel export.",
+        prompt: "Uncheck a file to exclude it. Press 'Escape' to cancel export.",
         title: "Files to Export",
       });
       if (files === undefined) {
@@ -355,7 +355,7 @@ export async function exportDocumentsToXMLFile(): Promise<void> {
     const confirmed = await new Promise<boolean>((resolve) => {
       const quickPick = vscode.window.createQuickPick();
       quickPick.title = `Export the following ${documents.length > 1 ? `${documents.length} documents` : "document"}?`;
-      quickPick.placeholder = "Click any item to confirm, or 'Escape' to cancel";
+      quickPick.prompt = "Click any item to confirm, or 'Escape' to cancel";
       quickPick.ignoreFocusOut = true;
       quickPick.onDidAccept(() => {
         resolve(true);

src/commands/export.ts

@@ -427,14 +427,24 @@ async function pickAdditions(
   return new Promise<string[]>((resolve) => {
     let result: string[] = [];
     const quickPick = vscode.window.createQuickPick<PickAdditionsItem>();
-    quickPick.title = `Select items in namespace '${api.ns.toUpperCase()}' to add to project '${project}'.`;
+    quickPick.title = `Select items in namespace '${api.ns}' to add to project '${project}'.`;
     quickPick.ignoreFocusOut = true;
     quickPick.canSelectMany = true;
     quickPick.keepScrollPosition = true;
     quickPick.matchOnDescription = true;
     quickPick.buttons = [
-      { iconPath: new vscode.ThemeIcon("library"), tooltip: "Show system items" },
-      { iconPath: new vscode.ThemeIcon("server-process"), tooltip: "Show generated items" },
+      {
+        iconPath: new vscode.ThemeIcon("library"),
+        tooltip: "System",
+        location: vscode.QuickInputButtonLocation.Input,
+        toggle: { checked: false },
+      },
+      {
+        iconPath: new vscode.ThemeIcon("server-process"),
+        tooltip: "Generated",
+        location: vscode.QuickInputButtonLocation.Input,
+        toggle: { checked: false },
+      },
     ];
 
     const getCSPRootItems = (): Promise<PickAdditionsItem[]> => {
@@ -548,67 +558,26 @@ async function pickAdditions(
     });
     quickPick.onDidTriggerButton((button) => {
       quickPick.busy = true;
-      if (button.tooltip.charAt(0) == "S") {
-        if (button.tooltip.includes("system")) {
-          // Update the button
-          quickPick.buttons = [
-            { iconPath: new vscode.ThemeIcon("library"), tooltip: "Hide system items" },
-            quickPick.buttons[1],
-          ];
-          // Change value of correct parameter in array
-          sys = "1";
-          if (["RTN", "INC", "OTH"].includes(category)) {
-            parameters[0] = sys;
-          } else if (category != undefined) {
-            parameters[1] = sys;
-          } else {
-            parameters[0] = sys;
-            parameters[4] = sys;
-          }
+      // Change value of correct parameter in array
+      if (button.tooltip == "System") {
+        sys = button.toggle.checked ? "1" : "0";
+        if (["RTN", "INC", "OTH"].includes(category)) {
+          parameters[0] = sys;
+        } else if (category != undefined) {
+          parameters[1] = sys;
         } else {
-          quickPick.buttons = [
-            quickPick.buttons[0],
-            { iconPath: new vscode.ThemeIcon("server-process"), tooltip: "Hide generated items" },
-          ];
-          gen = "1";
-          if (["RTN", "INC", "OTH"].includes(category)) {
-            parameters[1] = gen;
-          } else if (category != undefined) {
-            parameters[2] = gen;
-          } else {
-            parameters[1] = gen;
-            parameters[5] = gen;
-          }
+          parameters[0] = sys;
+          parameters[4] = sys;
         }
       } else {
-        if (button.tooltip.includes("system")) {
-          quickPick.buttons = [
-            { iconPath: new vscode.ThemeIcon("library"), tooltip: "Show system items" },
-            quickPick.buttons[1],
-          ];
-          sys = "0";
-          if (["RTN", "INC", "OTH"].includes(category)) {
-            parameters[0] = sys;
-          } else if (category != undefined) {
-            parameters[1] = sys;
-          } else {
-            parameters[0] = sys;
-            parameters[4] = sys;
-          }
+        gen = button.toggle.checked ? "1" : "0";
+        if (["RTN", "INC", "OTH"].includes(category)) {
+          parameters[1] = gen;
+        } else if (category != undefined) {
+          parameters[2] = gen;
         } else {
-          quickPick.buttons = [
-            quickPick.buttons[0],
-            { iconPath: new vscode.ThemeIcon("server-process"), tooltip: "Show generated items" },
-          ];
-          gen = "0";
-          if (["RTN", "INC", "OTH"].includes(category)) {
-            parameters[1] = gen;
-          } else if (category != undefined) {
-            parameters[2] = gen;
-          } else {
-            parameters[1] = gen;
-            parameters[5] = gen;
-          }
+          parameters[1] = gen;
+          parameters[5] = gen;
         }
       }
       // Refresh the items list

src/commands/project.ts

@@ -125,7 +125,7 @@ SELECT Name, Origin, 'x' AS MemberType, Parent, Internal, 0 AS NotInheritable, M
       }),
       {
         title: `All members of ${cls}`,
-        placeHolder: "Pick a member to show it in the editor",
+        prompt: "Pick a member to show it in the editor",
       }
     );
     if (!member) return;

src/commands/showAllClassMembers.ts

@@ -405,7 +405,7 @@ async function runHandler(
         {
           matchOnDetail: true,
           title: `Cannot ${action} tests from multiple roots at once`,
-          placeHolder: `Pick a root to ${action} tests from`,
+          prompt: `Pick a root to ${action} tests from`,
         }
       );
       if (picked) {

src/commands/unitTest.ts

@@ -157,7 +157,7 @@ export async function extractXMLFileContents(xmlUri?: vscode.Uri): Promise<void>
         canPickMany: true,
         ignoreFocusOut: true,
         title: "Pick the documents to extract",
-        placeHolder: "Files are created using your 'objectscript.export' settings",
+        prompt: "Files are created using your 'objectscript.export' settings",
       }
     );
     if (docsToExtract == undefined || docsToExtract.length == 0) {