fix: move reportUnknownWords to Experimental (#3333)

streetsidesoftware · May 31, 2024 · ed20aa9 · ed20aa9
1 parent 895998b
commit ed20aa9
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 31 deletions.
diff --git a/package.json b/package.json
@@ -1849,6 +1849,14 @@
             "markdownDescription": "Enable the Settings Viewer V2 Extension",
             "scope": "application",
             "type": "boolean"
+          },
+          "cSpell.reportUnknownWords": {
+            "default": true,
+            "markdownDescription": "By default, the spell checker reports all unknown words as misspelled. This setting allows for a more relaxed spell checking, by only\nreporting unknown words as suggestions. Common spelling errors are still flagged as misspelled.\n\n- `true` - report unknown words as misspelled\n- `false` - report unknown words as suggestions",
+            "scope": "language-overridable",
+            "since": "4.0.2",
+            "title": "Strict Spell Checking",
+            "type": "boolean"
           }
         },
         "title": "Experimental",
@@ -3857,22 +3865,8 @@
             "scope": "resource",
             "type": "number"
           },
-          "cSpell.reportUnknownWords": {
-            "default": true,
-            "markdownDescription": "By default, the spell checker reports all unknown words as misspelled. This setting allows for a more relaxed spell checking, by only\nreporting unknown words as suggestions. Common spelling errors are still flagged as misspelled.\n\n- `true` - report unknown words as misspelled\n- `false` - report unknown words as suggestions",
-            "scope": "language-overridable",
-            "since": "4.0.2",
-            "title": "Strict Spell Checking",
-            "type": "boolean"
-          },
           "cSpell.revealIssuesAfterDelayMS": {
             "default": 1500,
-            "enumDescriptions": [
-              "Show issues while typing",
-              "Hide issues in the current word",
-              "Hide issues on the line",
-              "Hide all issues in the document"
-            ],
             "markdownDescription": "Reveal hidden issues related to `#cSpell.hideIssuesWhileTyping#` after a delay in milliseconds.",
             "scope": "application",
             "since": "4.0.0",

diff --git a/packages/_server/spell-checker-config.schema.json b/packages/_server/spell-checker-config.schema.json
@@ -1346,6 +1346,15 @@
           "markdownDescription": "Enable the Settings Viewer V2 Extension",
           "scope": "application",
           "type": "boolean"
+        },
+        "cSpell.reportUnknownWords": {
+          "default": true,
+          "description": "By default, the spell checker reports all unknown words as misspelled. This setting allows for a more relaxed spell checking, by only reporting unknown words as suggestions. Common spelling errors are still flagged as misspelled.\n\n- `true` - report unknown words as misspelled\n- `false` - report unknown words as suggestions",
+          "markdownDescription": "By default, the spell checker reports all unknown words as misspelled. This setting allows for a more relaxed spell checking, by only\nreporting unknown words as suggestions. Common spelling errors are still flagged as misspelled.\n\n- `true` - report unknown words as misspelled\n- `false` - report unknown words as suggestions",
+          "scope": "language-overridable",
+          "since": "4.0.2",
+          "title": "Strict Spell Checking",
+          "type": "boolean"
         }
       },
       "title": "Experimental",
@@ -3578,24 +3587,9 @@
           "scope": "resource",
           "type": "number"
         },
-        "cSpell.reportUnknownWords": {
-          "default": true,
-          "description": "By default, the spell checker reports all unknown words as misspelled. This setting allows for a more relaxed spell checking, by only reporting unknown words as suggestions. Common spelling errors are still flagged as misspelled.\n\n- `true` - report unknown words as misspelled\n- `false` - report unknown words as suggestions",
-          "markdownDescription": "By default, the spell checker reports all unknown words as misspelled. This setting allows for a more relaxed spell checking, by only\nreporting unknown words as suggestions. Common spelling errors are still flagged as misspelled.\n\n- `true` - report unknown words as misspelled\n- `false` - report unknown words as suggestions",
-          "scope": "language-overridable",
-          "since": "4.0.2",
-          "title": "Strict Spell Checking",
-          "type": "boolean"
-        },
         "cSpell.revealIssuesAfterDelayMS": {
           "default": 1500,
           "description": "Reveal hidden issues related to `#cSpell.hideIssuesWhileTyping#` after a delay in milliseconds.",
-          "enumDescriptions": [
-            "Show issues while typing",
-            "Hide issues in the current word",
-            "Hide issues on the line",
-            "Hide all issues in the document"
-          ],
           "markdownDescription": "Reveal hidden issues related to `#cSpell.hideIssuesWhileTyping#` after a delay in milliseconds.",
           "scope": "application",
           "since": "4.0.0",

diff --git a/packages/_server/src/config/cspellConfig/cspellConfig.mts b/packages/_server/src/config/cspellConfig/cspellConfig.mts
@@ -159,7 +159,7 @@ type _VSConfigReporting = Pick<
     | 'maxNumberOfProblems'
     | 'minWordLength'
     | 'numSuggestions'
-    | 'reportUnknownWords'
+    // | 'reportUnknownWords' // to ba added when it has been finalized.
     | 'showAutocompleteDirectiveSuggestions'
     | 'showCommandsInEditorContextMenu'
     | 'showStatus'
@@ -265,7 +265,13 @@ type _VSConfigAdvanced = Pick<
  * @order 19
  */
 type VSConfigExperimental = PrefixWithCspell<_VSConfigExperimental>;
-type _VSConfigExperimental = Pick<SpellCheckerSettingsVSCodeBase, 'experimental.enableRegexpView' | 'experimental.enableSettingsViewerV2'>;
+type _VSConfigExperimental = Pick<
+    SpellCheckerSettingsVSCodeBase,
+    | 'experimental.enableRegexpView'
+    | 'experimental.enableSettingsViewerV2'
+    // The plan is to move `reportUnknownWords` to the reporting section.
+    | 'reportUnknownWords'
+>;
 
 export type SpellCheckerSettingsVSCode = [
     VSConfigRoot,