sql-linter 0.1.0

package/dist/index.js

@@ -0,0 +1,391 @@
+#!/usr/bin/env node
+import * as fs from "node:fs/promises";
+import path from "node:path";
+import { parseArgs } from "node:util";
+import chalk from "chalk";
+import { asyncDescribeQueries, } from "sql-describe";
+import ts from "typescript";
+const { values, positionals } = parseArgs({
+    args: process.argv.slice(2),
+    options: {
+        db: {
+            type: "string",
+            default: "postgres://postgres:postgres@localhost:5432/postgres",
+        },
+    },
+    allowPositionals: true,
+});
+const dir = positionals[0];
+if (!dir) {
+    console.error("Usage: sql-linter <dir> [--db <connection-url>]");
+    process.exit(1);
+}
+const targetDir = dir;
+const dbUrl = values.db;
+async function walkInner(dir, results) {
+    const files = await fs.readdir(dir);
+    await Promise.all(files.map(async (f) => {
+        const file = path.resolve(dir, f);
+        const stat = await fs.stat(file);
+        if (stat?.isDirectory()) {
+            await walkInner(file, results);
+        }
+        else {
+            results.push(file);
+        }
+    }));
+    return results;
+}
+async function walk(dir) {
+    const results = [];
+    await walkInner(dir, results);
+    return results;
+}
+async function lintNode(node, callback, program) {
+    if (ts.isTaggedTemplateExpression(node)) {
+        await callback(node, program);
+    }
+    const promises = [];
+    ts.forEachChild(node, (n) => {
+        promises.push(lintNode(n, callback, program));
+    });
+    await Promise.all(promises);
+}
+async function lint(dir, callback) {
+    const fileNames = await walk(dir);
+    const program = ts.createProgram(fileNames, {
+        target: ts.ScriptTarget.ES2015,
+    });
+    await Promise.all(fileNames.map(async (fileName) => {
+        const sourceFile = program.getSourceFile(fileName);
+        if (!sourceFile)
+            return;
+        await lintNode(sourceFile, callback, program);
+    }));
+}
+function pgTypeToTsInnerForParams(pg_type, typeChecker) {
+    if (typeof pg_type === "string") {
+        switch (pg_type) {
+            case "Bool":
+                return typeChecker.getBooleanType();
+            case "Float4":
+            case "Float8":
+            case "Int2":
+            case "Int4":
+                return typeChecker.getNumberType();
+            case "Int8":
+            case "Numeric":
+                return typeChecker.getUnionType([
+                    typeChecker.getNumberType(),
+                    typeChecker.getBigIntType(),
+                ]);
+            case "Interval":
+            case "Text":
+            case "Varchar":
+            case "Time":
+            case "Macaddr":
+            case "Uuid":
+                return typeChecker.getStringType();
+            case "Date":
+            case "Timestamp":
+            case "Timestamptz": {
+                const dateSymbol = typeChecker.resolveName("Date", undefined, ts.SymbolFlags.Type, false);
+                const dateType = typeChecker.getDeclaredTypeOfSymbol(dateSymbol);
+                return typeChecker.getUnionType([
+                    typeChecker.getStringType(),
+                    dateType,
+                ]);
+            }
+            case "TextArray":
+                return typeChecker.createArrayType(typeChecker.getStringType());
+            case "Float4Array":
+            case "Float8Array":
+            case "Int2Array":
+            case "Int4Array":
+            case "Int8Array":
+                return typeChecker.createArrayType(typeChecker.getUnionType([
+                    typeChecker.getNumberType(),
+                    typeChecker.createArrayType(typeChecker.getNumberType()),
+                ]));
+            case "Jsonb":
+                return typeChecker.getAnyType();
+        }
+        throw `Unsupported data type ${JSON.stringify(pg_type)}`;
+    }
+    if ("Custom" in pg_type) {
+        if (typeof pg_type.Custom.kind !== "string") {
+            if ("Enum" in pg_type.Custom.kind) {
+                return typeChecker.getStringType();
+            }
+            else if ("Array" in pg_type.Custom.kind) {
+                return typeChecker.createArrayType(pgTypeToTsInnerForParams(pg_type.Custom.kind.Array, typeChecker));
+            }
+        }
+    }
+    throw `Unsupported data type ${JSON.stringify(pg_type)}`;
+}
+function pgTypeToTsMappingForParams(pg_type, nullable, typeChecker) {
+    const inner = pgTypeToTsInnerForParams(pg_type, typeChecker);
+    if (nullable === true) {
+        return typeChecker.getNullableType(inner, ts.TypeFlags.Null);
+    }
+    return inner;
+}
+function pgTypeToTsForColumns(pg_type, typeChecker) {
+    if (typeof pg_type === "string") {
+        switch (pg_type) {
+            case "Bool":
+                return [typeChecker.getBooleanType()];
+            case "Float4":
+            case "Float8":
+            case "Int2":
+            case "Int4":
+                return [typeChecker.getNumberType()];
+            case "Int8":
+            case "Numeric":
+                return [typeChecker.getStringType()];
+            case "TstzRange":
+            case "Uuid":
+            case "Macaddr":
+            case "Text":
+            case "Varchar":
+                return [typeChecker.getStringType()];
+            case "Date":
+            case "Timestamp":
+            case "Timestamptz": {
+                const dateSymbol = typeChecker.resolveName("Date", undefined, ts.SymbolFlags.Type, false);
+                const dateType = typeChecker.getDeclaredTypeOfSymbol(dateSymbol);
+                return [dateType];
+            }
+            case "TextArray":
+                return [
+                    typeChecker.createArrayType(typeChecker.getStringType()),
+                ];
+            case "Float4Array":
+            case "Float8Array":
+            case "Int2Array":
+            case "Int4Array":
+            case "Int8Array":
+                return [
+                    typeChecker.createArrayType(typeChecker.getNumberType()),
+                    typeChecker.createArrayType(typeChecker.createArrayType(typeChecker.getNumberType())),
+                ];
+            case "JsonArray":
+            case "JsonbArray":
+            case "Json":
+            case "Jsonb":
+                return [typeChecker.getAnyType()];
+        }
+        throw `Unsupported data type ${JSON.stringify(pg_type)}`;
+    }
+    if ("Custom" in pg_type) {
+        if (typeof pg_type.Custom.kind !== "string") {
+            if ("Enum" in pg_type.Custom.kind) {
+                return [
+                    typeChecker.getUnionType(pg_type.Custom.kind.Enum.map((v) => typeChecker.getStringLiteralType(v))),
+                ];
+            }
+            else if ("Array" in pg_type.Custom.kind) {
+                return [
+                    typeChecker.createArrayType(pgTypeToTsInnerForParams(pg_type.Custom.kind.Array, typeChecker)),
+                ];
+            }
+        }
+    }
+    throw `Unsupported data type ${JSON.stringify(pg_type)}`;
+}
+function checkQueryParams(givenParams, expectedParams, argNames, typeChecker) {
+    if (expectedParams == null) {
+        if (givenParams != null) {
+            return {
+                node: givenParams,
+                message: "This query takes no params, but you supplied some here",
+            };
+        }
+        return null;
+    }
+    if ("Right" in expectedParams) {
+        throw new Error("This should only happen for mssql");
+    }
+    if (givenParams == null) {
+        if (expectedParams == null || expectedParams.Left.length === 0) {
+            return null;
+        }
+        return { message: "This query expects parameters, but none were given" };
+    }
+    const expectedParameters = expectedParams.Left;
+    const givenParameters = {};
+    if (argNames != null) {
+        const t = typeChecker.getTypeAtLocation(givenParams);
+        for (const property of t.getProperties()) {
+            const t = typeChecker.getTypeOfSymbol(property);
+            givenParameters[property.escapedName.toString()] = t;
+        }
+    }
+    else {
+        if (!ts.isArrayLiteralExpression(givenParams)) {
+            return {
+                node: givenParams,
+                message: "The arguments to the call should be an array e.g.: `[value1, value2]`",
+            };
+        }
+        else {
+            givenParams.elements.forEach((e, i) => {
+                if (e == null)
+                    return;
+                const t = typeChecker.getTypeAtLocation(e);
+                givenParameters[i] = t;
+            });
+        }
+    }
+    let i = 0;
+    for (const expectedParam of expectedParameters) {
+        const name = argNames?.[i] || i;
+        const eName = argNames?.[i] || i + 1;
+        const paramType = givenParameters[name];
+        try {
+            const expected = pgTypeToTsMappingForParams(expectedParam, false, typeChecker);
+            if (!typeChecker.isTypeAssignableTo(paramType, typeChecker.getNullableType(expected, ts.TypeFlags.Undefined))) {
+                return {
+                    message: `Expected a ${typeChecker.typeToString(expected)} for $${eName}, found a ${typeChecker.typeToString(paramType)}`,
+                };
+            }
+        }
+        catch (e) {
+            return {
+                message: e,
+            };
+        }
+        i += 1;
+    }
+    return null;
+}
+let count = 0;
+function report(node, message) {
+    count++;
+    const sourceFile = node.getSourceFile();
+    const { line, character } = sourceFile.getLineAndCharacterOfPosition(node.getStart());
+    console.log(`${sourceFile.fileName}:${line}:${character}:
+${chalk.red(message)}
+`);
+}
+async function main() {
+    await lint(targetDir, async (node, program) => {
+        let typeChecker = program.getTypeChecker();
+        if (!ts.isIdentifier(node.tag) || node.tag.escapedText !== "sql")
+            return;
+        let sqlStatement = node.template.rawText;
+        if (sqlStatement == null || sqlStatement.length === 0) {
+            report(node, "Empty sql query");
+            return;
+        }
+        const parent = node.parent;
+        if (!ts.isCallExpression(parent)) {
+            report(parent, "The parent of a sql`...` call should be a Call expression.");
+            return;
+        }
+        if (parent.arguments.length > 2) {
+            report(parent, "Expected at most 2 arguments to this call");
+            return;
+        }
+        const params = parent.arguments[1];
+        const usesRemappings = sqlStatement.includes("$/") || sqlStatement.includes("$(");
+        let description;
+        let argNames = null;
+        sqlStatement = sqlStatement
+            .replaceAll(":csv", "")
+            .replaceAll(/[^:]:json/g, "");
+        if (!usesRemappings) {
+            const descriptions = await asyncDescribeQueries(dbUrl, [sqlStatement]);
+            const first = descriptions[0];
+            if ("error" in first) {
+                report(node, `DBError: ${first.error}`);
+                return;
+            }
+            else {
+                description = first.description;
+            }
+        }
+        else {
+            argNames = [];
+            let prefix = "/";
+            let suffix = "/";
+            let counter = 1;
+            const normalizedStatement = sqlStatement.replaceAll(/\$[\/\(]\s*([a-zA-Z0-9_]*)\s*[\/\)]/g, (substring, name) => {
+                if (substring.endsWith(")")) {
+                    prefix = "(";
+                    suffix = ")";
+                }
+                let index = argNames.indexOf(name);
+                if (index < 0) {
+                    argNames.push(name);
+                    index = counter;
+                    counter += 1;
+                }
+                else {
+                    index += 1;
+                }
+                return `$${index}`;
+            });
+            const descriptions = await asyncDescribeQueries(dbUrl, [
+                normalizedStatement,
+            ]);
+            const first = descriptions[0];
+            if ("error" in first) {
+                report(node, "DBError: " +
+                    first.error.replace(/\$(\d+)/, (_, d) => `$${prefix}${argNames[parseInt(d, 10) - 1]}${suffix}`));
+                return;
+            }
+            else {
+                description = first.description;
+            }
+        }
+        if (description == null) {
+            throw new Error("Failed to get description of query");
+        }
+        const err = checkQueryParams(params, description.parameters, argNames, typeChecker);
+        if (err != null) {
+            report(err.node || node, err.message);
+        }
+        const isResultCall = ts.isPropertyAccessExpression(parent.expression) &&
+            parent.expression.name.text === "result";
+        if (isResultCall) {
+            return;
+        }
+        const ppp = parent.parent.parent;
+        if (ts.isVariableDeclaration(ppp)) {
+            const parentType = typeChecker.getTypeAtLocation(ppp);
+            let rowType = parentType;
+            if (rowType.isUnion()) {
+                const nonNull = rowType.types.filter((t) => !(t.flags & (ts.TypeFlags.Null | ts.TypeFlags.Undefined)));
+                if (nonNull.length === 1)
+                    rowType = nonNull[0];
+            }
+            if (typeChecker.isArrayType(rowType)) {
+                rowType = typeChecker.getTypeArguments(rowType)[0];
+            }
+            for (const col of description.columns) {
+                const returnedType = pgTypeToTsForColumns(col.type_info, typeChecker);
+                const prop = typeChecker.getPropertyOfType(rowType, col.name);
+                if (!prop) {
+                    report(node, `Return type is missing column "${col.name}" which is returned by the query.`);
+                    continue;
+                }
+                const userDefinedType = typeChecker.getTypeOfSymbol(prop);
+                if (!returnedType.some((t) => typeChecker.isTypeAssignableTo(t, userDefinedType))) {
+                    report(node, `Column "${col.name}" typed as ${typeChecker.typeToString(userDefinedType)} but query returns${returnedType.length > 1 ? " one of" : ""} ${returnedType.map((t) => typeChecker.typeToString(t)).join(", ")}`);
+                }
+            }
+            const expectedNames = new Set(description.columns.map((c) => c.name));
+            for (const prop of typeChecker.getPropertiesOfType(rowType)) {
+                if (!expectedNames.has(prop.name)) {
+                    report(node, `Return type has extra property "${prop.name}" not returned by the query`);
+                }
+            }
+        }
+    });
+    console.log(`${count} errors found`);
+    process.exit(count > 0 ? 1 : 0);
+}
+main();
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EACN,oBAAoB,GAIpB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC;IACzC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3B,OAAO,EAAE;QACR,EAAE,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,sDAAsD;SAC/D;KACD;IACD,gBAAgB,EAAE,IAAI;CACtB,CAAC,CAAC;AAEH,MAAM,GAAG,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;AAC3B,IAAI,CAAC,GAAG,EAAE,CAAC;IACV,OAAO,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACjE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACjB,CAAC;AACD,MAAM,SAAS,GAAW,GAAG,CAAC;AAE9B,MAAM,KAAK,GAAG,MAAM,CAAC,EAAG,CAAC;AAEzB,KAAK,UAAU,SAAS,CAAC,GAAW,EAAE,OAAiB;IACtD,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAEpC,MAAM,OAAO,CAAC,GAAG,CAChB,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;QACrB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAClC,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,IAAI,EAAE,WAAW,EAAE,EAAE,CAAC;YACzB,MAAM,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAChC,CAAC;aAAM,CAAC;YACP,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC;IACF,CAAC,CAAC,CACF,CAAC;IAEF,OAAO,OAAO,CAAC;AAChB,CAAC;AAED,KAAK,UAAU,IAAI,CAAC,GAAW;IAC9B,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC9B,OAAO,OAAO,CAAC;AAChB,CAAC;AAED,KAAK,UAAU,QAAQ,CACtB,IAAa,EACb,QAGkB,EAClB,OAAmB;IAEnB,IAAI,EAAE,CAAC,0BAA0B,CAAC,IAAI,CAAC,EAAE,CAAC;QACzC,MAAM,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,QAAQ,GAAoB,EAAE,CAAC;IACrC,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE;QAC3B,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC7B,CAAC;AAED,KAAK,UAAU,IAAI,CAClB,GAAW,EACX,QAGkB;IAElB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC;IAClC,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,SAAS,EAAE;QAC3C,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM;KAC9B,CAAC,CAAC;IAEH,MAAM,OAAO,CAAC,GAAG,CAChB,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QAChC,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU;YAAE,OAAO;QACxB,MAAM,QAAQ,CAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC,CAAC,CACF,CAAC;AACH,CAAC;AAED,SAAS,wBAAwB,CAChC,OAAe,EACf,WAA2B;IAE3B,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QACjC,QAAQ,OAAO,EAAE,CAAC;YACjB,KAAK,MAAM;gBACV,OAAO,WAAW,CAAC,cAAc,EAAE,CAAC;YACrC,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,MAAM,CAAC;YACZ,KAAK,MAAM;gBACV,OAAO,WAAW,CAAC,aAAa,EAAE,CAAC;YACpC,KAAK,MAAM,CAAC;YACZ,KAAK,SAAS;gBACb,OAAQ,WAAmB,CAAC,YAAY,CAAC;oBACxC,WAAW,CAAC,aAAa,EAAE;oBAC3B,WAAW,CAAC,aAAa,EAAE;iBAC3B,CAAC,CAAC;YACJ,KAAK,UAAU,CAAC;YAChB,KAAK,MAAM,CAAC;YACZ,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC;YACZ,KAAK,SAAS,CAAC;YACf,KAAK,MAAM;gBACV,OAAO,WAAW,CAAC,aAAa,EAAE,CAAC;YACpC,KAAK,MAAM,CAAC;YACZ,KAAK,WAAW,CAAC;YACjB,KAAK,aAAa,CAAC,CAAC,CAAC;gBACpB,MAAM,UAAU,GAAI,WAAmB,CAAC,WAAW,CAClD,MAAM,EACN,SAAS,EACT,EAAE,CAAC,WAAW,CAAC,IAAI,EACnB,KAAK,CACL,CAAC;gBACF,MAAM,QAAQ,GAAG,WAAW,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;gBACjE,OAAQ,WAAmB,CAAC,YAAY,CAAC;oBACxC,WAAW,CAAC,aAAa,EAAE;oBAC3B,QAAQ;iBACR,CAAC,CAAC;YACJ,CAAC;YACD,KAAK,WAAW;gBACf,OAAQ,WAAmB,CAAC,eAAe,CAC1C,WAAW,CAAC,aAAa,EAAE,CAC3B,CAAC;YACH,KAAK,aAAa,CAAC;YACnB,KAAK,aAAa,CAAC;YACnB,KAAK,WAAW,CAAC;YACjB,KAAK,WAAW,CAAC;YACjB,KAAK,WAAW;gBACf,OAAQ,WAAmB,CAAC,eAAe,CACzC,WAAmB,CAAC,YAAY,CAAC;oBACjC,WAAW,CAAC,aAAa,EAAE;oBAC1B,WAAmB,CAAC,eAAe,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC;iBACjE,CAAC,CACF,CAAC;YACH,KAAK,OAAO;gBACX,OAAO,WAAW,CAAC,UAAU,EAAE,CAAC;QAClC,CAAC;QACD,MAAM,yBAAyB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;IAC1D,CAAC;IACD,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;QACzB,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7C,IAAI,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBACnC,OAAO,WAAW,CAAC,aAAa,EAAE,CAAC;YACpC,CAAC;iBAAM,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC3C,OAAQ,WAAmB,CAAC,eAAe,CAC1C,wBAAwB,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,CAChE,CAAC;YACH,CAAC;QACF,CAAC;IACF,CAAC;IACD,MAAM,yBAAyB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;AAC1D,CAAC;AAED,SAAS,0BAA0B,CAClC,OAAe,EACf,QAAoC,EACpC,WAA2B;IAE3B,MAAM,KAAK,GAAG,wBAAwB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC7D,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACvB,OAAO,WAAW,CAAC,eAAe,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO,KAAK,CAAC;AACd,CAAC;AAED,SAAS,oBAAoB,CAC5B,OAAe,EACf,WAA2B;IAE3B,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QACjC,QAAQ,OAAO,EAAE,CAAC;YACjB,KAAK,MAAM;gBACV,OAAO,CAAC,WAAW,CAAC,cAAc,EAAE,CAAC,CAAC;YACvC,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,MAAM,CAAC;YACZ,KAAK,MAAM;gBACV,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC,CAAC;YACtC,KAAK,MAAM,CAAC;YACZ,KAAK,SAAS;gBACb,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC,CAAC;YACtC,KAAK,WAAW,CAAC;YACjB,KAAK,MAAM,CAAC;YACZ,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC;YACZ,KAAK,SAAS;gBACb,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC,CAAC;YACtC,KAAK,MAAM,CAAC;YACZ,KAAK,WAAW,CAAC;YACjB,KAAK,aAAa,CAAC,CAAC,CAAC;gBACpB,MAAM,UAAU,GAAI,WAAmB,CAAC,WAAW,CAClD,MAAM,EACN,SAAS,EACT,EAAE,CAAC,WAAW,CAAC,IAAI,EACnB,KAAK,CACL,CAAC;gBACF,MAAM,QAAQ,GAAG,WAAW,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;gBACjE,OAAO,CAAC,QAAQ,CAAC,CAAC;YACnB,CAAC;YACD,KAAK,WAAW;gBACf,OAAO;oBACL,WAAmB,CAAC,eAAe,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC;iBACjE,CAAC;YACH,KAAK,aAAa,CAAC;YACnB,KAAK,aAAa,CAAC;YACnB,KAAK,WAAW,CAAC;YACjB,KAAK,WAAW,CAAC;YACjB,KAAK,WAAW;gBACf,OAAO;oBACL,WAAmB,CAAC,eAAe,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC;oBAChE,WAAmB,CAAC,eAAe,CAClC,WAAmB,CAAC,eAAe,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC,CACjE;iBACD,CAAC;YACH,KAAK,WAAW,CAAC;YACjB,KAAK,YAAY,CAAC;YAClB,KAAK,MAAM,CAAC;YACZ,KAAK,OAAO;gBACX,OAAO,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,CAAC;QACpC,CAAC;QACD,MAAM,yBAAyB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;IAC1D,CAAC;IACD,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;QACzB,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7C,IAAI,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBACnC,OAAO;oBACL,WAAmB,CAAC,YAAY,CAChC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAClC,WAAW,CAAC,oBAAoB,CAAC,CAAC,CAAC,CACnC,CACD;iBACD,CAAC;YACH,CAAC;iBAAM,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC3C,OAAO;oBACL,WAAmB,CAAC,eAAe,CACnC,wBAAwB,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,CAChE;iBACD,CAAC;YACH,CAAC;QACF,CAAC;IACF,CAAC;IACD,MAAM,yBAAyB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;AAC1D,CAAC;AAOD,SAAS,gBAAgB,CACxB,WAAsC,EACtC,cAAiC,EACjC,QAAyB,EACzB,WAA2B;IAE3B,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;QAC5B,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;YACzB,OAAO;gBACN,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,wDAAwD;aACjE,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAI,OAAO,IAAI,cAAc,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;QACzB,IAAI,cAAc,IAAI,IAAI,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChE,OAAO,IAAI,CAAC;QACb,CAAC;QACD,OAAO,EAAE,OAAO,EAAE,oDAAoD,EAAE,CAAC;IAC1E,CAAC;IAED,MAAM,kBAAkB,GAAG,cAAc,CAAC,IAAI,CAAC;IAE/C,MAAM,eAAe,GAA4B,EAAE,CAAC;IAEpD,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QACtB,MAAM,CAAC,GAAG,WAAW,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;QACrD,KAAK,MAAM,QAAQ,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC;YAC1C,MAAM,CAAC,GAAG,WAAW,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;YAChD,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC;QACtD,CAAC;IACF,CAAC;SAAM,CAAC;QACP,IAAI,CAAC,EAAE,CAAC,wBAAwB,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/C,OAAO;gBACN,IAAI,EAAE,WAAW;gBACjB,OAAO,EACN,uEAAuE;aACxE,CAAC;QACH,CAAC;aAAM,CAAC;YACP,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;gBACrC,IAAI,CAAC,IAAI,IAAI;oBAAE,OAAO;gBACtB,MAAM,CAAC,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;gBAC3C,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,KAAK,MAAM,aAAa,IAAI,kBAAkB,EAAE,CAAC;QAChD,MAAM,IAAI,GAAG,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAChC,MAAM,KAAK,GAAG,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,SAAS,GAAG,eAAe,CAAC,IAAI,CAAE,CAAC;QACzC,IAAI,CAAC;YACJ,MAAM,QAAQ,GAAG,0BAA0B,CAC1C,aAAa,EACb,KAAK,EACL,WAAW,CACX,CAAC;YACF,IACC,CAAC,WAAW,CAAC,kBAAkB,CAC9B,SAAS,EACT,WAAW,CAAC,eAAe,CAAC,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAC7D,EACA,CAAC;gBACF,OAAO;oBACN,OAAO,EAAE,cAAc,WAAW,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,KAAK,aAAa,WAAW,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE;iBACzH,CAAC;YACH,CAAC;QACF,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,OAAO;gBACN,OAAO,EAAE,CAAW;aACpB,CAAC;QACH,CAAC;QACD,CAAC,IAAI,CAAC,CAAC;IACR,CAAC;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAED,IAAI,KAAK,GAAG,CAAC,CAAC;AAEd,SAAS,MAAM,CAAC,IAAa,EAAE,OAAe;IAC7C,KAAK,EAAE,CAAC;IACR,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;IACxC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,UAAU,CAAC,6BAA6B,CACnE,IAAI,CAAC,QAAQ,EAAE,CACf,CAAC;IACF,OAAO,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,QAAQ,IAAI,IAAI,IAAI,SAAS;EACtD,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC;CACnB,CAAC,CAAC;AACH,CAAC;AAED,KAAK,UAAU,IAAI;IAClB,MAAM,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE;QAC7C,IAAI,WAAW,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;QAE3C,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,WAAW,KAAK,KAAK;YAAE,OAAO;QACzE,IAAI,YAAY,GAAY,IAAI,CAAC,QAAgB,CAAC,OAAO,CAAC;QAC1D,IAAI,YAAY,IAAI,IAAI,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvD,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;YAChC,OAAO;QACR,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC;YAClC,MAAM,CACL,MAAM,EACN,4DAA4D,CAC5D,CAAC;YACF,OAAO;QACR,CAAC;QACD,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjC,MAAM,CAAC,MAAM,EAAE,2CAA2C,CAAC,CAAC;YAC5D,OAAO;QACR,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAEnC,MAAM,cAAc,GACnB,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC5D,IAAI,WAAuB,CAAC;QAC5B,IAAI,QAAQ,GAAoB,IAAI,CAAC;QACrC,YAAY,GAAG,YAAY;aACzB,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;aACtB,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QAE/B,IAAI,CAAC,cAAc,EAAE,CAAC;YACrB,MAAM,YAAY,GAAG,MAAM,oBAAoB,CAAC,KAAK,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;YACvE,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,CAAE,CAAC;YAC/B,IAAI,OAAO,IAAI,KAAK,EAAE,CAAC;gBACtB,MAAM,CAAC,IAAI,EAAE,YAAY,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;gBACxC,OAAO;YACR,CAAC;iBAAM,CAAC;gBACP,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;YACjC,CAAC;QACF,CAAC;aAAM,CAAC;YACP,QAAQ,GAAG,EAAE,CAAC;YACd,IAAI,MAAM,GAAG,GAAG,CAAC;YACjB,IAAI,MAAM,GAAG,GAAG,CAAC;YACjB,IAAI,OAAO,GAAG,CAAC,CAAC;YAChB,MAAM,mBAAmB,GAAG,YAAY,CAAC,UAAU,CAClD,sCAAsC,EACtC,CAAC,SAAS,EAAE,IAAI,EAAE,EAAE;gBACnB,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC7B,MAAM,GAAG,GAAG,CAAC;oBACb,MAAM,GAAG,GAAG,CAAC;gBACd,CAAC;gBACD,IAAI,KAAK,GAAG,QAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACpC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;oBACf,QAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACrB,KAAK,GAAG,OAAO,CAAC;oBAChB,OAAO,IAAI,CAAC,CAAC;gBACd,CAAC;qBAAM,CAAC;oBACP,KAAK,IAAI,CAAC,CAAC;gBACZ,CAAC;gBACD,OAAO,IAAI,KAAK,EAAE,CAAC;YACpB,CAAC,CACD,CAAC;YACF,MAAM,YAAY,GAAG,MAAM,oBAAoB,CAAC,KAAK,EAAE;gBACtD,mBAAmB;aACnB,CAAC,CAAC;YACH,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,CAAE,CAAC;YAC/B,IAAI,OAAO,IAAI,KAAK,EAAE,CAAC;gBACtB,MAAM,CACL,IAAI,EACJ,WAAW;oBACV,KAAK,CAAC,KAAK,CAAC,OAAO,CAClB,SAAS,EACT,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,MAAM,GAAG,QAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,EAAE,CAChE,CACF,CAAC;gBACF,OAAO;YACR,CAAC;iBAAM,CAAC;gBACP,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;YACjC,CAAC;QACF,CAAC;QAED,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACvD,CAAC;QAED,MAAM,GAAG,GAAG,gBAAgB,CAC3B,MAAM,EACN,WAAW,CAAC,UAAU,EACtB,QAAQ,EACR,WAAW,CACX,CAAC;QACF,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;YACjB,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC;QAED,MAAM,YAAY,GACjB,EAAE,CAAC,0BAA0B,CAAC,MAAM,CAAC,UAAU,CAAC;YAChD,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC;QAC1C,IAAI,YAAY,EAAE,CAAC;YAClB,OAAO;QACR,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;QACjC,IAAI,EAAE,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC;YACnC,MAAM,UAAU,GAAG,WAAW,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;YAEtD,IAAI,OAAO,GAAG,UAAU,CAAC;YACzB,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;gBACvB,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CACnC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,GAAG,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAChE,CAAC;gBACF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;oBAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAE,CAAC;YACjD,CAAC;YACD,IAAK,WAAmB,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/C,OAAO,GAAG,WAAW,CAAC,gBAAgB,CAAC,OAA2B,CAAC,CAAC,CAAC,CAAE,CAAC;YACzE,CAAC;YAED,KAAK,MAAM,GAAG,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;gBACvC,MAAM,YAAY,GAAG,oBAAoB,CAAC,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;gBACtE,MAAM,IAAI,GAAG,WAAW,CAAC,iBAAiB,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC9D,IAAI,CAAC,IAAI,EAAE,CAAC;oBACX,MAAM,CACL,IAAI,EACJ,kCAAkC,GAAG,CAAC,IAAI,mCAAmC,CAC7E,CAAC;oBACF,SAAS;gBACV,CAAC;gBACD,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;gBAC1D,IACC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CACxB,WAAW,CAAC,kBAAkB,CAAC,CAAC,EAAE,eAAe,CAAC,CAClD,EACA,CAAC;oBACF,MAAM,CACL,IAAI,EACJ,WAAW,GAAG,CAAC,IAAI,cAAc,WAAW,CAAC,YAAY,CAAC,eAAe,CAAC,qBAAqB,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC5M,CAAC;gBACH,CAAC;YACF,CAAC;YAED,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YACtE,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC7D,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;oBACnC,MAAM,CACL,IAAI,EACJ,mCAAmC,IAAI,CAAC,IAAI,6BAA6B,CACzE,CAAC;gBACH,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,eAAe,CAAC,CAAC;IACrC,OAAO,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACjC,CAAC;AAED,IAAI,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,25 @@
+{
+	"name": "sql-linter",
+	"version": "0.1.0",
+	"description": "SQL type-checker",
+	"type": "module",
+	"bin": {
+		"sql-linter": "./dist/index.js"
+	},
+	"scripts": {
+		"build": "tsc",
+		"dev": "tsx src/index.ts"
+	},
+	"dependencies": {
+		"chalk": "^5.6.2",
+		"sql-describe": "^0.1.13",
+		"typescript": "5.8.2"
+	},
+	"devDependencies": {
+		"@types/node": "^22.0.0",
+		"tsx": "^4.20.5"
+	},
+	"engines": {
+		"node": ">=22"
+	}
+}

