Adding level for diagnostic. Modify behavior so new diagnostic only appears on save, not on edit. (#1423)

closes #1405

Author: belav

Src/CSharpier.VSCode/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.9.2
+- Add option for diagnostic level, default to warning
+- Modify behavior of diagnostics so that new ones only appear on file save, not as a user types.
+
 ## 1.9.1
 - Add option for disabling diagnostics.
 

Src/CSharpier.VSCode/package.json

@@ -2,7 +2,7 @@
     "name": "csharpier-vscode",
     "displayName": "CSharpier - Code formatter",
     "description": "Code formatter using csharpier",
-    "version": "1.9.1",
+    "version": "1.9.2",
     "publisher": "csharpier",
     "author": "CSharpier",
     "homepage": "https://marketplace.visualstudio.com/items?itemName=csharpier.csharpier-vscode",
@@ -48,6 +48,13 @@
                         "default": false,
                         "description": "Enable debug logs."
                     },
+                    "csharpier.diagnosticsLevel": {
+                        "type": "string",
+                        "enum": ["0", "1", "2", "3"],
+                        "enumItemLabels": ["Error", "Warning", "Information", "Hint"],
+                        "default": "1",
+                        "description": "Determines the severity level of diagnostics if they are enabled."
+                    },
                     "csharpier.enableDiagnostics": {
                         "type": "boolean",
                         "default": true,

Src/CSharpier.VSCode/src/DiagnosticsService.ts

@@ -15,9 +15,10 @@ export interface CsharpierDiff {
 }
 
 export class DiagnosticsService implements vscode.CodeActionProvider, vscode.Disposable {
-    public static readonly quickFixCodeActionKind =
+    private static readonly quickFixCodeActionKind =
         vscode.CodeActionKind.QuickFix.append(DIAGNOSTICS_ID);
-    public static metadata: vscode.CodeActionProviderMetadata = {
+
+    private static metadata: vscode.CodeActionProviderMetadata = {
         providedCodeActionKinds: [DiagnosticsService.quickFixCodeActionKind],
     };
 
@@ -48,87 +49,100 @@ export class DiagnosticsService implements vscode.CodeActionProvider, vscode.Dis
         this.codeActionsProvider.dispose();
     }
 
-    private handleChangeTextDocument(document: vscode.TextDocument): void {
-        void this.runDiagnostics(document);
-    }
-
-    public async runDiagnostics(document: vscode.TextDocument): Promise<void> {
-        const shouldRunDiagnostics =
-            this.documentSelector.some(selector => selector.language === document.languageId) &&
-            !!vscode.workspace.getWorkspaceFolder(document.uri) &&
-            (workspace.getConfiguration("csharpier").get<boolean>("enableDiagnostics") ?? true);
-        if (shouldRunDiagnostics) {
-            try {
-                const diff = await this.getDiff(document);
-                this.updateDiagnostics(document, diff);
-            } catch (e) {
-                this.logger.error(`Unable to provide diagnostics: ${(e as Error).message}`);
-            }
-        }
-    }
-
-    public updateDiagnostics(document: vscode.TextDocument, diff: CsharpierDiff): void {
-        const diagnostics = this.getDiagnostics(document, diff);
-        this.diagnosticCollection.set(document.uri, diagnostics);
-    }
-
     private registerEditorEvents(): void {
         const activeDocument = vscode.window.activeTextEditor?.document;
         if (activeDocument) {
             void this.runDiagnostics(activeDocument);
         }
 
-        const onDidChangeTextDocument = vscode.workspace.onDidChangeTextDocument(
-            (e: vscode.TextDocumentChangeEvent) => {
-                if (
-                    e.contentChanges.length &&
-                    vscode.window.activeTextEditor?.document === e.document
-                ) {
-                    this.handleChangeTextDocument(e.document);
-                }
-            },
-        );
+        const onDidChangeTextDocument = vscode.workspace.onDidChangeTextDocument(e => {
+            if (
+                e.contentChanges.length &&
+                vscode.window.activeTextEditor?.document === e.document
+            ) {
+                // when editing don't pop up any new diagnostics, but if someone cleans up one then allow that update
+                void this.runDiagnostics(e.document, true);
+            }
+        });
 
-        const onDidChangeActiveTextEditor = vscode.window.onDidChangeActiveTextEditor(
-            (editor?: vscode.TextEditor) => {
-                if (editor) {
-                    void this.runDiagnostics(editor.document);
-                }
-            },
-        );
+        const onDidSaveTextDocument = vscode.workspace.onDidSaveTextDocument(document => {
+            if (vscode.window.activeTextEditor?.document === document) {
+                void this.runDiagnostics(document);
+            }
+        });
+
+        const onDidChangeActiveTextEditor = vscode.window.onDidChangeActiveTextEditor(editor => {
+            if (editor) {
+                void this.runDiagnostics(editor.document);
+            }
+        });
 
         this.disposables.push(
             onDidChangeTextDocument,
+            onDidSaveTextDocument,
             onDidChangeActiveTextEditor,
             this.diagnosticCollection,
         );
     }
 
+    public async runDiagnostics(
+        document: vscode.TextDocument,
+        onlyAllowLessDiagnostics = false,
+    ): Promise<void> {
+        const shouldRunDiagnostics =
+            this.documentSelector.some(selector => selector.language === document.languageId) &&
+            !!vscode.workspace.getWorkspaceFolder(document.uri) &&
+            (workspace.getConfiguration("csharpier").get<boolean>("enableDiagnostics") ?? true);
+        if (!shouldRunDiagnostics) {
+            this.diagnosticCollection.set(document.uri, []);
+            return;
+        }
+
+        try {
+            const source = document.getText();
+            const formattedSource =
+                (await this.formatDocumentProvider.formatDocument(document)) ?? source;
+            const differences = generateDifferences(source, formattedSource);
+            const diff = {
+                source,
+                formattedSource,
+                differences,
+            };
+            const diagnostics = this.getDiagnostics(document, diff);
+            if (onlyAllowLessDiagnostics) {
+                let currentDiagnostics = this.diagnosticCollection.get(document.uri);
+                let currentCount = !currentDiagnostics ? 0 : currentDiagnostics.length;
+                if (diagnostics.length >= currentCount) {
+                    return;
+                }
+            }
+            this.diagnosticCollection.set(document.uri, diagnostics);
+        } catch (e) {
+            this.logger.error(`Unable to provide diagnostics: ${(e as Error).message}`);
+        }
+    }
+
     private getDiagnostics(
         document: vscode.TextDocument,
         diff: CsharpierDiff,
     ): vscode.Diagnostic[] {
         const diagnostics: vscode.Diagnostic[] = [];
         for (const difference of diff.differences) {
-            const diagnostic = this.getDiagnostic(document, difference);
+            let range = this.getRange(document, difference);
+            let message = this.getMessage(difference);
+            let diagnostic = new vscode.Diagnostic(range, message);
+            diagnostic.source = DIAGNOSTICS_ID;
+            diagnostic.code = DIAGNOSTICS_SOURCE_ID;
+            diagnostic.severity = parseInt(
+                workspace.getConfiguration("csharpier").get<string>("diagnosticsLevel") ?? "1",
+                10,
+            );
             this.diagnosticDifferenceMap.set(diagnostic, difference);
             diagnostics.push(diagnostic);
         }
         return diagnostics;
     }
 
-    private getDiagnostic(
-        document: vscode.TextDocument,
-        difference: Difference,
-    ): vscode.Diagnostic {
-        const range = this.getRange(document, difference);
-        const message = this.getMessage(difference);
-        const diagnostic = new vscode.Diagnostic(range, message);
-        diagnostic.source = DIAGNOSTICS_ID;
-        diagnostic.code = DIAGNOSTICS_SOURCE_ID;
-        return diagnostic;
-    }
-
     private getMessage(difference: Difference): string {
         switch (difference.operation) {
             case generateDifferences.INSERT:
@@ -154,18 +168,6 @@ export class DiagnosticsService implements vscode.CodeActionProvider, vscode.Dis
         return new vscode.Range(start.line, start.character, end.line, end.character);
     }
 
-    private async getDiff(document: vscode.TextDocument): Promise<CsharpierDiff> {
-        const source = document.getText();
-        const formattedSource =
-            (await this.formatDocumentProvider.formatDocument(document)) ?? source;
-        const differences = generateDifferences(source, formattedSource);
-        return {
-            source,
-            formattedSource,
-            differences,
-        };
-    }
-
     public provideCodeActions(
         document: vscode.TextDocument,
         range: vscode.Range | vscode.Selection,