SafeQL 🤝 Postgres.js

SafeQL is compatible with Postgres.js. In fact, SafeQL is built on top of Postgres.js!

First, Make sure you've added @ts-safeql/eslint-plugin to your ESLint plugins:

json

// .eslintrc.json
{
  "plugins": [..., "@ts-safeql/eslint-plugin"],
  ...
}

Second, add the following rule to your ESLint config:

json

// .eslintrc.json
{
  // ...
  "rules": {
    // ...
    "@ts-safeql/check-sql": [
      "error",
      {
        "connections": [
          {
            // ...

            // The name of the variable that holds the connection:
            "tagName": "sql",
            // Postgres.js type should be an array, so we add an extra "[]" after the generated type:
            "transform": "${type}[]"
          }
        ]
      }
    ]
  }
}

Lastly, SafeQL will be able to lint your queries like so:

typescript

import { sql } from "postgres";
import { myClient } from "./myClient"; // Read the note above

// Before:
const query = sql`SELECT idd FROM users`
                         ~~~ Error: column "idd" does not exist

// After bug fix:
const query = sql`SELECT id FROM users`
              ~~~ Error: Query is missing type annotation

// After: ✅
const query = sql<{ id: number; }[]>`SELECT id FROM users`

SafeQL 🤝 Postgres.js #

SafeQL 🤝 Postgres.js