Implement a way to determine if an extension is conflicting with VSCo…

…de-YAML

Signed-off-by: Josh Pinkney <[email protected]>

src/extension.ts

@@ -22,6 +22,7 @@ import { CUSTOM_SCHEMA_REQUEST, CUSTOM_CONTENT_REQUEST, SchemaExtensionAPI } fro
 import { joinPath } from './paths';
 import { getJsonSchemaContent, JSONSchemaDocumentContentProvider } from './json-schema-content-provider';
 import { JSONSchemaCache } from './json-schema-cache';
+import { getConflictingExtensions, showUninstallConflictsNotification } from './extensionConflicts';
 
 export interface ISchemaAssociations {
   [pattern: string]: string[];
@@ -104,13 +105,15 @@ export function activate(context: ExtensionContext): SchemaExtensionAPI {
     workspace.registerTextDocumentContentProvider('json-schema', new JSONSchemaDocumentContentProvider(schemaCache))
   );
 
+  findConflicts();
   client.onReady().then(() => {
     // Send a notification to the server with any YAML schema associations in all extensions
     client.sendNotification(SchemaAssociationNotification.type, getSchemaAssociations());
 
     // If the extensions change, fire this notification again to pick up on any association changes
     extensions.onDidChange(() => {
       client.sendNotification(SchemaAssociationNotification.type, getSchemaAssociations());
+      findConflicts();
     });
     // Tell the server that the client is ready to provide custom schema content
     client.sendNotification(DynamicCustomSchemaRequestRegistration.type);
@@ -131,6 +134,18 @@ export function activate(context: ExtensionContext): SchemaExtensionAPI {
   return schemaExtensionAPI;
 }
 
+/**
+ * Finds extensions that conflict with VSCode-YAML.
+ * If one or more conflicts are found then show an uninstall notification
+ * If no conflicts are found then do nothing
+ */
+function findConflicts(): void {
+  const conflictingExtensions = getConflictingExtensions();
+  if (conflictingExtensions.length > 0) {
+    showUninstallConflictsNotification(conflictingExtensions);
+  }
+}
+
 function getSchemaAssociations(): ISchemaAssociation[] {
   const associations: ISchemaAssociation[] = [];
   extensions.all.forEach((extension) => {

src/extensionConflicts.ts

@@ -0,0 +1,51 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Red Hat, Inc. All rights reserved..
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+import { commands, Extension, extensions, window } from 'vscode';
+
+// A set of VSCode extension ID's that conflict with VSCode-YAML
+const conflictingIDs = new Set(['vscoss.vscode-ansible', 'ms-vscode-deploy-azure.azure-deploy']);
+
+/**
+ * Get all of the installed extensions that currently conflict with VSCode-YAML
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function getConflictingExtensions(): Extension<any>[] {
+  const conflictingExtensions = [];
+  conflictingIDs.forEach((extension) => {
+    const ext = extensions.getExtension(extension);
+    if (ext) {
+      conflictingExtensions.push(ext);
+    }
+  });
+  return conflictingExtensions;
+}
+
+/**
+ * Display the uninstall conflicting extension notification if there are any conflicting extensions currently installed
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function showUninstallConflictsNotification(conflictingExts: Extension<any>[]): void {
+  const uninstallMsg = 'Uninstall';
+
+  // Gather all the conflicting display names
+  let conflictMsg = '';
+  if (conflictingExts.length === 1) {
+    conflictMsg = `${conflictingExts[0].packageJSON.displayName} extension is incompatible with VSCode-YAML. Please uninstall it.`;
+  } else {
+    const extNames = [];
+    conflictingExts.forEach((ext) => {
+      extNames.push(ext.packageJSON.displayName);
+    });
+    conflictMsg = `The ${extNames.join(', ')} extensions are incompatible with VSCode-YAML. Please uninstall them.`;
+  }
+
+  window.showInformationMessage(conflictMsg, uninstallMsg).then((clickedMsg) => {
+    if (clickedMsg === uninstallMsg) {
+      conflictingExts.forEach((ext) => {
+        commands.executeCommand('workbench.extensions.uninstallExtension', ext.id);
+      });
+    }
+  });
+}