anki/ts/sql_format.ts
Damien Elmes 3dad3c90d0 add .sql file formatter
Uses the logic from the sqltools VSCode add-on, with a workaround
for the use of 'type' in some table columns.

By detecting the presence of 'BUILD_WORKSPACE_DIRECTORY' we can tell
if the rule is running in test mode or was run directly, avoiding the
need for separate check and fix rules. It might be nice to extend this
to other formatting rules in the future as well.
2021-01-09 14:22:49 +10:00

47 lines
1.4 KiB
TypeScript

import sqlFormatter from "@sqltools/formatter";
import * as Diff from "diff";
import process from "process";
import path from "path";
import fs from "fs";
const workspace = process.env.BUILD_WORKSPACE_DIRECTORY;
const wantFix = workspace !== undefined;
function fixFile(relpath: string, newText: string): void {
const workspacePath = path.join(workspace!, relpath);
fs.writeFileSync(workspacePath, newText);
}
function formatText(text: string): string {
const newText: string = sqlFormatter.format(text, {
indent: " ",
reservedWordCase: "upper",
});
// 'type' is treated as a reserved word, but Anki uses it in various sql
// tables, so we don't want it uppercased
return newText.replace(/\bTYPE\b/g, "type");
}
let errorFound = false;
for (const path of process.argv.slice(2)) {
const orig = fs.readFileSync(path).toString();
const formatted = formatText(orig);
if (orig !== formatted) {
if (wantFix) {
fixFile(path, formatted);
console.log(`Fixed ${path}`);
} else {
if (!errorFound) {
errorFound = true;
console.log("SQL formatting issues found:");
}
console.log(Diff.createPatch(path, orig, formatted));
}
}
}
if (errorFound) {
console.log("Use 'bazel run //rslib:sql_format' to fix.");
console.log(process.env.BUILD_WORKSPACE_DIRECTORY);
process.exit(1);
}