-
-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Robbie Ostermann
committed
Sep 7, 2022
1 parent
99d81fc
commit 6b9ef77
Showing
15 changed files
with
480 additions
and
305 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| import * as childProcess from "child_process"; | ||
| import path = require("path"); | ||
| import { StringDecoder } from "string_decoder"; | ||
| import * as vscode from "vscode"; | ||
|
|
||
| import { Configuration } from "./configuration"; | ||
| import { LineDecoder } from "./lineDecoder"; | ||
| import { normalize, Utilities } from "./utilities"; | ||
|
|
||
| export enum SQLFluffCommand { | ||
| LINT = "lint", | ||
| FIX = "fix", | ||
| } | ||
|
|
||
| export interface SQLFluffCommandOutput { | ||
| succeeded: boolean; | ||
| lines: string[]; | ||
| } | ||
|
|
||
| export interface SQLFluffCommandOptions { | ||
| targetFileFullPath?: string; | ||
| fileContents?: string; | ||
| } | ||
|
|
||
| export class SQLFluff { | ||
| static process: childProcess.ChildProcess; | ||
|
|
||
| public static run(cwd: string, command: SQLFluffCommand, args: string[], options: SQLFluffCommandOptions): Promise<SQLFluffCommandOutput> { | ||
| if (!options.fileContents && !options.targetFileFullPath) { | ||
| throw new Error("You must supply either a target file path or the file contents to scan"); | ||
| } | ||
|
|
||
| if (SQLFluff.process) { | ||
| SQLFluff.process.kill("SIGKILL"); | ||
| SQLFluff.process = undefined; | ||
| } | ||
|
|
||
| const normalizedCwd = normalize(cwd); | ||
|
|
||
| return new Promise<SQLFluffCommandOutput>((resolve) => { | ||
| const stdoutLint = new LineDecoder(); | ||
| const stdoutFix = []; | ||
| let stdoutLines: string[]; | ||
| const stderrLines = []; | ||
|
|
||
| const onStdoutDataEvent = (data: Buffer) => { | ||
| if (command === SQLFluffCommand.LINT) { | ||
| stdoutLint.write(data); | ||
| } else { | ||
| stdoutFix.push(data); | ||
| } | ||
| }; | ||
|
|
||
| const onStderrDataEvent = (data: Buffer) => { | ||
| stderrLines.push(data.toString("utf8")); | ||
| }; | ||
|
|
||
| const onCloseEvent = (code: number, signal: any) => { | ||
| Utilities.outputChannel.appendLine(`Received close event, code ${code} signal ${signal}`); | ||
| Utilities.outputChannel.appendLine("Raw stdout output:"); | ||
|
|
||
| Utilities.appendHyphenatedLine(); | ||
| if (command === SQLFluffCommand.LINT) { | ||
| stdoutLint.end(); | ||
| stdoutLines = stdoutLint.getLines(); | ||
| Utilities.outputChannel.appendLine(stdoutLines.join("\n")); | ||
| } else { | ||
| const encoding: BufferEncoding = "utf8"; | ||
| const stringDecoder = new StringDecoder(encoding); | ||
|
|
||
| const stdoutAllLines = stdoutFix.reduce((response, buffer) => { | ||
| response += stringDecoder.write(buffer); | ||
| return response; | ||
| }, ""); | ||
| stdoutLines = [stdoutAllLines]; | ||
| Utilities.outputChannel.appendLine(stdoutLines.join("\n")); | ||
| } | ||
| Utilities.appendHyphenatedLine(); | ||
|
|
||
| if (stderrLines.length > 0) { | ||
| Utilities.outputChannel.appendLine("Raw stderr output:"); | ||
| Utilities.appendHyphenatedLine(); | ||
| Utilities.outputChannel.appendLine(stderrLines.join("\n")); | ||
| Utilities.appendHyphenatedLine(); | ||
| } | ||
|
|
||
| if (stderrLines?.length > 0) { | ||
| vscode.window.showErrorMessage(stderrLines.join("\n")); | ||
| } | ||
|
|
||
| return resolve({ | ||
| succeeded: code === 0 || code === 65, // 0 = all good, 65 = lint passed, but found errors | ||
| lines: stdoutLines, | ||
| }); | ||
| }; | ||
|
|
||
| const shouldUseStdin = !!options.fileContents?.length; | ||
|
|
||
| const finalArgs = [ | ||
| command, | ||
| ...args, | ||
| ...Configuration.extraArguments(), | ||
| ]; | ||
|
|
||
| if (shouldUseStdin) { | ||
| Utilities.outputChannel.appendLine("Reading from stdin, not file, input may be dirty/partial"); | ||
| finalArgs.push("-"); | ||
| } else { | ||
| Utilities.outputChannel.appendLine("Reading from file, not stdin"); | ||
| // we want to use relative path to the file so intermediate sqlfluff config files can be found | ||
| const normalizedTargetFileFullPath = normalize(options.targetFileFullPath); | ||
| const targetFileRelativePath = path.relative(normalizedCwd, normalizedTargetFileFullPath); | ||
| finalArgs.push(targetFileRelativePath); | ||
| } | ||
|
|
||
| Utilities.outputChannel.appendLine("\n--------------------Executing Command--------------------\n"); | ||
| Utilities.outputChannel.appendLine(Configuration.executablePath() + " " + finalArgs.join(" ")); | ||
| Utilities.appendHyphenatedLine(); | ||
|
|
||
| SQLFluff.process = childProcess.spawn(Configuration.executablePath(), finalArgs, { | ||
| cwd: normalizedCwd, | ||
| }); | ||
|
|
||
| if (SQLFluff.process.pid) { | ||
| SQLFluff.process.stdout.on("data", onStdoutDataEvent); | ||
| SQLFluff.process.stderr.on("data", onStderrDataEvent); | ||
| SQLFluff.process.on("close", onCloseEvent); | ||
| if (shouldUseStdin) { | ||
| SQLFluff.process.stdin.write(options.fileContents); | ||
| SQLFluff.process.stdin.end(); | ||
| } | ||
| } | ||
|
|
||
| SQLFluff.process.on("message", (message) => { | ||
| Utilities.outputChannel.appendLine("Received message from child process"); | ||
| Utilities.outputChannel.appendLine(message.toString()); | ||
| }); | ||
|
|
||
| SQLFluff.process.on("error", (error: Error) => { | ||
| Utilities.outputChannel.appendLine("Child process threw error"); | ||
| Utilities.outputChannel.appendLine(error.toString()); | ||
| let { message } = error; | ||
|
|
||
| if ((error as any).code === "ENOENT") { | ||
| message = "The sqlfluff executable was not found. Use the 'Executable Path' setting to configure the location of the executable, or add it to your PATH."; | ||
| } | ||
|
|
||
| vscode.window.showErrorMessage(message); | ||
| resolve({ succeeded: false, lines: [] }); | ||
| }); | ||
| }); | ||
| } | ||
| } |
Oops, something went wrong.