package/src/index.ts

@@ -0,0 +1,527 @@
+#!/usr/bin/env node
+import * as fs from "node:fs/promises";
+import path from "node:path";
+import { parseArgs } from "node:util";
+import chalk from "chalk";
+import {
+	asyncDescribeQueries,
+	type Parameters,
+	type PgDescribe,
+	type PgType,
+} from "sql-describe";
+import ts from "typescript";
+
+const { values, positionals } = parseArgs({
+	args: process.argv.slice(2),
+	options: {
+		db: {
+			type: "string",
+			default: "postgres://postgres:postgres@localhost:5432/postgres",
+		},
+	},
+	allowPositionals: true,
+});
+
+const dir = positionals[0];
+if (!dir) {
+	console.error("Usage: sql-linter <dir> [--db <connection-url>]");
+	process.exit(1);
+}
+const targetDir: string = dir;
+
+const dbUrl = values.db!;
+
+async function walkInner(dir: string, results: string[]) {
+	const files = await fs.readdir(dir);
+
+	await Promise.all(
+		files.map(async (f) => {
+			const file = path.resolve(dir, f);
+			const stat = await fs.stat(file);
+			if (stat?.isDirectory()) {
+				await walkInner(file, results);
+			} else {
+				results.push(file);
+			}
+		}),
+	);
+
+	return results;
+}
+
+async function walk(dir: string): Promise<string[]> {
+	const results: string[] = [];
+	await walkInner(dir, results);
+	return results;
+}
+
+async function lintNode(
+	node: ts.Node,
+	callback: (
+		taggedTemplateExpression: ts.TaggedTemplateExpression,
+		program: ts.Program,
+	) => Promise<void>,
+	program: ts.Program,
+) {
+	if (ts.isTaggedTemplateExpression(node)) {
+		await callback(node, program);
+	}
+
+	const promises: Promise<void>[] = [];
+	ts.forEachChild(node, (n) => {
+		promises.push(lintNode(n, callback, program));
+	});
+	await Promise.all(promises);
+}
+
+async function lint(
+	dir: string,
+	callback: (
+		taggedTemplateExpression: ts.TaggedTemplateExpression,
+		program: ts.Program,
+	) => Promise<void>,
+) {
+	const fileNames = await walk(dir);
+	const program = ts.createProgram(fileNames, {
+		target: ts.ScriptTarget.ES2015,
+	});
+
+	await Promise.all(
+		fileNames.map(async (fileName) => {
+			const sourceFile = program.getSourceFile(fileName);
+			if (!sourceFile) return;
+			await lintNode(sourceFile, callback, program);
+		}),
+	);
+}
+
+function pgTypeToTsInnerForParams(
+	pg_type: PgType,
+	typeChecker: ts.TypeChecker,
+): ts.Type {
+	if (typeof pg_type === "string") {
+		switch (pg_type) {
+			case "Bool":
+				return typeChecker.getBooleanType();
+			case "Float4":
+			case "Float8":
+			case "Int2":
+			case "Int4":
+				return typeChecker.getNumberType();
+			case "Int8":
+			case "Numeric":
+				return (typeChecker as any).getUnionType([
+					typeChecker.getNumberType(),
+					typeChecker.getBigIntType(),
+				]);
+			case "Interval":
+			case "Text":
+			case "Varchar":
+			case "Time":
+			case "Macaddr":
+			case "Uuid":
+				return typeChecker.getStringType();
+			case "Date":
+			case "Timestamp":
+			case "Timestamptz": {
+				const dateSymbol = (typeChecker as any).resolveName(
+					"Date",
+					undefined,
+					ts.SymbolFlags.Type,
+					false,
+				);
+				const dateType = typeChecker.getDeclaredTypeOfSymbol(dateSymbol);
+				return (typeChecker as any).getUnionType([
+					typeChecker.getStringType(),
+					dateType,
+				]);
+			}
+			case "TextArray":
+				return (typeChecker as any).createArrayType(
+					typeChecker.getStringType(),
+				);
+			case "Float4Array":
+			case "Float8Array":
+			case "Int2Array":
+			case "Int4Array":
+			case "Int8Array":
+				return (typeChecker as any).createArrayType(
+					(typeChecker as any).getUnionType([
+						typeChecker.getNumberType(),
+						(typeChecker as any).createArrayType(typeChecker.getNumberType()),
+					]),
+				);
+			case "Jsonb":
+				return typeChecker.getAnyType();
+		}
+		throw `Unsupported data type ${JSON.stringify(pg_type)}`;
+	}
+	if ("Custom" in pg_type) {
+		if (typeof pg_type.Custom.kind !== "string") {
+			if ("Enum" in pg_type.Custom.kind) {
+				return typeChecker.getStringType();
+			} else if ("Array" in pg_type.Custom.kind) {
+				return (typeChecker as any).createArrayType(
+					pgTypeToTsInnerForParams(pg_type.Custom.kind.Array, typeChecker),
+				);
+			}
+		}
+	}
+	throw `Unsupported data type ${JSON.stringify(pg_type)}`;
+}
+
+function pgTypeToTsMappingForParams(
+	pg_type: PgType,
+	nullable: boolean | null | undefined,
+	typeChecker: ts.TypeChecker,
+): ts.Type {
+	const inner = pgTypeToTsInnerForParams(pg_type, typeChecker);
+	if (nullable === true) {
+		return typeChecker.getNullableType(inner, ts.TypeFlags.Null);
+	}
+
+	return inner;
+}
+
+function pgTypeToTsForColumns(
+	pg_type: PgType,
+	typeChecker: ts.TypeChecker,
+): ts.Type[] {
+	if (typeof pg_type === "string") {
+		switch (pg_type) {
+			case "Bool":
+				return [typeChecker.getBooleanType()];
+			case "Float4":
+			case "Float8":
+			case "Int2":
+			case "Int4":
+				return [typeChecker.getNumberType()];
+			case "Int8":
+			case "Numeric":
+				return [typeChecker.getStringType()];
+			case "TstzRange":
+			case "Uuid":
+			case "Macaddr":
+			case "Text":
+			case "Varchar":
+				return [typeChecker.getStringType()];
+			case "Date":
+			case "Timestamp":
+			case "Timestamptz": {
+				const dateSymbol = (typeChecker as any).resolveName(
+					"Date",
+					undefined,
+					ts.SymbolFlags.Type,
+					false,
+				);
+				const dateType = typeChecker.getDeclaredTypeOfSymbol(dateSymbol);
+				return [dateType];
+			}
+			case "TextArray":
+				return [
+					(typeChecker as any).createArrayType(typeChecker.getStringType()),
+				];
+			case "Float4Array":
+			case "Float8Array":
+			case "Int2Array":
+			case "Int4Array":
+			case "Int8Array":
+				return [
+					(typeChecker as any).createArrayType(typeChecker.getNumberType()),
+					(typeChecker as any).createArrayType(
+						(typeChecker as any).createArrayType(typeChecker.getNumberType()),
+					),
+				];
+			case "JsonArray":
+			case "JsonbArray":
+			case "Json":
+			case "Jsonb":
+				return [typeChecker.getAnyType()];
+		}
+		throw `Unsupported data type ${JSON.stringify(pg_type)}`;
+	}
+	if ("Custom" in pg_type) {
+		if (typeof pg_type.Custom.kind !== "string") {
+			if ("Enum" in pg_type.Custom.kind) {
+				return [
+					(typeChecker as any).getUnionType(
+						pg_type.Custom.kind.Enum.map((v) =>
+							typeChecker.getStringLiteralType(v),
+						),
+					),
+				];
+			} else if ("Array" in pg_type.Custom.kind) {
+				return [
+					(typeChecker as any).createArrayType(
+						pgTypeToTsInnerForParams(pg_type.Custom.kind.Array, typeChecker),
+					),
+				];
+			}
+		}
+	}
+	throw `Unsupported data type ${JSON.stringify(pg_type)}`;
+}
+
+type CheckQueryParamsError = {
+	node?: ts.Node;
+	message: string;
+};
+
+function checkQueryParams(
+	givenParams: ts.Expression | undefined,
+	expectedParams: Parameters | null,
+	argNames: string[] | null,
+	typeChecker: ts.TypeChecker,
+): CheckQueryParamsError | null {
+	if (expectedParams == null) {
+		if (givenParams != null) {
+			return {
+				node: givenParams,
+				message: "This query takes no params, but you supplied some here",
+			};
+		}
+		return null;
+	}
+
+	if ("Right" in expectedParams) {
+		throw new Error("This should only happen for mssql");
+	}
+
+	if (givenParams == null) {
+		if (expectedParams == null || expectedParams.Left.length === 0) {
+			return null;
+		}
+		return { message: "This query expects parameters, but none were given" };
+	}
+
+	const expectedParameters = expectedParams.Left;
+
+	const givenParameters: Record<string, ts.Type> = {};
+
+	if (argNames != null) {
+		const t = typeChecker.getTypeAtLocation(givenParams);
+		for (const property of t.getProperties()) {
+			const t = typeChecker.getTypeOfSymbol(property);
+			givenParameters[property.escapedName.toString()] = t;
+		}
+	} else {
+		if (!ts.isArrayLiteralExpression(givenParams)) {
+			return {
+				node: givenParams,
+				message:
+					"The arguments to the call should be an array e.g.: `[value1, value2]`",
+			};
+		} else {
+			givenParams.elements.forEach((e, i) => {
+				if (e == null) return;
+				const t = typeChecker.getTypeAtLocation(e);
+				givenParameters[i] = t;
+			});
+		}
+	}
+
+	let i = 0;
+	for (const expectedParam of expectedParameters) {
+		const name = argNames?.[i] || i;
+		const eName = argNames?.[i] || i + 1;
+		const paramType = givenParameters[name]!;
+		try {
+			const expected = pgTypeToTsMappingForParams(
+				expectedParam,
+				false,
+				typeChecker,
+			);
+			if (
+				!typeChecker.isTypeAssignableTo(
+					paramType,
+					typeChecker.getNullableType(expected, ts.TypeFlags.Undefined),
+				)
+			) {
+				return {
+					message: `Expected a ${typeChecker.typeToString(expected)} for $${eName}, found a ${typeChecker.typeToString(paramType)}`,
+				};
+			}
+		} catch (e) {
+			return {
+				message: e as string,
+			};
+		}
+		i += 1;
+	}
+
+	return null;
+}
+
+let count = 0;
+
+function report(node: ts.Node, message: string) {
+	count++;
+	const sourceFile = node.getSourceFile();
+	const { line, character } = sourceFile.getLineAndCharacterOfPosition(
+		node.getStart(),
+	);
+	console.log(`${sourceFile.fileName}:${line}:${character}:
+${chalk.red(message)}
+`);
+}
+
+async function main() {
+	await lint(targetDir, async (node, program) => {
+		let typeChecker = program.getTypeChecker();
+
+		if (!ts.isIdentifier(node.tag) || node.tag.escapedText !== "sql") return;
+		let sqlStatement: string = (node.template as any).rawText;
+		if (sqlStatement == null || sqlStatement.length === 0) {
+			report(node, "Empty sql query");
+			return;
+		}
+		const parent = node.parent;
+		if (!ts.isCallExpression(parent)) {
+			report(
+				parent,
+				"The parent of a sql`...` call should be a Call expression.",
+			);
+			return;
+		}
+		if (parent.arguments.length > 2) {
+			report(parent, "Expected at most 2 arguments to this call");
+			return;
+		}
+
+		const params = parent.arguments[1];
+
+		const usesRemappings =
+			sqlStatement.includes("$/") || sqlStatement.includes("$(");
+		let description: PgDescribe;
+		let argNames: string[] | null = null;
+		sqlStatement = sqlStatement
+			.replaceAll(":csv", "")
+			.replaceAll(/[^:]:json/g, "");
+
+		if (!usesRemappings) {
+			const descriptions = await asyncDescribeQueries(dbUrl, [sqlStatement]);
+			const first = descriptions[0]!;
+			if ("error" in first) {
+				report(node, `DBError: ${first.error}`);
+				return;
+			} else {
+				description = first.description;
+			}
+		} else {
+			argNames = [];
+			let prefix = "/";
+			let suffix = "/";
+			let counter = 1;
+			const normalizedStatement = sqlStatement.replaceAll(
+				/\$[\/\(]\s*([a-zA-Z0-9_]*)\s*[\/\)]/g,
+				(substring, name) => {
+					if (substring.endsWith(")")) {
+						prefix = "(";
+						suffix = ")";
+					}
+					let index = argNames!.indexOf(name);
+					if (index < 0) {
+						argNames!.push(name);
+						index = counter;
+						counter += 1;
+					} else {
+						index += 1;
+					}
+					return `$${index}`;
+				},
+			);
+			const descriptions = await asyncDescribeQueries(dbUrl, [
+				normalizedStatement,
+			]);
+			const first = descriptions[0]!;
+			if ("error" in first) {
+				report(
+					node,
+					"DBError: " +
+						first.error.replace(
+							/\$(\d+)/,
+							(_, d) => `$${prefix}${argNames![parseInt(d, 10) - 1]}${suffix}`,
+						),
+				);
+				return;
+			} else {
+				description = first.description;
+			}
+		}
+
+		if (description == null) {
+			throw new Error("Failed to get description of query");
+		}
+
+		const err = checkQueryParams(
+			params,
+			description.parameters,
+			argNames,
+			typeChecker,
+		);
+		if (err != null) {
+			report(err.node || node, err.message);
+		}
+
+		const isResultCall =
+			ts.isPropertyAccessExpression(parent.expression) &&
+			parent.expression.name.text === "result";
+		if (isResultCall) {
+			return;
+		}
+
+		const ppp = parent.parent.parent;
+		if (ts.isVariableDeclaration(ppp)) {
+			const parentType = typeChecker.getTypeAtLocation(ppp);
+
+			let rowType = parentType;
+			if (rowType.isUnion()) {
+				const nonNull = rowType.types.filter(
+					(t) => !(t.flags & (ts.TypeFlags.Null | ts.TypeFlags.Undefined)),
+				);
+				if (nonNull.length === 1) rowType = nonNull[0]!;
+			}
+			if ((typeChecker as any).isArrayType(rowType)) {
+				rowType = typeChecker.getTypeArguments(rowType as ts.TypeReference)[0]!;
+			}
+
+			for (const col of description.columns) {
+				const returnedType = pgTypeToTsForColumns(col.type_info, typeChecker);
+				const prop = typeChecker.getPropertyOfType(rowType, col.name);
+				if (!prop) {
+					report(
+						node,
+						`Return type is missing column "${col.name}" which is returned by the query.`,
+					);
+					continue;
+				}
+				const userDefinedType = typeChecker.getTypeOfSymbol(prop);
+				if (
+					!returnedType.some((t) =>
+						typeChecker.isTypeAssignableTo(t, userDefinedType),
+					)
+				) {
+					report(
+						node,
+						`Column "${col.name}" typed as ${typeChecker.typeToString(userDefinedType)} but query returns${returnedType.length > 1 ? " one of" : ""} ${returnedType.map((t) => typeChecker.typeToString(t)).join(", ")}`,
+					);
+				}
+			}
+
+			const expectedNames = new Set(description.columns.map((c) => c.name));
+			for (const prop of typeChecker.getPropertiesOfType(rowType)) {
+				if (!expectedNames.has(prop.name)) {
+					report(
+						node,
+						`Return type has extra property "${prop.name}" not returned by the query`,
+					);
+				}
+			}
+		}
+	});
+
+	console.log(`${count} errors found`);
+	process.exit(count > 0 ? 1 : 0);
+}
+
+main();

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "skipLibCheck": true,
+    "sourceMap": true
+  },
+  "include": ["src"]
+}