Merge pull request #140 from TheCleric/139-respect-warnings

Allow the extension to accept warnings from the underlying linter

TESTING.md

@@ -6,7 +6,7 @@
    ```bash
    cd vscode-sqlfluff
    npm install
-   vsce package
+   npx vsce package
    ```
 4. Load into VS Code:
    1. Open VS Code and Navigate to the Extensions Panel

package.json

@@ -422,7 +422,7 @@
     "esbuild-base": "rimraf out && esbuild ./src/extension.ts --bundle --outfile=out/src/extension.js --external:vscode --format=cjs --keep-names --platform=node",
     "esbuild": "npm run -S esbuild-base -- --sourcemap",
     "esbuild-watch": "npm run -S esbuild-base -- --sourcemap --watch",
-    "postbuild": "copyfiles \"./test/suite/test_sql/**/*.sql\" \"./out\" && copyfiles \"./test/.sqlfluff\" \"./out\"",
+    "postbuild": "copyfiles \"./test/suite/test_sql/**/*.sql\" \"./out\" && copyfiles \"./test/.sqlfluff\" \"./out\" && copyfiles copyfiles \"./test/.vscode/settings.json\" \"./out\"",
     "deploy": "vsce publish",
     "build-vsix": "vsce package"
   },

src/features/helper/configuration.ts

@@ -328,7 +328,7 @@ export default class Configuration {
     return DiagnosticSeverity.Error;
   }
 
-  public static diagnosticSeverityByRule(violation: string): number {
+  public static diagnosticSeverityByRule(violation: string, defaultSeverity: number | null = null): number {
     const diagnosticSeverityByRule = vscode.workspace
       .getConfiguration("sqlfluff.linter")
       .get<DiagnosticSetting[]>("diagnosticSeverityByRule", []);
@@ -354,7 +354,7 @@ export default class Configuration {
         return DiagnosticSeverity.Information;
     }
 
-    return this.diagnosticSeverity();
+    return defaultSeverity == null ? this.diagnosticSeverity() : defaultSeverity;
   }
 
   public static lintEntireProject(): boolean {

src/features/linter.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 "use strict";
 import * as vscode from "vscode";
-import { Diagnostic, Disposable } from "vscode";
+import { Diagnostic, DiagnosticSeverity, Disposable } from "vscode";
 
 import Configuration from "./helper/configuration";
 import Utilities from "./helper/utilities";
@@ -49,6 +49,7 @@ export default class LinterProvider implements Linter {
             const end_line_no = Math.max(0, (violation.line_no ?? violation.end_line_no ?? 1) - 1);
             const end_line_pos = Math.max(0, (violation.line_pos ?? violation.end_line_pos ?? 1) - 1);
             const violationPosition = new vscode.Position(start_line_no, start_line_pos);
+            const warning: boolean = violation?.warning || false;
             let range = new vscode.Range(start_line_no, start_line_pos, end_line_no, end_line_pos);
 
             if (editor) {
@@ -58,7 +59,7 @@ export default class LinterProvider implements Linter {
               }
             }
 
-            const diagnosticSeverity = Configuration.diagnosticSeverityByRule(violation.code);
+            const diagnosticSeverity = Configuration.diagnosticSeverityByRule(violation.code, warning ? DiagnosticSeverity.Warning : null);
 
             const diagnostic = new Diagnostic(
               range,

src/features/providers/linter/types/violation.ts

@@ -7,4 +7,5 @@ export default interface Violation {
   end_line_pos?: number,
   description: string,
   code: string,
+  warning?: boolean;
 }

test/.sqlfluff

@@ -1,5 +1,6 @@
 [sqlfluff]
 dialect = postgres
+warnings = AM04
 
 [sqlfluff:rules:capitalisation.keywords]
 capitalisation_policy = upper

test/runTest.ts

@@ -11,7 +11,7 @@ const main = async () => {
     // Passed to --extensionTestsPath
     const extensionTestsPath = path.resolve(__dirname, "./suite/index");
 
-    const launchArgs = [path.resolve(__dirname)]
+    const launchArgs = [path.resolve(__dirname)];
 
     // Download VS Code, unzip it and run the integration test
     await runTests({ extensionDevelopmentPath, extensionTestsPath, launchArgs });

test/suite/extension.test.ts

@@ -45,9 +45,23 @@ suite("Extension Test Suite", () => {
 
   }).timeout(TIMEOUT);
 
-  const assertDiagnosticIsEqual = (actual: vscode.Diagnostic, expected: { range: any; message: any; code: any; }) => {
+  test("Warning SQL should have the correct diagnostics", async () => {
+    const documentUri = Helper.getDocumentUri("/test_sql/warning.sql");
+    await Helper.activate(documentUri);
+
+    const actualDiagnostics = vscode.languages.getDiagnostics(documentUri);
+
+    assert.strictEqual(actualDiagnostics.length, 1, JSON.stringify(actualDiagnostics, null, 4));
+    [
+      { range: Helper.toRange(0, 0, 0, 6), message: "Query produces an unknown number of result columns.", code: "AM04", severity: vscode.DiagnosticSeverity.Warning },
+    ].forEach((expectedDiagnostic, i) => {
+      assertDiagnosticIsEqual(actualDiagnostics[i], expectedDiagnostic);
+    });
+  }).timeout(TIMEOUT);
+
+  const assertDiagnosticIsEqual = (actual: vscode.Diagnostic, expected: { range: any; message: any; code: any; severity?: vscode.DiagnosticSeverity }) => {
     assert.deepStrictEqual(actual.range, expected.range);
-    assert.strictEqual(actual.severity, 0);
+    assert.strictEqual(actual.severity, expected.severity == undefined ? 0 : expected.severity);
     assert.strictEqual(actual.message, expected.message);
     assert.strictEqual(actual.code, expected.code);
     assert.strictEqual(actual.source, "sqlfluff");

test/suite/test_sql/warning.sql

@@ -0,0 +1 @@
+SELECT a.* FROM a INNER JOIN b ON a.id = b.id