fix: Support spell checking commit message (#2106)

See: [SCM: Support input box spell checking · Issue #35571 · microsoft/vscode](microsoft/vscode#35571 (comment))
streetsidesoftware · Jul 26, 2022 · b305c59 · b305c59
1 parent 103cfd5
commit b305c59
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 43 deletions.
diff --git a/docs/_includes/generated-docs/configuration.md b/docs/_includes/generated-docs/configuration.md
@@ -578,7 +578,7 @@ Description
     - `vscode-userdata` - Needed to spell check `.code-snippets`
 
 Default
-: [ _`"file"`_, _`"gist"`_, _`"sftp"`_, _`"untitled"`_, _`"vscode"`_, _`"vscode-notebook-cell"`_, _`"vscode-userdata"`_ ]
+: [ _`"file"`_, _`"gist"`_, _`"sftp"`_, _`"untitled"`_, _`"vscode-notebook-cell"`_, _`"vscode-scm"`_, _`"vscode-userdata"`_ ]
 
 ---
 
@@ -1396,6 +1396,6 @@ Description
 : Specify a list of file types to spell check. It is better to use `#cSpell.enableFiletypes#` to Enable / Disable checking files types.
 
 Default
-: [ _`"asciidoc"`_, _`"c"`_, _`"cpp"`_, _`"csharp"`_, _`"css"`_, _`"elixir"`_, _`"git-commit"`_, _`"go"`_, _`"graphql"`_, _`"handlebars"`_, _`"haskell"`_, _`"html"`_, _`"jade"`_, _`"java"`_, _`"javascript"`_, _`"javascriptreact"`_, _`"json"`_, _`"jsonc"`_, _`"jupyter"`_, _`"latex"`_, _`"less"`_, _`"markdown"`_, _`"php"`_, _`"plaintext"`_, _`"python"`_, _`"pug"`_, _`"restructuredtext"`_, _`"rust"`_, _`"scala"`_, _`"scss"`_, _`"swift"`_, _`"text"`_, _`"typescript"`_, _`"typescriptreact"`_, _`"vue"`_, _`"yaml"`_, _`"yml"`_ ]
+: [ _`"asciidoc"`_, _`"c"`_, _`"cpp"`_, _`"csharp"`_, _`"css"`_, _`"elixir"`_, _`"git-commit"`_, _`"go"`_, _`"graphql"`_, _`"handlebars"`_, _`"haskell"`_, _`"html"`_, _`"jade"`_, _`"java"`_, _`"javascript"`_, _`"javascriptreact"`_, _`"json"`_, _`"jsonc"`_, _`"jupyter"`_, _`"latex"`_, _`"less"`_, _`"markdown"`_, _`"php"`_, _`"plaintext"`_, _`"python"`_, _`"pug"`_, _`"restructuredtext"`_, _`"rust"`_, _`"scala"`_, _`"scss"`_, _`"scminput"`_, _`"swift"`_, _`"text"`_, _`"typescript"`_, _`"typescriptreact"`_, _`"vue"`_, _`"yaml"`_, _`"yml"`_ ]
 
 ---
diff --git a/package.json b/package.json
@@ -1122,8 +1122,8 @@
               "gist",
               "sftp",
               "untitled",
-              "vscode",
               "vscode-notebook-cell",
+              "vscode-scm",
               "vscode-userdata"
             ],
             "items": {
@@ -2006,6 +2006,7 @@
               "rust",
               "scala",
               "scss",
+              "scminput",
               "swift",
               "text",
               "typescript",

diff --git a/packages/_server/spell-checker-config.schema.json b/packages/_server/spell-checker-config.schema.json
@@ -745,8 +745,8 @@
             "gist",
             "sftp",
             "untitled",
-            "vscode",
             "vscode-notebook-cell",
+            "vscode-scm",
             "vscode-userdata"
           ],
           "items": {
@@ -1629,6 +1629,7 @@
             "rust",
             "scala",
             "scss",
+            "scminput",
             "swift",
             "text",
             "typescript",

diff --git a/packages/_server/src/config/cspellConfig.ts b/packages/_server/src/config/cspellConfig.ts
@@ -52,7 +52,7 @@ export interface SpellCheckerSettings extends SpellCheckerShouldCheckDocSettings
      * - `vscode-notebook-cell` - Used for validating segments of a Notebook.
      * - `vscode-userdata` - Needed to spell check `.code-snippets`
      * @scope window
-     * @default ["file", "gist", "sftp", "untitled", "vscode", "vscode-notebook-cell", "vscode-userdata"]
+     * @default ["file", "gist", "sftp", "untitled", "vscode-notebook-cell", "vscode-scm", "vscode-userdata"]
      */
     allowedSchemas?: string[];
 
@@ -589,44 +589,45 @@ interface CSpellSettingsPackageProperties extends CSpellSettings {
      * Specify a list of file types to spell check. It is better to use `#cSpell.enableFiletypes#` to Enable / Disable checking files types.
      * @uniqueItems true
      * @default [
-     *       "asciidoc",
-     *       "c",
-     *       "cpp",
-     *       "csharp",
-     *       "css",
-     *       "elixir",
-     *       "git-commit",
-     *       "go",
-     *       "graphql",
-     *       "handlebars",
-     *       "haskell",
-     *       "html",
-     *       "jade",
-     *       "java",
-     *       "javascript",
-     *       "javascriptreact",
-     *       "json",
-     *       "jsonc",
-     *       "jupyter",
-     *       "latex",
-     *       "less",
-     *       "markdown",
-     *       "php",
-     *       "plaintext",
-     *       "python",
-     *       "pug",
-     *       "restructuredtext",
-     *       "rust",
-     *       "scala",
-     *       "scss",
-     *       "swift",
-     *       "text",
-     *       "typescript",
-     *       "typescriptreact",
-     *       "vue",
-     *       "yaml",
-     *       "yml"
-     *     ]
+     *      "asciidoc",
+     *      "c",
+     *      "cpp",
+     *      "csharp",
+     *      "css",
+     *      "elixir",
+     *      "git-commit",
+     *      "go",
+     *      "graphql",
+     *      "handlebars",
+     *      "haskell",
+     *      "html",
+     *      "jade",
+     *      "java",
+     *      "javascript",
+     *      "javascriptreact",
+     *      "json",
+     *      "jsonc",
+     *      "jupyter",
+     *      "latex",
+     *      "less",
+     *      "markdown",
+     *      "php",
+     *      "plaintext",
+     *      "python",
+     *      "pug",
+     *      "restructuredtext",
+     *      "rust",
+     *      "scala",
+     *      "scss",
+     *      "scminput",
+     *      "swift",
+     *      "text",
+     *      "typescript",
+     *      "typescriptreact",
+     *      "vue",
+     *      "yaml",
+     *      "yml"
+     *  ]
      */
     enabledLanguageIds?: string[];