Merge pull request #110 from clang13/readability-problem-location

Add a setting for where readability problems are displayed

Author: ChrisChinchilla

package-lock.json

@@ -68,6 +68,21 @@
           "type": "boolean",
           "default": false,
           "description": "Do not show warning dialog that a file must be saved to be linted."
+        },
+        "vale.readabilityProblemLocation": {
+          "type": "string",
+          "enum": [
+            "status",
+            "inline",
+            "both"
+          ],
+          "default": "status",
+          "markdownEnumDescriptions": [
+            "Displays readability problems in the status bar.",
+            "Displays readability problems inline with other problems.",
+            "Displays readability problems both in the status bar and inline in the file."
+          ],
+          "markdownDescription": "Determines where file-level readability problems are displayed."
         }
       }
     }

package.json

@@ -5,6 +5,7 @@ import * as fs from "fs";
 import * as vscode from "vscode";
 
 import * as utils from "./vsUtils";
+import { getReadabilityProblemLocation } from "./vsUtils";
 
 export default class ValeProvider implements vscode.CodeActionProvider {
   private diagnosticCollection!: vscode.DiagnosticCollection;
@@ -103,14 +104,20 @@ export default class ValeProvider implements vscode.CodeActionProvider {
       return;
     }
 
+    const readabilityProblemLocation = getReadabilityProblemLocation()
     this.readabilityStatus.hide();
+
     for (let key in body) {
       const alerts = body[key];
       for (var i = 0; i < alerts.length; ++i) {
-        if (alerts[i].Match === "") {
+        const isReadabilityProblem = alerts[i].Match === ""
+
+        if (isReadabilityProblem && readabilityProblemLocation !== "inline") {
           var readabilityMessage = alerts[0].Message;
           this.updateStatusBarItem(readabilityMessage);
-        } else {
+        }
+
+        if (!isReadabilityProblem || readabilityProblemLocation !== "status") {
           let diagnostic = utils.toDiagnostic(
             alerts[i],
             this.stylesPath,

src/features/vsProvider.ts

@@ -30,3 +30,8 @@ interface IValeErrorJSON {
   readonly Span: [number, number];
   readonly Severity: ValeSeverity;
 }
+
+/**
+ * Where to display file-level readability problems.
+ */
+type ValeReadabilityProblemLocation = "both" | "inline" | "status";

src/features/vsTypes.ts

@@ -266,3 +266,12 @@ export const buildCommand = (
   command = command.concat(["--output", "JSON", path]);
   return command;
 };
+
+export const getReadabilityProblemLocation = (): ValeReadabilityProblemLocation => {
+  const configuration = vscode.workspace.getConfiguration();
+
+  return configuration.get<ValeReadabilityProblemLocation>(
+    "vale.readabilityProblemLocation",
+    "status"
+  );
+}