fix: Be able to enable/disable file type from info view (#3266)

streetsidesoftware · May 16, 2024 · 5a5a435 · 5a5a435
1 parent 9c3334b
commit 5a5a435
Show file tree

Hide file tree

Showing 28 changed files with 539 additions and 244 deletions.
diff --git a/docs/_includes/generated-docs/commands.md b/docs/_includes/generated-docs/commands.md
@@ -45,6 +45,7 @@
 | `cSpell.issueViewer.item.autoFixSpellingIssues`      | Fix issue with preferred suggestion in the current document.<br>**When:**<br> `view == cspell-info.issuesView`  |
 | `cSpell.issueViewer.item.openSuggestionsForIssue`    | Show Suggestions<br>**When:**<br> `view == cspell-info.issuesView`                                              |
 | `cSpell.logPerfTimeline`                             | Log CSpell performance times to console                                                                         |
+| `cSpell.openFileInfoView`                            | Open Spell Checker File Information View                                                                        |
 | `cSpell.openIssuesPanel`                             | Open Spell Checker Issues Panel                                                                                 |
 | `cSpell.removeWordFromFolderDictionary`              | Remove Words from the Folder Dictionary                                                                         |
 | `cSpell.removeWordFromUserDictionary`                | Remove Words from the Global Dictionary                                                                         |

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -571,12 +571,26 @@
         "shortTitle": "Open Spelling Issues",
         "icon": "$(eye)"
       },
+      {
+        "command": "cSpell.openFileInfoView",
+        "category": "Spell",
+        "title": "Open Spell Checker File Information View",
+        "shortTitle": "Open File Info",
+        "icon": "$(eye)"
+      },
       {
         "command": "cSpell.restart",
         "category": "Spell",
         "title": "Restart Spell Checker Server",
         "shortTitle": "Restart Spell Checker",
         "icon": "$(sync)"
+      },
+      {
+        "command": "cspell.showActionsMenu",
+        "category": "Spell",
+        "title": "Show Spell Checker Actions Menu",
+        "shortTitle": "Spell Checker Actions",
+        "icon": "$(list-unordered)"
       }
     ],
     "languages": [

diff --git a/packages/_server/src/config/documentSettings.test.mts b/packages/_server/src/config/documentSettings.test.mts
@@ -19,7 +19,7 @@ import {
     isUriAllowedBySettings,
     isUriBlockedBySettings,
 } from './documentSettings.mjs';
-import { isLanguageEnabled } from './extractEnabledFileTypes.mjs';
+import { isFileTypeEnabled } from './extractEnabledFileTypes.mjs';
 import { getConfiguration, getWorkspaceFolders } from './vscode.config.mjs';
 
 const { toEqualCaseInsensitive: expectToEqualCaseInsensitive } = extendExpect(expect);
@@ -228,7 +228,7 @@ describe('Validate DocumentSettings', () => {
         ${'typescript'} | ${{ enableFiletypes: ['!*'], checkOnlyEnabledFileTypes: false }}              | ${true}
         ${'java'}       | ${{ enableFiletypes: ['!*', 'java'], checkOnlyEnabledFileTypes: true }}       | ${true}
     `('isLanguageEnabled $languageId $settings', ({ languageId, settings, expected }) => {
-        expect(isLanguageEnabled(languageId, settings)).toBe(expected);
+        expect(isFileTypeEnabled(languageId, settings)).toBe(expected);
     });
 
     test('isExcludedBy', async () => {

diff --git a/packages/_server/src/config/extractEnabledFileTypes.mts b/packages/_server/src/config/extractEnabledFileTypes.mts
@@ -98,7 +98,7 @@ export function normalizeEnableFiletypes(enableFiletypes: string[]): string[] {
     return ids;
 }
 
-export function isLanguageEnabled(languageId: string, settings: CSpellUserSettings): boolean {
+export function isFileTypeEnabled(languageId: string, settings: CSpellUserSettings): boolean {
     const enabledFileTypes = extractEnabledFileTypes(settings);
     const enabled = enabledFileTypes[languageId];
     if (enabled !== undefined) return enabled;

diff --git a/packages/_server/src/server.mts b/packages/_server/src/server.mts
@@ -42,7 +42,7 @@ import {
     isUriBlockedBySettings,
     stringifyPatterns,
 } from './config/documentSettings.mjs';
-import { isLanguageEnabled } from './config/extractEnabledFileTypes.mjs';
+import { isFileTypeEnabled } from './config/extractEnabledFileTypes.mjs';
 import { objectFieldSizes, objectKeysNested, sanitizeSettings } from './config/sanitizeSettings.mjs';
 import type { TextDocumentUri } from './config/vscode.config.mjs';
 import { defaultCheckLimit } from './constants.mjs';
@@ -502,7 +502,7 @@ export function run(): void {
         const { uri, languageId } = textDocument;
         return (
             !!settings.enabled &&
-            (!languageId || isLanguageEnabled(languageId, settings)) &&
+            (!languageId || isFileTypeEnabled(languageId, settings)) &&
             !(await isUriExcluded(uri)) &&
             !isBlocked(textDocument, settings)
         );
@@ -542,7 +542,7 @@ export function run(): void {
     ): Promise<Api.IsSpellCheckEnabledResult> {
         log('calcIncludeExcludeInfo', params.uri);
         const { uri, languageId } = params;
-        const languageEnabled = languageId ? isLanguageEnabled(languageId, settings) : undefined;
+        const languageIdEnabled = languageId ? isFileTypeEnabled(languageId, settings) : undefined;
 
         const {
             include: fileIsIncluded = true,
@@ -565,7 +565,7 @@ export function run(): void {
             fileEnabled,
             fileIsExcluded,
             fileIsIncluded,
-            languageIdEnabled: languageEnabled,
+            languageIdEnabled: languageIdEnabled,
             languageId,
             gitignored,
             gitignoreInfo,