feat: Allow importing safeql.config.ts in ESM project using the `form…

…at` property
ts-safeql · Apr 25, 2024 · 74547c2 · 74547c2
1 parent 1f81ad3
commit 74547c2
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 6 deletions.
diff --git a/.changeset/eighty-boxes-leave.md b/.changeset/eighty-boxes-leave.md
@@ -0,0 +1,19 @@
+---
+"@ts-safeql/eslint-plugin": patch
+---
+
+Allow importing safeql.config.ts in ESM project using the `format` property:
+
+```json
+{
+  "rules": {
+    "@ts-safeql/check-sql": [
+      "error",
+      {
+        "useConfigFile": true,
+        "format": "esm"
+      }
+    ]
+  }
+}
+```
diff --git a/packages/eslint-plugin/src/rules/check-sql.config.ts b/packages/eslint-plugin/src/rules/check-sql.config.ts
@@ -9,19 +9,20 @@ export function getConfigFromFileWithContext(params: {
   context: RuleContext;
   projectDir: string;
 }): Config {
-  if (!isConfigFileRuleOptions(params.context.options[0])) {
-    return params.context.options[0];
+  const options = params.context.options[0];
+  if (!isConfigFileRuleOptions(options)) {
+    return options;
   }
 
   return pipe(
-    getConfigFromFile(params.projectDir),
+    getConfigFromFile(params.projectDir, options.format ?? "cjs"),
     E.getOrElseW((message) => {
       throw new Error(`safeql: ${message}`);
     })
   );
 }
 
-function getConfigFromFile(projectDir: string): E.Either<string, Config> {
+function getConfigFromFile(projectDir: string, format: "esm" | "cjs"): E.Either<string, Config> {
   const configFilePath = path.join(projectDir, "safeql.config.ts");
   const tempFileName = `safeql.config.temp-${Date.now()}.js`;
   const tempFilePath = path.join(projectDir, tempFileName);
@@ -40,7 +41,7 @@ function getConfigFromFile(projectDir: string): E.Either<string, Config> {
     const result = esbuild.buildSync({
       entryPoints: [configFilePath],
       write: false,
-      format: "cjs",
+      format: format,
     });
 
     fs.writeFileSync(tempFilePath, result.outputFiles[0].text);

diff --git a/packages/eslint-plugin/src/rules/check-sql.rule.ts b/packages/eslint-plugin/src/rules/check-sql.rule.ts
@@ -182,7 +182,10 @@ export const zConfig = z.object({
 });
 export type Config = z.infer<typeof zConfig>;
 
-export const UserConfigFile = z.object({ useConfigFile: z.boolean() });
+export const UserConfigFile = z.object({
+  useConfigFile: z.boolean(),
+  format: z.enum(["esm", "cjs"]).optional(),
+});
 export type UserConfigFile = z.infer<typeof UserConfigFile>;
 
 export const Options = z.union([zConfig, UserConfigFile]);