fix: Clean up non-visible diagnostics (#3867)

fixtures/workspaces/single/py/test.py

@@ -4,3 +4,5 @@
 print(foo.islower())
 print(foo.isupper())
 print(foo.isprintable())
+
+# Stop the execution of the script

packages/client/src/applyCorrections.mts

@@ -7,7 +7,7 @@ import * as di from './di.mjs';
 import { toRegExp } from './extensionRegEx/evaluateRegExp.js';
 import * as Settings from './settings/index.mjs';
 import { logErrors, showErrors } from './util/errors.js';
-import { findEditor, findTextDocument } from './util/findEditor.js';
+import { findEditor, findTextDocument } from './vscode/findEditor.js';
 import { pvShowErrorMessage, pvShowInformationMessage } from './util/vscodeHelpers.js';
 
 const propertyFixSpellingWithRenameProvider = Settings.ConfigFields.fixSpellingWithRenameProvider;

packages/client/src/codeActions/actionSuggestSpellingCorrections.mts

@@ -6,7 +6,7 @@ import { extractMatchingDiagRanges, getCSpellDiags } from '../diags.mjs';
 import { toRange } from '../languageServer/clientHelpers.js';
 import type { RangeLike } from '../languageServer/models.js';
 import { ConfigFields, getSettingFromVSConfig } from '../settings/index.mjs';
-import { findEditor } from '../util/findEditor.js';
+import { findEditor } from '../vscode/findEditor.js';
 import { pVoid } from '../util/pVoid.js';
 
 interface SuggestionQuickPickItem extends QuickPickItem {

packages/client/src/decorators/decorateIssues.mts

@@ -10,7 +10,7 @@ import type { IssueTracker, SpellingCheckerIssue } from '../issueTracker.mjs';
 import type { CSpellSettings } from '../settings/index.mjs';
 import { ConfigFields } from '../settings/index.mjs';
 import { setContext } from '../storage/context.mjs';
-import { findEditor } from '../util/findEditor.js';
+import { findEditor } from '../vscode/findEditor.js';
 
 const defaultHideIssuesWhileTyping: Required<PartialCSpellUserSettings<'hideIssuesWhileTyping'>>['hideIssuesWhileTyping'] = 'Word';
 const defaultRevealIssuesAfterDelayMS: Required<PartialCSpellUserSettings<'revealIssuesAfterDelayMS'>>['revealIssuesAfterDelayMS'] = 1000;

packages/client/src/diags.mts

@@ -1,6 +1,6 @@
 import type { IssueType } from '@cspell/cspell-types';
 import { createDisposableList } from 'utils-disposables';
-import type { Diagnostic, Disposable, Event, Range, Selection, TextDocument, Uri } from 'vscode';
+import type { Diagnostic, Disposable, Event, Range, Selection, TabChangeEvent, TextDocument, TextEditor, Uri } from 'vscode';
 import vscode from 'vscode';
 
 import { diagnosticSource } from './constants.js';
@@ -10,6 +10,7 @@ import type { CSpellSettings } from './settings/CSpellSettings.mjs';
 import { isWordLike } from './settings/CSpellSettings.mjs';
 import { ConfigFields } from './settings/index.mjs';
 import { isDefined, uniqueFilter } from './util/index.mjs';
+import { createIsUriVisibleFilter } from './vscode/createIsUriVisibleFilter.mjs';
 
 /**
  * Return cspell diags for a given uri.
@@ -121,14 +122,29 @@ export function registerDiagWatcher(show: boolean, onShowChange: Event<boolean>)
             }
         });
 
+        const isUriInUse = createIsUriVisibleFilter(true);
+
         for (const uri of uris) {
-            if (!useDiagnosticsCollectionForScheme(uri)) continue;
-            const diags = issueTracker.getSpellingIssues(uri);
+            if (!useDiagnosticsCollectionForScheme(uri)) {
+                collection.set(uri, undefined);
+                continue;
+            }
+            const diags = (isUriInUse(uri) && issueTracker.getSpellingIssues(uri)) || undefined;
             collection.set(
                 uri,
                 diags?.map((issue) => issue.diag),
             );
         }
+
+        for (const [uri] of collection) {
+            if (useDiagnosticsCollectionForScheme(uri) || isUriInUse(uri)) continue;
+            collection.set(uri, undefined);
+        }
+    }
+
+    function onDidChange(_event: TabChangeEvent | readonly TextEditor[]) {
+        // console.log('OnDidChange: %o', _event);
+        updateDiags();
     }
 
     dList.push(
@@ -138,6 +154,8 @@ export function registerDiagWatcher(show: boolean, onShowChange: Event<boolean>)
             updateDiags();
         }),
         vscode.workspace.onDidChangeConfiguration(updateConfig),
+        vscode.window.onDidChangeVisibleTextEditors(onDidChange),
+        vscode.window.tabGroups.onDidChangeTabs(onDidChange),
         issueTracker.onDidChangeDiagnostics(({ uris }) => updateDiags(uris)),
     );
 

packages/client/src/issueTracker.mts

@@ -8,7 +8,7 @@ import { workspace } from 'vscode';
 
 import type { CSpellClient, DiagnosticsFromServer, SpellCheckerDiagnosticData } from './client/index.mjs';
 import { createEmitter } from './Subscribables/index.js';
-import { findTextDocument } from './util/findEditor.js';
+import { findTextDocument } from './vscode/findEditor.js';
 
 type UriString = string;
 

packages/client/src/issueViewer/issueFilter.mts

@@ -1,47 +1,8 @@
 import type { Uri } from 'vscode';
-import { window } from 'vscode';
+
+import { createIsUriVisibleFilter } from '../vscode/createIsUriVisibleFilter.mjs';
 
 export function createIsItemVisibleFilter<T extends { uri: Uri }>(onlyVisible: boolean): (item: T) => boolean {
     const filter = createIsUriVisibleFilter(onlyVisible);
     return (item: T) => filter(item.uri);
 }
-
-export function createIsUriVisibleFilter(onlyVisible: boolean): (uri: Uri) => boolean {
-    if (!onlyVisible) return () => true;
-    // Use the path to avoid scheme issues.
-    const tabs = extractUrisFromTabs();
-
-    const visibleUris = new Set([
-        ...tabs.map((tab) => tab.uri.toString()),
-        ...window.visibleTextEditors.map((e) => e.document.uri.toString()),
-    ]);
-    return (uri: Uri) => {
-        const h = visibleUris.has(uri.toString());
-        // console.log('isUriVisible', uri.toString(), h);
-        return h;
-    };
-}
-
-interface TabUri {
-    label: string;
-    uri: Uri;
-}
-
-function extractUrisFromTabs(): TabUri[] {
-    const tabs: TabUri[] = [];
-
-    for (const tg of window.tabGroups.all) {
-        for (const tab of tg.tabs) {
-            const { label, input } = tab;
-            if (hasUri(input)) {
-                tabs.push({ label, uri: input.uri });
-            }
-        }
-    }
-    return tabs;
-}
-
-function hasUri<T extends { uri: Uri }>(v: T | unknown): v is T {
-    if (!v || typeof v !== 'object') return false;
-    return 'uri' in v;
-}

packages/client/src/issueViewer/issuesViewerByFile.mts

@@ -12,8 +12,8 @@ import type { IssueTracker, SpellingCheckerIssue } from '../issueTracker.mjs';
 import { consoleDebug } from '../repl/consoleDebug.mjs';
 import { findConicalDocument, findNotebookCellForDocument } from '../util/documentUri.js';
 import { handleErrors, logErrors } from '../util/errors.js';
-import { findTextDocument } from '../util/findEditor.js';
 import { isDefined } from '../util/index.mjs';
+import { findTextDocument } from '../vscode/findEditor.js';
 import { getIconForSpellingIssue, icons } from './icons.mjs';
 import { createIsItemVisibleFilter } from './issueFilter.mjs';
 import { IssueTreeItemBase } from './IssueTreeItemBase.js';
@@ -217,6 +217,7 @@ class IssuesTreeDataProvider implements TreeDataProvider<IssueTreeItemBase> {
         this.disposeList.push(
             this.emitOnDidChange,
             vscode.window.onDidChangeVisibleTextEditors(() => this.updateChild()),
+            vscode.window.tabGroups.onDidChangeTabs(() => this.updateChild()),
         );
         options.issueTracker.then((tracker) => {
             this.issueTracker = tracker;

packages/client/src/issueViewer/unknownWordsViewer.mts

@@ -122,6 +122,7 @@ class UnknownWordsTreeDataProvider implements TreeDataProvider<IssueTreeItemBase
         this.disposeList.push(
             this.emitOnDidChange,
             vscode.window.onDidChangeVisibleTextEditors(() => this.refresh()),
+            vscode.window.tabGroups.onDidChangeTabs(() => this.refresh()),
         );
         if (this.options.issueTracker) {
             this.setIssuesTracker(this.options.issueTracker);

packages/client/src/promptUser.mts

@@ -3,7 +3,7 @@ import { Uri, window } from 'vscode';
 
 import { extractMatchingDiagTexts, getCSpellDiags } from './diags.mjs';
 import { normalizeWords } from './settings/CSpellSettings.mjs';
-import { findEditor } from './util/findEditor.js';
+import { findEditor } from './vscode/findEditor.js';
 import { toUri } from './util/uriHelper.mjs';
 
 const compareStrings = new Intl.Collator().compare;

packages/client/src/util/documentUri.ts

@@ -1,7 +1,7 @@
 import type { ConfigurationScope, NotebookCell, NotebookDocument, TextDocument } from 'vscode';
 import { Uri, workspace } from 'vscode';
 
-import { findTextDocument } from './findEditor';
+import { findTextDocument } from '../vscode/findEditor';
 
 const _schemeBlocked = {
     git: true,

packages/client/src/vscode/createIsUriVisibleFilter.mts

@@ -0,0 +1,19 @@
+import { type Uri, window } from 'vscode';
+
+import { findTabsWithUriInput } from './tabs.mjs';
+
+export function createIsUriVisibleFilter(onlyVisible: boolean): (uri: Uri) => boolean {
+    if (!onlyVisible) return () => true;
+    // Use the path to avoid scheme issues.
+    const tabs = findTabsWithUriInput();
+
+    const visibleUris = new Set([
+        ...tabs.map((tab) => tab.uri.toString()),
+        ...window.visibleTextEditors.map((e) => e.document.uri.toString()),
+    ]);
+    return (uri: Uri) => {
+        const h = visibleUris.has(uri.toString());
+        // console.log('isUriVisible', uri.toString(), h);
+        return h;
+    };
+}

packages/client/src/util/findEditor.ts → packages/client/src/vscode/findEditor.ts

@@ -1,5 +1,5 @@
-import type { TextDocument, TextEditor, Uri } from 'vscode';
-import { window, workspace } from 'vscode';
+import type { TextDocument, TextEditor } from 'vscode';
+import { Uri, window, workspace } from 'vscode';
 
 export function findEditor(uri?: Uri | string): TextEditor | undefined {
     if (!uri) return window.activeTextEditor;

packages/client/src/vscode/isUriResource.mts

@@ -0,0 +1,8 @@
+import { Uri } from 'vscode';
+
+interface UriResource {
+    readonly uri: Uri;
+}
+export function isUriResource<T extends UriResource>(r: unknown | undefined): r is T {
+    return r instanceof Object && 'uri' in r && r.uri instanceof Uri;
+}

packages/client/src/vscode/tabs.mts

@@ -0,0 +1,39 @@
+import type { Tab, Uri } from 'vscode';
+import { window } from 'vscode';
+
+import { isUriResource } from './isUriResource.mjs';
+
+interface TabUri {
+    label: string;
+    uri: Uri;
+    tab: Tab;
+}
+export function findTabsWithUriInput(): TabUri[] {
+    const tabs: TabUri[] = [];
+
+    for (const tg of window.tabGroups.all) {
+        for (const tab of tg.tabs) {
+            const { label, input } = tab;
+            if (hasUri(input)) {
+                tabs.push({ tab, label, uri: input.uri });
+            }
+        }
+    }
+    return tabs;
+}
+function hasUri<T extends { uri: Uri }>(v: T | unknown): v is T {
+    if (!v || typeof v !== 'object') return false;
+    return 'uri' in v;
+}
+
+export function extractUrisFromTabs(): Uri[] {
+    return window.tabGroups.all
+        .flatMap((tabGroup) => tabGroup.tabs)
+        .map((tab) => tab.input)
+        .filter(isUriResource)
+        .map((r) => r.uri);
+}
+
+export function findAllOpenUrisInTabs(): Uri[] {
+    return extractUrisFromTabs();
+}

packages/client/src/webview/AppState/store.mts

@@ -2,7 +2,7 @@ import type { DisposableClassic, DisposableHybrid, DisposableLike } from 'utils-
 import { createDisposable, createDisposableFromList, disposeOf, injectDisposable } from 'utils-disposables';
 import { LogLevelMasks } from 'utils-logger';
 import type { TextDocument, TextEditor, Uri } from 'vscode';
-import { window } from 'vscode';
+import { window, workspace } from 'vscode';
 import type { WatchFieldList, WatchFields } from 'webview-api';
 
 import { getDependencies } from '../../di.mjs';
@@ -130,12 +130,8 @@ export function watchFieldList(fieldsToWatch: Set<WatchFields>, onChange: (chang
 }
 
 function findMatchTextDocument(url: UrlLike): TextDocument | undefined {
-    return findMatchingEditor(url)?.document;
-}
-
-function findMatchingEditor(url: UrlLike): TextEditor | undefined {
-    for (const editor of window.visibleTextEditors) {
-        if (!compareUrl(editor.document.uri, url)) return editor;
+    for (const doc of workspace.textDocuments) {
+        if (!compareUrl(doc.uri, url)) return doc;
     }
     return undefined;
 }