fix/breaking: issues with spawned procs, stdin use, env, output

README.md

@@ -35,7 +35,6 @@ DBT setup requires these settings to lint and format the document.
 
 ```json
  "sqlfluff.linter.run": "onSave",
- "sqlfluff.experimental.format.executeInTerminal": true,
 ```
 
 ### Format file

package.json

@@ -102,11 +102,6 @@
  "default": true,
  "description": "Determines if the document formatter is enabled."
  },
- "sqlfluff.experimental.format.executeInTerminal": {
- "type": "boolean",
- "default": false,
- "markdownDescription": "Determines if the `sqlfluff fix` command overwrites the file contents instead of this extension. You should not change the file contents while formatting is occurring if this is enabled. May lead to problems if `editor.formatOnSave = true`. This allows formatting to work when the templater is set to dbt. This can help solve [Mojibake](https://en.wikipedia.org/wiki/Mojibake) issues."
- },
  "sqlfluff.linter.run": {
  "type": "string",
  "enum": [
@@ -117,7 +112,7 @@
  "default": "onType",
  "description": "Determines if the linter runs on save, on type, or disabled.",
  "markdownEnumDescriptions": [
- "Run the linter when the document is typed in. Does not work when the templater is set to dbt.",
+ "Run the linter when the document is typed in. Does not work when the templater is set to dbt, does not evaluate .sqlfluff files nested deeper than the root.",
  "Run the linter when the document is saved.",
  "Do not run the linter."
  ]

src/extension.ts

@@ -3,11 +3,12 @@ import * as vscode from "vscode";
 import { EXCLUDE_RULE, SQLFLuffDocumentFormattingEditProvider, SQLFluffLinterProvider, SQLFluffQuickFix } from "./features/sqlFluffLinter";
 
 export const activate = (context: vscode.ExtensionContext) => {
- new SQLFluffLinterProvider().activate(context.subscriptions);
+ const outputChannel = vscode.window.createOutputChannel("SQLFluff");
+ new SQLFluffLinterProvider(outputChannel).activate(context.subscriptions);
 
- vscode.languages.registerDocumentFormattingEditProvider("sql", new SQLFLuffDocumentFormattingEditProvider().activate());
- vscode.languages.registerDocumentFormattingEditProvider("sql-bigquery", new SQLFLuffDocumentFormattingEditProvider().activate());
- vscode.languages.registerDocumentFormattingEditProvider("jinja-sql", new SQLFLuffDocumentFormattingEditProvider().activate());
+ vscode.languages.registerDocumentFormattingEditProvider("sql", new SQLFLuffDocumentFormattingEditProvider(outputChannel).activate());
+ vscode.languages.registerDocumentFormattingEditProvider("sql-bigquery", new SQLFLuffDocumentFormattingEditProvider(outputChannel).activate());
+ vscode.languages.registerDocumentFormattingEditProvider("jinja-sql", new SQLFLuffDocumentFormattingEditProvider(outputChannel).activate());
 
  context.subscriptions.push(
  vscode.languages.registerCodeActionsProvider("sql", new SQLFluffQuickFix(), {

src/features/Helpers/configuration.ts

@@ -69,32 +69,26 @@ export class Configuration {
  .get("enabled");
  }
 
- public static executeInTerminal(): boolean {
- return vscode.workspace
- .getConfiguration("sqlfluff.experimental.format")
- .get("executeInTerminal");
- }
-
  public static runTrigger(): string {
  return vscode.workspace
  .getConfiguration("sqlfluff.linter")
  .get("run");
  }
 
  public static lintBufferArguments(): string[] {
- return ["lint", "--format", "json", "-"];
+ return ["--format", "json"];
  }
 
  public static lintFileArguments(): string[] {
- return ["lint", "--format", "json"];
+ return ["--format", "json"];
  }
 
  public static formatBufferArguments(): string[] {
- return ["fix", "--force", "-"];
+ return ["--force"];
  }
 
  public static formatFileArguments(): string[] {
- return ["fix", "--force"];
+ return ["--force"];
  }
 
  public static extraArguments(): string[] {

src/features/providers/format.ts

@@ -0,0 +1,75 @@
+"use strict";
+
+import * as cp from "child_process";
+import * as fs from "fs";
+import * as path from "path";
+import * as vscode from "vscode";
+
+import { Configuration } from "../helpers/configuration";
+import { SQLFluff, SQLFluffCommand } from "../utils/sqlfluff";
+
+export class DocumentFormattingEditProvider {
+ public outputChannel: vscode.OutputChannel;
+ public runner: SQLFluff;
+
+ constructor(outputChannel: vscode.OutputChannel) {
+ this.outputChannel = outputChannel;
+ this.runner = new SQLFluff(this.outputChannel);
+ }
+ async provideDocumentFormattingEdits(
+ document: vscode.TextDocument
+ ): Promise<vscode.TextEdit[]> {
+ const filePath = document.fileName.replace(/\\/g, "/");
+ const rootPath = vscode.workspace.workspaceFolders[0].uri.fsPath.replace(/\\/g, "/");
+ const workingDirectory = Configuration.workingDirectory() ? Configuration.workingDirectory() : rootPath;
+ const textEdits: vscode.TextEdit[] = [];
+ this.outputChannel.appendLine(`Format triggered for ${filePath}`);
+
+ if (Configuration.formatEnabled()) {
+ if (document.isDirty) {
+ await document.save();
+ }
+
+ try {
+ const result = await this.runner.run(
+ workingDirectory,
+ SQLFluffCommand.FIX,
+ Configuration.formatFileArguments(),
+ {
+ targetFileFullPath: filePath,
+ },
+ );
+ if (!result.succeeded) {
+ throw new Error('Command failed to execute, check logs for details');
+ }
+ const contents = fs.readFileSync(filePath, "utf-8");
+ const lines = contents.split(/\r?\n/);
+ const lineCount = document.lineCount;
+ const lastLineRange = document.lineAt(lineCount - 1).range;
+ const endChar = lastLineRange.end.character;
+
+ if (lines[0].startsWith("NO SAFETY:")) {
+ lines.shift();
+ lines.shift();
+ }
+
+ if (lines[0].includes("ENOENT")) {
+ return [];
+ }
+
+ if (lines.length > 1 || lines[0] !== "") {
+ textEdits.push(vscode.TextEdit.replace(
+ new vscode.Range(0, 0, lineCount, endChar),
+ lines.join("\n")
+ ));
+ }
+ } catch (error) {
+ vscode.window.showErrorMessage(`SQLFluff Formatting Failed: ${error.message}`);
+ }
+ } else {
+ this.outputChannel.appendLine("Skipping format, not enabled in settings");
+ }
+
+ return textEdits;
+ }
+}