Add localized MD/HTML file for guidance when incompatible VSIX (#8920)

Author: Colengms

Extension/Reinstalling the Extension.md

@@ -0,0 +1,32 @@
+<h1 data-loc-id="incompatible.extension.heading">Incompatible or Mismatched C/C++ Extension Binaries</h1>
+
+<p data-loc-id="incompat.extension.text1">The C/C++ extension includes native binaries.</p>
+
+<p data-loc-id="incompat.extension.text2">When installed via the marketplace UI in VS Code, the correct native binaries should be included.  If incompatible binaries were detected and the C/C++ extension had been installed via the marketplace UI in VS Code, <a href="https://github.com/microsoft/vscode/issues/new?assignees=&labels=&template=bug_report.md" data-loc-id="bug.report.link.title">please report the issue</a>.</p>
+
+<h1 data-loc-id="reinstalling.extension.heading">Reinstalling the C/C++ Extension</h1>
+
+<p data-loc-id="reinstall.extension.text1">When reinstalling an equivalent version of an extension, VS Code may reuse the existing extension directory. To prevent this from occurring when reinstalling the C/C++ extension, it may be necessary to first delete the existing extension directory.</p>
+
+<p data-loc-id="reinstall.extension.text2">Installed extension directories can be found under one of the following paths under your user directory (`%USERPROFILE%` on Windows, or `$HOME` on Linux and macOS)</p>
+
+<pre><code class="lang-bash">%USERPROFILE%\.vscode\extensions</code></pre>
+<pre><code class="lang-bash">%USERPROFILE%\.vscode-insiders\extensions</code></pre>
+<pre><code class="lang-bash">%USERPROFILE%\.vscode-exploration\extensions</code></pre>
+
+<p data-loc-id="reinstall.extension.text3">In a remote connection:</p>
+<pre><code class="lang-bash">$HOME/.vscode-server/extensions</code></pre>
+<pre><code class="lang-bash">$HOME/.vscode-server-insiders/extensions</code></pre>
+<pre><code class="lang-bash">$HOME/.vscode-server-exploration/extensions</code></pre>
+
+<p data-loc-id="reinstall.extension.text4">Example paths to installed C/C++ extension directories:</p>
+
+<p data-loc-id="reinstall.extension.text5">On Windows:</p>
+<pre><code class="lang-bash">%USERPROFILE%\.vscode\extensions\ms-vscode.cpptools-1.9.0</code></pre>
+
+<p data-loc-id="reinstall.extension.text6">On Linux:</p>
+<pre><code class="lang-bash">$HOME/.vscode/extensions/ms-vscode.cpptools-1.9.0</code></pre>
+
+<p data-loc-id="reinstall.extension.text7">Then reinstall via the marketplace UI in VS Code.</p>
+
+<p data-loc-id="reinstall.extension.text8">If the correct version of the extension fails to be deployed by VS Code, the correct VSIX for your system can be <a href="https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools" data-loc-id="download.vsix.link.title">downloaded from the VS Code marketplace web site</a> and installed using the `Install from VSIX...` option under the '...' menu in the marketplace UI in VS Code.</p>

Extension/gulpfile.js

@@ -26,7 +26,8 @@ const https = require('https');
 
 // Patterns to find HTML files
 const htmlFilesPatterns = [
-    "ui/**/*.html"
+    "ui/**/*.html",
+    "Reinstalling the Extension.md"
 ];
 
 // HTML files for walkthroughs are handled differently, as localization support
@@ -370,11 +371,6 @@ const generateLocalizedHtmlFiles = () => {
                 contents: Buffer.from(newContent, 'utf8')
             }));
         });
-        // Put the original in an 'en' directory.
-        this.queue(new vinyl({
-            path: path.join("html/en", relativePath),
-            contents: file.contents
-        }));
     });
 };
 

Extension/src/LanguageServer/extension.ts

@@ -158,6 +158,9 @@ function sendActivationTelemetry(): void {
 }
 
 async function checkVsixCompatibility(): Promise<void> {
+    const ignoreMismatchedCompatibleVsix: PersistentState<boolean> = new PersistentState<boolean>("CPP." + util.packageJson.version + ".ignoreMismatchedCompatibleVsix", false);
+    let resetIgnoreMismatchedCompatibleVsix: boolean = true;
+
     // Check to ensure the correct platform-specific VSIX was installed.
     const vsixManifestPath: string = path.join(util.extensionPath, ".vsixmanifest");
     // Skip the check if the file does not exist, such as when debugging cpptools.
@@ -218,15 +221,33 @@ async function checkVsixCompatibility(): Promise<void> {
                     console.log("Unrecognized TargetPlatform in .vsixmanifest");
                     break;
             }
+            const moreInfoButton: string = localize("more.info.button", "More Info");
+            const ignoreButton: string = localize("ignore.button", "Ignore");
+            let promise: Thenable<string | undefined> | undefined;
             if (!isPlatformCompatible) {
-                vscode.window.showErrorMessage(localize("vsix.platform.incompatible", "The target platform {0} specifed in the C/C++ Extension VSIX is not compatible with your system.", vsixTargetPlatform));
+                promise = vscode.window.showErrorMessage(localize("vsix.platform.incompatible", "The C/C++ extension installed does not match your system.", vsixTargetPlatform), moreInfoButton);
             } else if (!isPlatformMatching) {
-                vscode.window.showWarningMessage(localize("vsix.platform.mismatching", "The target platform {0} specifed in the C/C++ Extension VSIX does not match VS Code.", vsixTargetPlatform));
+                if (!ignoreMismatchedCompatibleVsix.Value) {
+                    resetIgnoreMismatchedCompatibleVsix = false;
+                    promise = vscode.window.showWarningMessage(localize("vsix.platform.mismatching", "The C/C++ extension installed is compatible with but does not match your system.", vsixTargetPlatform), moreInfoButton, ignoreButton);
+                }
+            }
+            if (promise) {
+                promise.then(async (value) => {
+                    if (value === moreInfoButton) {
+                        await vscode.commands.executeCommand("markdown.showPreview", vscode.Uri.file(util.getLocalizedHtmlPath("Reinstalling the Extension.md")));
+                    } else if (value === ignoreButton) {
+                        ignoreMismatchedCompatibleVsix.Value = true;
+                    }
+                });
             }
         } else {
             console.log("Unable to find TargetPlatform in .vsixmanifest");
         }
     }
+    if (resetIgnoreMismatchedCompatibleVsix) {
+        ignoreMismatchedCompatibleVsix.Value = false;
+    }
 }
 
 /**

Extension/src/common.ts

@@ -1031,11 +1031,13 @@ export function getLocaleId(): string {
 
 export function getLocalizedHtmlPath(originalPath: string): string {
     const locale: string = getLocaleId();
-    const localizedFilePath: string = getExtensionFilePath(path.join("dist/html/", locale, originalPath));
-    if (!fs.existsSync(localizedFilePath)) {
-        return getExtensionFilePath(originalPath);
+    if (!locale.startsWith("en")) {
+        const localizedFilePath: string = getExtensionFilePath(path.join("dist/html/", locale, originalPath));
+        if (fs.existsSync(localizedFilePath)) {
+            return localizedFilePath;
+        }
     }
-    return localizedFilePath;
+    return getExtensionFilePath(originalPath);
 }
 
 export interface LocalizeStringParams {