Add setting to suppress notifications.

Author: JoeRobich

l10n/bundle.l10n.json

@@ -172,10 +172,9 @@
   "C# configuration has changed. Would you like to reload the window to apply your changes?": "C# configuration has changed. Would you like to reload the window to apply your changes?",
   "Nested Code Action": "Nested Code Action",
   "Fix All: ": "Fix All: ",
-  "{0} is not part of the open workspace. Not all language features will be available.": "{0} is not part of the open workspace. Not all language features will be available.",
+  "The active document is not part of the open workspace. Not all language features will be available.": "The active document is not part of the open workspace. Not all language features will be available.",
   "Dismiss": "Dismiss",
   "Do not show for this workspace": "Do not show for this workspace",
-  "Do not show again": "Do not show again",
   "Open solution": "Open solution",
   "Restart server": "Restart server",
   "C# Workspace Status": "C# Workspace Status",

package.json

@@ -1479,6 +1479,11 @@
             "default": false,
             "description": "%configuration.dotnet.server.suppressLspErrorToasts%"
           },
+          "dotnet.server.suppressMiscellaneousFilesToasts": {
+            "type": "boolean",
+            "default": false,
+            "description": "%configuration.dotnet.server.suppressMiscellaneousFilesToasts%"
+          },
           "dotnet.server.useServerGC": {
             "type": "boolean",
             "default": true,

package.nls.json

@@ -35,6 +35,7 @@
   "configuration.dotnet.server.extensionPaths": "Override for path to language server --extension arguments",
   "configuration.dotnet.server.crashDumpPath": "Sets a folder path where crash dumps are written to if the language server crashes.  Must be writeable by the user.",
   "configuration.dotnet.server.suppressLspErrorToasts": "Suppresses error toasts from showing up if the server encounters a recoverable error.",
+  "configuration.dotnet.server.suppressMiscellaneousFilesToasts": "Suppress warning toasts from showing up if the active document is outside the open workspace.",
   "configuration.dotnet.server.useServerGC": "Configure the language server to use .NET server garbage collection.  Server garbage collection generally provides better performance at the expensive of higher memory consumption.",
   "configuration.dotnet.enableXamlTools": "Enables XAML tools when using C# Dev Kit",
   "configuration.dotnet.projects.enableAutomaticRestore": "Enables automatic NuGet restore if the extension detects assets are missing.",

src/lsptoolshost/languageStatusBar.ts

@@ -85,6 +85,12 @@ class ProjectContextStatus {
             } else {
                 item.severity = vscode.LanguageStatusSeverity.Information;
             }
+
+            item.detail = e.context._vs_is_miscellaneous
+                ? vscode.l10n.t(
+                      'The active document is not part of the open workspace. Not all language features will be available.'
+                  )
+                : vscode.l10n.t('Active File Context');
         });
 
         // Trigger a refresh, but don't block creation on the refresh completing.

src/lsptoolshost/miscellaneousFileNotifier.ts

@@ -4,62 +4,55 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
+import * as crypto from 'crypto';
 import { RoslynLanguageServer } from './roslynLanguageServer';
 import { ActionOption, showWarningMessage } from '../shared/observers/utils/showMessage';
 import { ServerState } from './serverStateChange';
-import path = require('path');
+import { languageServerOptions } from '../shared/options';
 
-const NotifyMiscellaneousFilesOption = 'dotnet.miscellaneousFilesNotification.enabled';
-const RecentlyNotifiedDocuments = new Set<vscode.Uri>();
-const CooldownTime = 60 * 1000;
+const SuppressMiscellaneousFilesToastsOption = 'dotnet.server.suppressMiscellaneousFilesToasts';
+const NotifiedDocuments = new Set<string>();
 
 export function registerMiscellaneousFileNotifier(
     context: vscode.ExtensionContext,
     languageServer: RoslynLanguageServer
 ) {
-    context.workspaceState.update(NotifyMiscellaneousFilesOption, undefined);
-    context.globalState.update(NotifyMiscellaneousFilesOption, undefined);
+    context.workspaceState.update(SuppressMiscellaneousFilesToastsOption, undefined);
 
     languageServer._projectContextService.onActiveFileContextChanged((e) => {
-        if (RecentlyNotifiedDocuments.has(e.uri)) {
+        const hash = createHash(e.uri.toString(/*skipEncoding:*/ true));
+        if (NotifiedDocuments.has(hash)) {
             return;
         }
 
         if (!e.context._vs_is_miscellaneous || languageServer.state !== ServerState.ProjectInitializationComplete) {
             return;
         }
 
-        if (!context.globalState.get<boolean>(NotifyMiscellaneousFilesOption, true)) {
+        if (languageServerOptions.suppressMiscellaneousFilesToasts) {
             return;
         }
 
-        if (!context.workspaceState.get<boolean>(NotifyMiscellaneousFilesOption, true)) {
+        if (context.workspaceState.get<boolean>(SuppressMiscellaneousFilesToastsOption, false)) {
             return;
         }
 
-        RecentlyNotifiedDocuments.add(e.uri);
+        NotifiedDocuments.add(hash);
 
         const message = vscode.l10n.t(
-            '{0} is not part of the open workspace. Not all language features will be available.',
-            path.basename(e.uri.fsPath)
+            'The active document is not part of the open workspace. Not all language features will be available.'
         );
         const dismissItem = vscode.l10n.t('Dismiss');
         const disableWorkspace: ActionOption = {
             title: vscode.l10n.t('Do not show for this workspace'),
             action: async () => {
-                context.workspaceState.update(NotifyMiscellaneousFilesOption, false);
+                context.workspaceState.update(SuppressMiscellaneousFilesToastsOption, true);
             },
         };
-        const disableGlobal: ActionOption = {
-            title: vscode.l10n.t('Do not show again'),
-            action: async () => {
-                context.globalState.update(NotifyMiscellaneousFilesOption, false);
-            },
-        };
-        showWarningMessage(vscode, message, disableWorkspace, disableGlobal, dismissItem);
-
-        setTimeout(() => {
-            RecentlyNotifiedDocuments.delete(e.uri);
-        }, CooldownTime);
+        showWarningMessage(vscode, message, dismissItem, disableWorkspace);
     });
 }
+
+function createHash(data: string): string {
+    return crypto.createHash('sha256').update(data).digest('hex');
+}

src/shared/options.ts

@@ -80,6 +80,7 @@ export interface LanguageServerOptions {
     readonly componentPaths: { [key: string]: string } | null;
     readonly enableXamlTools: boolean;
     readonly suppressLspErrorToasts: boolean;
+    readonly suppressMiscellaneousFilesToasts: boolean;
     readonly useServerGC: boolean;
 }
 
@@ -411,6 +412,9 @@ class LanguageServerOptionsImpl implements LanguageServerOptions {
     public get suppressLspErrorToasts() {
         return readOption<boolean>('dotnet.server.suppressLspErrorToasts', false);
     }
+    public get suppressMiscellaneousFilesToasts() {
+        return readOption<boolean>('dotnet.server.suppressMiscellaneousFilesToasts', false);
+    }
     public get useServerGC() {
         return readOption<boolean>('dotnet.server.useServerGC', true);
     }