Prompt user to enable proposed APIs if server-side folder is open (intersystems-community#1140)

Author: isc-bsaviano

docs/SettingsReference.md

@@ -78,6 +78,7 @@ The extensions in the InterSystems ObjectScript Extension Pack provide many sett
 | `"objectscript.serverSourceControl .disableOtherActionTriggers"` | Prevent server-side source control 'other action' triggers from firing. | `boolean` | `false` | |
 | `"objectscript.showExplorer"` | Show the ObjectScript Explorer view. | `boolean` | `true` | |
 | `"objectscript.showGeneratedFileDecorations"` | Controls whether a badge is shown in the file explorer and open editors view for generated files. | `boolean` | `true` | |
+| `"objectscript.showProposedApiPrompt"` | Controls whether a prompt to enable VS Code proposed APIs is shown when a server-side workspace folder is opened. | `boolean` | `true` | |
 | `"objectscript.studioActionDebugOutput"` | Log in JSON format the action that VS Code should perform as requested by the server. | `boolean` | `false` | Actions will be logged to the `ObjectScript` Output channel. |
 | `"objectscript.suppressCompileErrorMessages"` | Suppress popup messages about errors during compile, but still focus on Output view. | `boolean` | `false` | |
 | `"objectscript.suppressCompileMessages"` | Suppress popup messages about successful compile. | `boolean` | `true` | |

package.json

@@ -1477,6 +1477,11 @@
           "description": "Controls whether a badge is shown in the file explorer and open editors view for generated files.",
           "type": "boolean",
           "default": true
+        },
+        "objectscript.showProposedApiPrompt": {
+          "description": "Controls whether a prompt to enable VS Code proposed APIs is shown when a server-side workspace folder is opened.",
+          "type": "boolean",
+          "default": true
         }
       }
     },

src/extension.ts

@@ -553,6 +553,38 @@ function languageServer(install = true): vscode.Extension<any> {
   return extension;
 }
 
+/** Show the proposed API prompt if required */
+function proposedApiPrompt(active: boolean, added?: readonly vscode.WorkspaceFolder[]): void {
+  if (
+    (added || vscode.workspace.workspaceFolders || []).some((e) => filesystemSchemas.includes(e.uri.scheme)) &&
+    !active &&
+    config("showProposedApiPrompt")
+  ) {
+    // Prompt the user with the proposed api install instructions
+    vscode.window
+      .showInformationMessage(
+        "[Searching across](https://code.visualstudio.com/docs/editor/codebasics#_search-across-files) and [quick opening](https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_quick-open) server-side files requires [VS Code proposed APIs](https://code.visualstudio.com/api/advanced-topics/using-proposed-api). Show the instructions?",
+        "Yes",
+        "Later",
+        "Never"
+      )
+      .then(async (action) => {
+        switch (action) {
+          case "Yes":
+            vscode.env.openExternal(
+              vscode.Uri.parse("https://github.com/intersystems-community/vscode-objectscript#enable-proposed-apis")
+            );
+            break;
+          case "Never":
+            config().update("showProposedApiPrompt", false, vscode.ConfigurationTarget.Global);
+            break;
+          case "Later":
+          default:
+        }
+      });
+  }
+}
+
 // The URIs of all classes that have been opened. Used when objectscript.openClassContracted is true.
 let openedClasses: string[];
 
@@ -744,6 +776,9 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
   // Create this here so we can fire its event
   const fileDecorationProvider = new FileDecorationProvider();
 
+  // Show the proposed API prompt if required
+  proposedApiPrompt(proposed.length > 0);
+
   context.subscriptions.push(
     reporter,
     panel,
@@ -1270,6 +1305,10 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
     }),
     vscode.commands.registerCommand("vscode-objectscript.modifyWsFolder", modifyWsFolder),
     vscode.commands.registerCommand("vscode-objectscript.openErrorLocation", openErrorLocation),
+    vscode.workspace.onDidChangeWorkspaceFolders((e) => {
+      // Show the proposed API prompt if required
+      proposedApiPrompt(proposed.length > 0, e.added);
+    }),
 
     /* Anything we use from the VS Code proposed API */
     ...proposed