feat: enable picky mode (#760)

davidlday · Sep 14, 2024 · 44db544 · 44db544
1 parent 6bc2141
commit 44db544
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 6 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -10,6 +10,7 @@
       "type": "extensionHost",
       "request": "launch",
       "runtimeExecutable": "${execPath}",
+      "cwd":"${workspaceFolder}",
       "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
       "outFiles": ["${workspaceFolder}/dist/**/*.js"],
       "preLaunchTask": "npm: webpack"
@@ -24,6 +25,7 @@
         "--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
       ],
       "outFiles": ["${workspaceFolder}/out/test/**/*.js"],
+      "cwd":"${workspaceFolder}",
       "preLaunchTask": "npm: test-compile",
       "postDebugTask": "npm: main-dist"
     }

diff --git a/package.json b/package.json
@@ -121,12 +121,12 @@
         "languageToolLinter.smartFormat.onType": {
           "type": "boolean",
           "default": false,
-          "description": "Run smart format as you type for quotes (\u201c\u201d\u2018\u2019), em-dashes and en-dashes, and ellipses (\u2026). Ensure 'Editor: Format On Type' is enabled."
+          "description": "Run smart format as you type for quotes (“”‘’), em-dashes and en-dashes, and ellipses (…). Ensure 'Editor: Format On Type' is enabled."
         },
         "languageToolLinter.smartFormat.onSave": {
           "type": "boolean",
           "default": false,
-          "description": "Run smart format when you save for quotes (\u201c\u201d\u2018\u2019), em-dashes and en-dashes, and ellipses (\u2026)."
+          "description": "Run smart format when you save for quotes (“”‘’), em-dashes and en-dashes, and ellipses (…)."
         },
         "languageToolLinter.diagnosticSeverity": {
           "type": "string",
@@ -310,7 +310,7 @@
             "Portuguese",
             "Portuguese (Angola preAO)",
             "Portuguese (Brazil)",
-            "Portuguese (Mo\u00e7ambique preAO)",
+            "Portuguese (Moçambique preAO)",
             "Portuguese (Portugal)",
             "Romanian",
             "Russian",
@@ -407,7 +407,7 @@
             "Portuguese",
             "Portuguese (Angola preAO)",
             "Portuguese (Brazil)",
-            "Portuguese (Mo\u00e7ambique preAO)",
+            "Portuguese (Moçambique preAO)",
             "Portuguese (Portugal)",
             "Romanian",
             "Russian",
@@ -436,6 +436,21 @@
           "default": "",
           "description": "IDs of categories to be disabled, comma-separated, no spaces. These IDs are passed directly to the LanguageTool service and will not be returned with diagnostics."
         },
+        "languageToolLinter.languageTool.level": {
+          "type": "string",
+          "default": "",
+          "description": "If set to picky, additional rules will be activated, i.e. rules that you might only find useful when checking formal text.",
+          "enum": [
+            "",
+            "default",
+            "picky"
+          ],
+          "enumDescriptions": [
+            "",
+            "Standard Mode",
+            "Picky Mode"
+          ]
+        },
         "languageToolLinter.languageTool.ignoredWordsGlobal": {
           "type": "array",
           "items": {

diff --git a/src/ConfigurationManager.ts b/src/ConfigurationManager.ts
@@ -397,6 +397,8 @@ export class ConfigurationManager implements Disposable {
       if (value) {
         parameters.set(ltKey, value);
         Constants.EXTENSION_OUTPUT_CHANNEL.appendLine(ltKey + ": " + value);
+      } else {
+        Constants.EXTENSION_OUTPUT_CHANNEL.appendLine(ltKey + ": --");
       }
     });
     // Only add user name and API key to options if set and we are using the

diff --git a/src/Constants.ts b/src/Constants.ts
@@ -72,6 +72,7 @@ export const SERVICE_PARAMETERS: string[] = [
   "preferredVariants",
   "disabledCategories",
   "disabledRules",
+  "level"
 ];
 export const SERVICE_RULE_BASE_URI =
   "https://community.languagetool.org/rule/show/";

diff --git a/test-fixtures/workspace/.vscode/settings.json b/test-fixtures/workspace/.vscode/settings.json
@@ -14,5 +14,6 @@
   "languageToolLinter.plainText.languageIds": [
     "plaintext",
     "asciidoc"
-  ]
+  ],
+  "languageToolLinter.languageTool.level": "picky"
 }
diff --git a/test/suite/extension.test.ts b/test/suite/extension.test.ts
@@ -47,10 +47,13 @@ suite("Extension Test Suite", () => {
           value.startsWith("languagetoolLinter.")
         );
       });
+      const MISSING_COMMANDS = EXPECTED_COMMANDS.filter(
+        item => FOUND_COMMANDS.indexOf(item) < 0
+      );
       assert.equal(
         FOUND_COMMANDS.length,
         EXPECTED_COMMANDS.length,
-        "Either not all commands are registered or new commands have not been added to this test.",
+        `The following commands were not found: ${MISSING_COMMANDS}`,
       );
     });
   });