fix: Make sure open settings works as expected. (#4352)

Author: Jason3S

package.json

@@ -3831,20 +3831,20 @@
         "order": 4,
         "properties": {
           "cSpell.blockCheckingWhenAverageChunkSizeGreaterThan": {
-            "default": 80,
-            "markdownDescription": "The maximum average length of chunks of text without word breaks.\n\n\nA chunk is the characters between absolute word breaks.\nAbsolute word breaks match: `/[\\s,{}[\\]]/`\n\n\n**Error Message:** _Average word length is too long._\n\n\nIf you are seeing this message, it means that the file contains mostly long lines\nwithout many word breaks.",
+            "default": 200,
+            "markdownDescription": "The maximum average length of chunks of text without word breaks.\n\n\nA chunk is the characters between absolute word breaks.\nAbsolute word breaks match: `/[\\s,{}[\\]]/`\n\n\n**Error Message:** _Average word length is too long._\n\n\nIf you are seeing this message, it means that the file contains mostly long lines\nwithout many word breaks.\n\n\nHide this message using `#cSpell.enabledNotifications#`",
             "scope": "language-overridable",
             "type": "number"
           },
           "cSpell.blockCheckingWhenLineLengthGreaterThan": {
-            "default": 10000,
-            "markdownDescription": "The maximum line length.\n\n\nBlock spell checking if lines are longer than the value given.\nThis is used to prevent spell checking generated files.\n\n\n**Error Message:** _Lines are too long._",
+            "default": 20000,
+            "markdownDescription": "The maximum line length.\n\n\nBlock spell checking if lines are longer than the value given.\nThis is used to prevent spell checking generated files.\n\n\n**Error Message:** _Lines are too long._\n\n\nHide this message using `#cSpell.enabledNotifications#`",
             "scope": "language-overridable",
             "type": "number"
           },
           "cSpell.blockCheckingWhenTextChunkSizeGreaterThan": {
-            "default": 500,
-            "markdownDescription": "The maximum length of a chunk of text without word breaks.\n\n\nIt is used to prevent spell checking of generated files.\n\n\nA chunk is the characters between absolute word breaks.\nAbsolute word breaks match: `/[\\s,{}[\\]]/`, i.e. spaces or braces.\n\n\n**Error Message:** _Maximum word length exceeded._\n\n\nIf you are seeing this message, it means that the file contains a very long line\nwithout many word breaks.",
+            "default": 1000,
+            "markdownDescription": "The maximum length of a chunk of text without word breaks.\n\n\nIt is used to prevent spell checking of generated files.\n\n\nA chunk is the characters between absolute word breaks.\nAbsolute word breaks match: `/[\\s,{}[\\]]/`, i.e. spaces or braces.\n\n\n**Error Message:** _Maximum word length exceeded._\n\n\nIf you are seeing this message, it means that the file contains a very long line\nwithout many word breaks.\n\n\nHide this message using `#cSpell.enabledNotifications#`",
             "scope": "language-overridable",
             "type": "number"
           },
@@ -3927,7 +3927,7 @@
               "Lines too Long": true,
               "Maximum Word Length Exceeded": true
             },
-            "markdownDescription": "Control which notifications are displayed.",
+            "markdownDescription": "Control which notifications are displayed.\n\nSee:\n- `#cSpell.blockCheckingWhenLineLengthGreaterThan#`\n- `#cSpell.blockCheckingWhenTextChunkSizeGreaterThan#`\n- `#cSpell.blockCheckingWhenAverageChunkSizeGreaterThan#`",
             "properties": {
               "Average Word Length too Long": {
                 "markdownDescription": "Enable notifications if the average word size is too high.",

packages/_server/spell-checker-config.schema.json

@@ -3489,23 +3489,23 @@
       "order": 4,
       "properties": {
         "cSpell.blockCheckingWhenAverageChunkSizeGreaterThan": {
-          "default": 80,
-          "description": "The maximum average length of chunks of text without word breaks.\n\n\nA chunk is the characters between absolute word breaks. Absolute word breaks match: `/[\\s,{}[\\]]/`\n\n\n**Error Message:** _Average word length is too long._\n\n\nIf you are seeing this message, it means that the file contains mostly long lines without many word breaks.",
-          "markdownDescription": "The maximum average length of chunks of text without word breaks.\n\n\nA chunk is the characters between absolute word breaks.\nAbsolute word breaks match: `/[\\s,{}[\\]]/`\n\n\n**Error Message:** _Average word length is too long._\n\n\nIf you are seeing this message, it means that the file contains mostly long lines\nwithout many word breaks.",
+          "default": 200,
+          "description": "The maximum average length of chunks of text without word breaks.\n\n\nA chunk is the characters between absolute word breaks. Absolute word breaks match: `/[\\s,{}[\\]]/`\n\n\n**Error Message:** _Average word length is too long._\n\n\nIf you are seeing this message, it means that the file contains mostly long lines without many word breaks.\n\n\nHide this message using `#cSpell.enabledNotifications#`",
+          "markdownDescription": "The maximum average length of chunks of text without word breaks.\n\n\nA chunk is the characters between absolute word breaks.\nAbsolute word breaks match: `/[\\s,{}[\\]]/`\n\n\n**Error Message:** _Average word length is too long._\n\n\nIf you are seeing this message, it means that the file contains mostly long lines\nwithout many word breaks.\n\n\nHide this message using `#cSpell.enabledNotifications#`",
           "scope": "language-overridable",
           "type": "number"
         },
         "cSpell.blockCheckingWhenLineLengthGreaterThan": {
-          "default": 10000,
-          "description": "The maximum line length.\n\n\nBlock spell checking if lines are longer than the value given. This is used to prevent spell checking generated files.\n\n\n**Error Message:** _Lines are too long._",
-          "markdownDescription": "The maximum line length.\n\n\nBlock spell checking if lines are longer than the value given.\nThis is used to prevent spell checking generated files.\n\n\n**Error Message:** _Lines are too long._",
+          "default": 20000,
+          "description": "The maximum line length.\n\n\nBlock spell checking if lines are longer than the value given. This is used to prevent spell checking generated files.\n\n\n**Error Message:** _Lines are too long._\n\n\nHide this message using `#cSpell.enabledNotifications#`",
+          "markdownDescription": "The maximum line length.\n\n\nBlock spell checking if lines are longer than the value given.\nThis is used to prevent spell checking generated files.\n\n\n**Error Message:** _Lines are too long._\n\n\nHide this message using `#cSpell.enabledNotifications#`",
           "scope": "language-overridable",
           "type": "number"
         },
         "cSpell.blockCheckingWhenTextChunkSizeGreaterThan": {
-          "default": 500,
-          "description": "The maximum length of a chunk of text without word breaks.\n\n\nIt is used to prevent spell checking of generated files.\n\n\nA chunk is the characters between absolute word breaks. Absolute word breaks match: `/[\\s,{}[\\]]/`, i.e. spaces or braces.\n\n\n**Error Message:** _Maximum word length exceeded._\n\n\nIf you are seeing this message, it means that the file contains a very long line without many word breaks.",
-          "markdownDescription": "The maximum length of a chunk of text without word breaks.\n\n\nIt is used to prevent spell checking of generated files.\n\n\nA chunk is the characters between absolute word breaks.\nAbsolute word breaks match: `/[\\s,{}[\\]]/`, i.e. spaces or braces.\n\n\n**Error Message:** _Maximum word length exceeded._\n\n\nIf you are seeing this message, it means that the file contains a very long line\nwithout many word breaks.",
+          "default": 1000,
+          "description": "The maximum length of a chunk of text without word breaks.\n\n\nIt is used to prevent spell checking of generated files.\n\n\nA chunk is the characters between absolute word breaks. Absolute word breaks match: `/[\\s,{}[\\]]/`, i.e. spaces or braces.\n\n\n**Error Message:** _Maximum word length exceeded._\n\n\nIf you are seeing this message, it means that the file contains a very long line without many word breaks.\n\n\nHide this message using `#cSpell.enabledNotifications#`",
+          "markdownDescription": "The maximum length of a chunk of text without word breaks.\n\n\nIt is used to prevent spell checking of generated files.\n\n\nA chunk is the characters between absolute word breaks.\nAbsolute word breaks match: `/[\\s,{}[\\]]/`, i.e. spaces or braces.\n\n\n**Error Message:** _Maximum word length exceeded._\n\n\nIf you are seeing this message, it means that the file contains a very long line\nwithout many word breaks.\n\n\nHide this message using `#cSpell.enabledNotifications#`",
           "scope": "language-overridable",
           "type": "number"
         },
@@ -3594,8 +3594,8 @@
             "Lines too Long": true,
             "Maximum Word Length Exceeded": true
           },
-          "description": "Control which notifications are displayed.",
-          "markdownDescription": "Control which notifications are displayed.",
+          "description": "Control which notifications are displayed.\n\nSee:\n- `#cSpell.blockCheckingWhenLineLengthGreaterThan#`\n- `#cSpell.blockCheckingWhenTextChunkSizeGreaterThan#`\n- `#cSpell.blockCheckingWhenAverageChunkSizeGreaterThan#`",
+          "markdownDescription": "Control which notifications are displayed.\n\nSee:\n- `#cSpell.blockCheckingWhenLineLengthGreaterThan#`\n- `#cSpell.blockCheckingWhenTextChunkSizeGreaterThan#`\n- `#cSpell.blockCheckingWhenAverageChunkSizeGreaterThan#`",
           "properties": {
             "Average Word Length too Long": {
               "description": "Enable notifications if the average word size is too high.",

packages/_server/src/config/cspellConfig/SpellCheckerSettings.mts

@@ -441,6 +441,13 @@ export interface SpellCheckerBehaviorSettings {
 
     /**
      * Control which notifications are displayed.
+     *
+     * See:
+     * - `#cSpell.blockCheckingWhenLineLengthGreaterThan#`
+     * - `#cSpell.blockCheckingWhenTextChunkSizeGreaterThan#`
+     * - `#cSpell.blockCheckingWhenAverageChunkSizeGreaterThan#`
+     *
+     *
      * @title Enabled Notifications
      * @scope resource
      * @since 4.0.41

packages/_server/src/config/cspellConfig/SpellCheckerShouldCheckDocSettings.mts

@@ -11,8 +11,10 @@ export interface SpellCheckerShouldCheckDocSettings {
      * **Error Message:** _Lines are too long._
      *
      *
+     * Hide this message using `#cSpell.enabledNotifications#`
+     *
      * @scope language-overridable
-     * @default 10000
+     * @default 20000
      */
     blockCheckingWhenLineLengthGreaterThan?: number;
 
@@ -33,8 +35,11 @@ export interface SpellCheckerShouldCheckDocSettings {
      * If you are seeing this message, it means that the file contains a very long line
      * without many word breaks.
      *
+     *
+     * Hide this message using `#cSpell.enabledNotifications#`
+     *
      * @scope language-overridable
-     * @default 500
+     * @default 1000
      */
     blockCheckingWhenTextChunkSizeGreaterThan?: number;
 
@@ -52,8 +57,11 @@ export interface SpellCheckerShouldCheckDocSettings {
      * If you are seeing this message, it means that the file contains mostly long lines
      * without many word breaks.
      *
+     *
+     * Hide this message using `#cSpell.enabledNotifications#`
+     *
      * @scope language-overridable
-     * @default 80
+     * @default 200
      */
     blockCheckingWhenAverageChunkSizeGreaterThan?: number;
 

packages/client/src/actionMenu.mts

@@ -4,8 +4,7 @@ import { createDisposableList } from 'utils-disposables';
 import type { Disposable, QuickPickItem } from 'vscode';
 import vscode from 'vscode';
 
-import { knownCommands } from './commands.mjs';
-import { extensionId } from './constants.js';
+import { generateOpenSettingsCommand, knownCommands } from './commands.mjs';
 import { getClient } from './di.mjs';
 import { updateEnabledFileTypeForResource, updateEnabledSchemesResource } from './settings/settings.mjs';
 import { handleErrors } from './util/errors.js';
@@ -58,7 +57,10 @@ async function actionMenu(options: ActionsMenuOptions) {
             command: 'workbench.action.openGlobalKeybindings',
             arguments: ['Spell:'],
         }),
-        itemCommand({ title: '$(gear) Edit Settings...', command: 'workbench.action.openSettings', arguments: [extensionId] }),
+        itemCommand({
+            title: '$(gear) Edit Settings...',
+            ...generateOpenSettingsCommand(),
+        }),
     ].filter(isDefined);
 
     return quickPickMenu({ items, title: 'Spell Checker Actions Menu' }).catch(() => undefined);
@@ -250,8 +252,7 @@ function itemDocFileType(uri: vscode.Uri | undefined, fileType: string | undefin
     item.buttons = [
         new CommandButtonItem(new vscode.ThemeIcon('gear'), {
             title: 'Edit Enable File Type in Settings',
-            command: 'workbench.action.openSettings',
-            arguments: [ConfigFields.enabledFileTypes],
+            ...generateOpenSettingsCommand(ConfigFields.enabledFileTypes),
         }),
     ];
     return item;
@@ -268,8 +269,7 @@ function itemDocScheme(uri: vscode.Uri | undefined, schemeAllowed: boolean | und
     item.buttons = [
         new CommandButtonItem(new vscode.ThemeIcon('gear'), {
             title: 'Edit Enable Scheme in Settings',
-            command: 'workbench.action.openSettings',
-            arguments: [ConfigFields.enabledSchemes],
+            ...generateOpenSettingsCommand(ConfigFields.enabledSchemes),
         }),
     ];
     return item;

packages/client/src/commands.mts

@@ -14,6 +14,7 @@ import { actionAutoFixSpellingIssues, handleApplyLsTextEdits, handleFixSpellingI
 import type { ClientSideCommandHandlerApi } from './client/index.mjs';
 import type { Position as LsPosition, Range as LsRange, TextEdit as LsTextEdit } from './client/vscode-languageclient.js';
 import { actionSuggestSpellingCorrections } from './codeActions/actionSuggestSpellingCorrections.mjs';
+import { extensionSettings } from './constants.js';
 import * as di from './di.mjs';
 import { getCSpellDiags } from './diags.mjs';
 import { onCommandUseDiagsSelectionOrPrompt } from './promptUser.mjs';
@@ -147,7 +148,7 @@ export const commandHandlers = {
     'cSpell.editText': handleApplyLsTextEdits,
     'cSpell.logPerfTimeline': dumpPerfTimeline,
 
-    'cSpell.openSettings': callCommand('workbench.action.openSettings', () => [{ query: '@ext:streetsidesoftware.code-spell-checker' }]),
+    'cSpell.openSettings': async () => executeOpenSettingsCommand(),
 
     'cSpell.addWordToCSpellConfig': actionAddWordToCSpell,
     'cSpell.addIssuesToDictionary': addAllIssuesFromDocument,
@@ -181,7 +182,7 @@ export const commandHandlers = {
 
     'cspell.showActionsMenu': handlerResolvedLater,
 
-    'cSpell.openIssuesPanel': callCommand('cSpellIssuesViewByFile.focus'),
+    'cSpell.openIssuesPanel': genExecCommandFn('cSpellIssuesViewByFile.focus'),
     'cSpell.openFileInfoView': handleDisplayCSpellInfo,
     'cSpell.displayCSpellInfo': handleDisplayCSpellInfo,
     'cSpell.hideCSpellInfo': handleHideCSpellInfo,
@@ -601,10 +602,17 @@ function handleInsertWordsDirective(textEditor?: TextEditor, _edit?: TextEditorE
     }, 'handleInsertWordsDirective');
 }
 
-function callCommand<T>(command: string, calcArgs?: () => unknown[]): () => Promise<T> {
+export type ExecuteCommand = Omit<Command, 'title'>;
+
+async function execCommand<T = unknown>(command: ExecuteCommand): Promise<T> {
+    const args = command.arguments || [];
+    return commands.executeCommand<T>(command.command, ...args);
+}
+
+function genExecCommandFn<T>(command: string | ExecuteCommand): () => Promise<T> {
     return async () => {
-        const args = calcArgs?.() || [];
-        return commands.executeCommand<T>(command, ...args);
+        command = typeof command === 'string' ? { command } : command;
+        return execCommand<T>(command);
     };
 }
 
@@ -628,3 +636,15 @@ function handleReload() {
 function handleCmdExperimentalExecuteDocumentSymbolProvider() {
     return handleErrors(experimentWithSymbols(), 'handleCmdExperimentalExecuteDocumentSymbolProvider');
 }
+
+export function generateOpenSettingsCommand(setting?: string): ExecuteCommand {
+    const query = setting ? `${extensionSettings} ${setting}` : extensionSettings;
+    return {
+        command: 'workbench.action.openSettings',
+        arguments: [{ query }],
+    };
+}
+
+export function executeOpenSettingsCommand(setting?: string) {
+    return execCommand(generateOpenSettingsCommand(setting));
+}

packages/client/src/constants.ts

@@ -1,4 +1,6 @@
 import type { DiagnosticSource, ExtensionId } from 'code-spell-checker-server/api';
 
+export const officialExtensionId = 'streetsidesoftware.code-spell-checker';
 export const extensionId: ExtensionId = 'cSpell';
 export const diagnosticSource: DiagnosticSource = extensionId;
+export const extensionSettings = '@ext:streetsidesoftware.code-spell-checker';

packages/client/src/extension.mts

@@ -349,10 +349,10 @@ async function notifyUserOfBlockedFile(onBlockFile: OnBlockFile) {
             ...actions,
         );
         if (result === openSettings) {
-            await vscode.commands.executeCommand('workbench.action.openSettings', reason.settingsID);
+            await commands.executeOpenSettingsCommand(reason.settingsID);
         }
         if (result === manageNotifications) {
-            await vscode.commands.executeCommand('workbench.action.openSettings', 'cSpell.enabledNotifications');
+            await commands.executeOpenSettingsCommand('cSpell.enabledNotifications');
         }
     } catch {
         // ignore