eslint-plugin-slonik 1.6.0 → 1.7.0

package/README.md

@@ -42,24 +42,23 @@ export default [
     overrides: {
       types: {
         // Map PostgreSQL types to Slonik token types
-        date: "DateSqlToken",
-        timestamp: "TimestampSqlToken",
-        interval: "IntervalSqlToken",
-        json: "JsonSqlToken",
-        jsonb: "JsonBinarySqlToken",
-        uuid: "UuidSqlToken",
-        "int4[]": 'ArraySqlToken<"int4">',
-        "text[]": 'ArraySqlToken<"text">',
-        "uuid[]": 'ArraySqlToken<"uuid">',
-        "numeric[]": 'ArraySqlToken<"numeric">',
-        "real[]": "VectorSqlToken",
+        date: 'DateSqlToken',
+        timestamp: 'TimestampSqlToken',
+        interval: 'IntervalSqlToken',
+        json: 'JsonSqlToken',
+        jsonb: 'JsonBinarySqlToken',
+        uuid: 'UuidSqlToken',
+        'int4[]': 'ArraySqlToken<"int4">',
+        'text[]': 'ArraySqlToken<"text">',
+        'uuid[]': 'ArraySqlToken<"uuid">',
+        'numeric[]': 'ArraySqlToken<"numeric">',
+        'real[]': 'VectorSqlToken',
       },
     },
     targets: [
       {
         // Match Slonik's typed query methods
-        tag: "sql.+(type\\(*\\)|typeAlias\\(*\\)|unsafe)",
-        skipTypeAnnotations: true,
+        tag: 'sql.+(type\\(*\\)|typeAlias\\(*\\)|unsafe)',
       },
     ],
   }),
@@ -131,14 +130,14 @@ When using Slonik, you'll want to map PostgreSQL types to Slonik's token types:
 overrides: {
   types: {
     // Date/Time types
-    date: "DateSqlToken",
-    timestamp: "TimestampSqlToken",
+    date: 'DateSqlToken',
+    timestamp: 'TimestampSqlToken',
     timestamptz: "TimestampSqlToken",
-    interval: "IntervalSqlToken",
+    interval: 'IntervalSqlToken',
 
     // JSON types
-    json: "JsonSqlToken",
-    jsonb: "JsonBinarySqlToken",
+    json: 'JsonSqlToken',
+    jsonb: 'JsonBinarySqlToken',
 
     // UUID
     uuid: "UuidSqlToken",
@@ -167,7 +166,6 @@ targets: [
   {
     // Matches: sql.type(...)``, sql.typeAlias(...)``, sql.unsafe``
     tag: "sql.+(type\\(*\\)|typeAlias\\(*\\)|unsafe)",
-    skipTypeAnnotations: true,
   },
 ]
 ```
@@ -184,7 +182,7 @@ pnpm add -D eslint-plugin-slonik libpg-query
 ### 2. Create your SQL tag with type aliases
 
 ```ts
-// src/db/sql.ts
+// src/slonik.ts
 import { createSqlTag } from "slonik";
 import { z } from "zod";
 
@@ -209,19 +207,18 @@ export default tseslint.config(
     databaseUrl: process.env.DATABASE_URL,
     overrides: {
       types: {
-        date: "DateSqlToken",
-        timestamp: "TimestampSqlToken",
-        json: "JsonSqlToken",
-        jsonb: "JsonBinarySqlToken",
-        uuid: "UuidSqlToken",
-        "int4[]": 'ArraySqlToken<"int4">',
-        "text[]": 'ArraySqlToken<"text">',
+        date: 'DateSqlToken',
+        timestamp: 'TimestampSqlToken',
+        json: 'JsonSqlToken',
+        jsonb: 'JsonBinarySqlToken',
+        uuid: 'UuidSqlToken',
+        'int4[]': 'ArraySqlToken<"int4">',
+        'text[]': 'ArraySqlToken<"text">',
       },
     },
     targets: [
       {
-        tag: "sql.+(type\\(*\\)|typeAlias\\(*\\)|unsafe)",
-        skipTypeAnnotations: true,
+        tag: 'sql.+(type\\(*\\)|typeAlias\\(*\\)|unsafe)',
       },
     ],
   })
@@ -231,8 +228,7 @@ export default tseslint.config(
 ### 4. Write validated queries
 
 ```ts
-import { sql } from "./db/sql";
-import { pool } from "./db/pool";
+import { pool, sql } from "./slonik";
 
 // ✅ Valid - query matches schema
 const users = await pool.many(
@@ -274,6 +270,18 @@ This plugin is specifically designed for Slonik and includes:
 4. **Identifier support** — Converts `sql.identifier()` to quoted identifiers
 5. **Graceful degradation** — Skips validation for runtime-dependent constructs instead of erroring
 
+## How It Works
+
+ESLint rules must be synchronous, but SQL validation requires async operations like database connections. This plugin solves this using [`synckit`](https://github.com/un-ts/synckit), which enables synchronous calls to async worker threads.
+
+The architecture:
+
+1. **Worker Thread** — Runs all async operations (database connections, migrations, type generation) in a separate thread
+2. **Synchronous Bridge** — Uses `synckit` to block the main thread until the worker completes, making async operations appear synchronous to ESLint
+3. **Connection Pooling** — Reuses database connections across lint runs for performance
+
+Under the hood, `synckit` uses Node.js Worker Threads with `Atomics.wait()` to block the main thread until the worker signals completion via `Atomics.notify()`.
+
 ## Development
 
 ### Prerequisites

package/dist/index.cjs

@@ -1072,9 +1072,16 @@ function checkType(params) {
   `);
 }
 
-const distDir = node_url.fileURLToPath(new URL("../../dist", (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))));
+const currentDir = node_url.fileURLToPath(new URL(".", (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))));
+const isSourceDir = currentDir.includes(path__default.sep + "src" + path__default.sep);
+function getWorkerPath(name) {
+  if (isSourceDir) {
+    return path__default.join(currentDir, "../../dist/workers", `${name}.worker.mjs`);
+  }
+  return path__default.join(currentDir, "workers", `${name}.worker.mjs`);
+}
 function defineWorker(params) {
-  return synckit.createSyncFn(path__default.join(distDir, `./workers/${params.name}.worker.mjs`), {
+  return synckit.createSyncFn(getWorkerPath(params.name), {
     tsRunner: "tsx",
     timeout: params.timeout
   });
@@ -1101,11 +1108,7 @@ const zBaseTarget = z__default.object({
    * - `"pascal"` - `user_id` → `UserId`
    * - `"screaming snake"` - `user_id` → `USER_ID`
    */
-  fieldTransform: z__default.enum(["snake", "pascal", "camel", "screaming snake"]).optional(),
-  /**
-   * Whether or not to skip type annotation.
-   */
-  skipTypeAnnotations: z__default.boolean().optional()
+  fieldTransform: z__default.enum(["snake", "pascal", "camel", "screaming snake"]).optional()
 });
 const zWrapperTarget = z__default.object({ wrapper: zStringOrRegex, maxDepth: z__default.number().optional() }).merge(zBaseTarget);
 const zTagTarget = z__default.object({ tag: zStringOrRegex }).merge(zBaseTarget);
@@ -1302,16 +1305,14 @@ function reportCheck(params) {
 If you believe this query should be supported, please open an issue at https://github.com/gajus/eslint-plugin-slonik/issues`
           );
           return;
+        }).with({ _tag: "ConnectionFailedError" }, () => {
+          return;
         }).exhaustive();
       },
       ({ result, checker, parser }) => {
         if (result === null) {
           return;
         }
-        const shouldSkipTypeAnnotations = target.skipTypeAnnotations === true;
-        if (shouldSkipTypeAnnotations) {
-          return;
-        }
         const isMissingTypeAnnotations = typeParameter === void 0;
         if (isMissingTypeAnnotations) {
           if (result.output === null) {