@antislop/zero-lucid-generator 1.0.0 → 1.1.0

package/README.md

@@ -60,10 +60,29 @@ import { schema, zql } from './zero-schema.gen.js'
 |---|---|---|---|
 | `modelsSourcePath` | `string` | **required** | Path to your models directory, relative to the config file |
 | `output` | `string` | `zero-schema.gen.ts` | Output file path, relative to the config file |
-| `prettier` | `boolean` | `false` | Format the output with Prettier (must be installed) |
+| `format` | `boolean` | `false` | Format the output with [oxfmt](https://oxc.rs/docs/guide/usage/formatter) (must be installed). Respects your `.oxfmtrc.json`. |
 | `excludeModels` | `LucidModel[]` | `[]` | Models to exclude from the generated schema |
 | `columnTypes` | `Record<string, Record<string, string>>` | `{}` | Override the inferred Zero type for specific columns |
 
+### Formatting with oxfmt
+
+Set `format: true` to have the generated file automatically formatted on every run:
+
+```ts
+const config: Config = {
+  modelsSourcePath: './app/models',
+  format: true,
+}
+```
+
+Install oxfmt in your project:
+
+```sh
+npm add -D oxfmt
+```
+
+The formatter picks up your `.oxfmtrc.json` / `oxfmt.config.ts` automatically, so the output will always match what your own format scripts produce.
+
 ---
 
 ## CLI options

package/dist/index.d.ts

@@ -9,7 +9,8 @@ type ConfigInput = {
      */
     excludeModels?: (abstract new (...args: any[]) => any)[];
     output?: string;
-    prettier?: boolean;
+    /** Format the output file with oxfmt. Requires oxfmt to be installed. */
+    format?: boolean;
     columnTypes?: Record<string, Record<string, string>>;
 };
 

package/dist/index.js

@@ -17,14 +17,14 @@ async function getDefaultExportFromModulePath(modulePath) {
   try {
     await fs.access(modulePath);
   } catch {
-    throw new Error(`lucid-zero: Module not found at ${modulePath}`);
+    throw new Error(`Module not found at ${modulePath}`);
   }
   const { tsImport } = await import("tsx/esm/api");
   const moduleUrl = url.pathToFileURL(modulePath).href;
   const module = await tsImport(moduleUrl, { parentURL: import.meta.url });
   const defaultExport = module.default;
   if (!defaultExport) {
-    throw new Error(`lucid-zero: Module at ${modulePath} does not have a default export`);
+    throw new Error(`Module at ${modulePath} does not have a default export`);
   }
   return defaultExport;
 }
@@ -49,17 +49,17 @@ var Config = class {
     this.excludeModels = configInput.excludeModels ?? [];
     this.outputFilePath = path.resolve(configDir, configInput.output ?? DEFAULT_OUTPUT_FILE_PATH);
     this.tsconfigPath = tsconfigPath ?? path.resolve(configDir, "tsconfig.json");
-    this.formatOutputFile = configInput.prettier ?? false;
+    this.formatOutputFile = configInput.format ?? false;
     this.columnTypes = configInput.columnTypes ?? {};
   }
   async verify() {
     if (!this.modelsSourcePath) {
-      throw new Error("lucid-zero: modelsSourcePath is required");
+      throw new Error("modelsSourcePath is required");
     }
     await this.loadModels();
     if (this.models.length === 0) {
       throw new Error(
-        `lucid-zero: No Lucid models found in modelsSourcePath. Each model file must have a default export that extends BaseModel.`
+        `No Lucid models found in modelsSourcePath. Each model file must have a default export that extends BaseModel.`
       );
     }
     this.verifyColumnTypes();
@@ -71,7 +71,7 @@ var Config = class {
       fileNames = await fs2.readdir(modelsSourceAbsPath);
     } catch (e) {
       throw new Error(
-        `lucid-zero: Could not read modelsSourcePath at ${modelsSourceAbsPath}. Does the directory exist?Error: ${e}`
+        `Could not read modelsSourcePath at ${modelsSourceAbsPath}. Does the directory exist?Error: ${e}`
       );
     }
     const tsFileNames = fileNames.filter((f) => f.endsWith(".ts") && !f.endsWith(".d.ts"));
@@ -84,7 +84,7 @@ var Config = class {
             path.join(modelsSourceAbsPath, fileName)
           );
         } catch (err) {
-          console.warn(`lucid-zero: Failed to import ${fileName}, skipping: ${String(err)}`);
+          console.warn(`Failed to import ${fileName}, skipping: ${String(err)}`);
           return null;
         }
         if (!this.isLucidModel(defaultExport)) {
@@ -106,14 +106,14 @@ var Config = class {
     for (const [modelName, columnOverrides] of Object.entries(this.columnTypes ?? {})) {
       if (!modelNames.has(modelName)) {
         throw new Error(
-          `lucid-zero: columnTypes has unknown model "${modelName}". Known models: ${[...modelNames].join(", ")}`
+          `columnTypes has unknown model "${modelName}". Known models: ${[...modelNames].join(", ")}`
         );
       }
       for (const [attributeName, typeString] of Object.entries(columnOverrides)) {
         const baseTypeName = typeString.match(/^([a-z]+)/)?.[1];
         if (!baseTypeName || !validZeroTypes.includes(baseTypeName)) {
           throw new Error(
-            `lucid-zero: columnTypes override for ${modelName}.${attributeName} has unrecognised type "${typeString}". Expected one of: ${validZeroTypes.join(", ")}`
+            `columnTypes override for ${modelName}.${attributeName} has unrecognised type "${typeString}". Expected one of: ${validZeroTypes.join(", ")}`
           );
         }
       }
@@ -137,8 +137,8 @@ var ConfigLoader = class {
       defaultExport = await getDefaultExportFromModulePath(absoluteConfigPath);
     } catch (err) {
       throw new Error(
-        `lucid-zero: Failed to import config at ${absoluteConfigPath}
-  Error: ${String(err)}`
+        `Failed to import config at ${absoluteConfigPath}
+  Error: ${err instanceof Error ? err.message : String(err)}`
       );
     }
     const config = new Config(defaultExport, path.dirname(absoluteConfigPath), opts.tsconfigPath);
@@ -190,12 +190,12 @@ var SchemaTransformer = class {
     });
     if (!modelSourceFile) {
       throw new Error(
-        `lucid-zero: Could not find source file for model ${model.name} in ${this.project.getSourceFiles().map((sourceFile) => sourceFile.getFilePath()).join(", ")}`
+        `Could not find source file for model ${model.name} in ${this.project.getSourceFiles().map((sourceFile) => sourceFile.getFilePath()).join(", ")}`
       );
     }
     const classDeclaration = modelSourceFile.getClass(model.name);
     if (!classDeclaration) {
-      throw new Error(`lucid-zero: Could not find class declaration for model ${model.name}`);
+      throw new Error(`Could not find class declaration for model ${model.name}`);
     }
     let currentClass = classDeclaration;
     while (currentClass) {
@@ -226,7 +226,7 @@ var SchemaTransformer = class {
           zeroType = tsTypeToZeroType(tsType);
         } else {
           console.warn(
-            `lucid-zero: Could not infer Zero type for ${model.name}.${attributeName}. Falling back to json(). Add a columnTypes override if this is wrong.`
+            `Could not infer Zero type for ${model.name}.${attributeName}. Falling back to json(). Add a columnTypes override if this is wrong.`
           );
           zeroType = "json()";
         }
@@ -247,13 +247,13 @@ var SchemaTransformer = class {
         relation.boot();
       } catch (err) {
         throw new Error(
-          `lucid-zero: Failed to boot relation "${relationName}" on ${model.name}: ${String(err)}`
+          `Failed to boot relation "${relationName}" on ${model.name}: ${String(err)}`
         );
       }
       const relatedModel = relation.relatedModel();
       if (!allModels.some((m) => m.name === relatedModel.name)) {
         console.info(
-          `lucid-zero: Skipping relation "${relationName}" on ${model.name} \u2014 ${relatedModel.name} is not included.`
+          `Skipping relation "${relationName}" on ${model.name} \u2014 ${relatedModel.name} is not included.`
         );
         continue;
       }
@@ -285,7 +285,7 @@ var SchemaTransformer = class {
         case "manyToMany": {
           if (!relation.pivotTable || !relation.pivotForeignKey || !relation.pivotRelatedForeignKey) {
             throw new Error(
-              `lucid-zero: manyToMany relation "${relationName}" on ${model.name} \u2014 pivot table fields could not be resolved after boot().`
+              `manyToMany relation "${relationName}" on ${model.name} \u2014 pivot table fields could not be resolved after boot().`
             );
           }
           relationships[relationName] = {
@@ -310,7 +310,7 @@ var SchemaTransformer = class {
           const throughRel = relation;
           if (!throughRel.throughModel) {
             throw new Error(
-              `lucid-zero: hasManyThrough relation "${relationName}" on ${model.name} \u2014 throughModel could not be resolved after boot().`
+              `hasManyThrough relation "${relationName}" on ${model.name} \u2014 throughModel could not be resolved after boot().`
             );
           }
           const throughModel = throughRel.throughModel();
@@ -352,33 +352,47 @@ function tsTypeToZeroType(type) {
 import fs3 from "fs";
 
 // src/formatter.ts
-var Formatter = class _Formatter {
-  static async loadPrettier() {
-    let prettier;
-    try {
-      const { createRequire } = await import("module");
-      const req = createRequire(process.cwd() + "/package.json");
-      const prettierPath = req.resolve("prettier");
-      const { pathToFileURL } = await import("url");
-      prettier = await import(pathToFileURL(prettierPath).href);
-      return prettier;
-    } catch {
-      return null;
-    }
+import { spawnSync } from "child_process";
+import { createRequire } from "module";
+import path2 from "path";
+function resolveOxfmtBin() {
+  try {
+    const req = createRequire(process.cwd() + "/package.json");
+    const pkgMain = req.resolve("oxfmt");
+    const pkgRoot = path2.join(pkgMain, "..", "..");
+    return path2.join(pkgRoot, "bin", "oxfmt");
+  } catch {
+    return null;
   }
-  static async format(code) {
-    const prettier = await _Formatter.loadPrettier();
-    if (!prettier) {
-      console.warn("lucid-zero: prettier not found \u2014 skipping formatting");
+}
+var Formatter = class {
+  /**
+   * Formats `code` by piping it through the oxfmt CLI with `--stdin-filepath`
+   * set to the output file's absolute path. This lets oxfmt walk up the
+   * directory tree and discover `.oxfmtrc.json` / `oxfmt.config.ts` in the
+   * user's project.
+   */
+  static async format(code, outputFilePath) {
+    const bin = resolveOxfmtBin();
+    if (!bin) {
+      console.warn("lucid-zero: oxfmt not found \u2014 skipping formatting");
       return code;
     }
-    try {
-      const options = await prettier.resolveConfig(process.cwd());
-      return await prettier.format(code, { ...options, parser: "typescript" });
-    } catch {
-      console.warn("lucid-zero: prettier formatting failed \u2014 skipping");
+    const result = spawnSync(
+      process.execPath,
+      [bin, `--stdin-filepath=${outputFilePath}`],
+      {
+        input: code,
+        encoding: "utf8",
+        cwd: process.cwd()
+      }
+    );
+    if (result.status !== 0) {
+      console.warn(`lucid-zero: oxfmt formatting failed \u2014 skipping
+${result.stderr ?? ""}`);
       return code;
     }
+    return result.stdout;
   }
 };
 
@@ -395,7 +409,7 @@ var CodeGenerator = class {
   async generateToOutputFile() {
     let code = this.generate();
     if (this.config.formatOutputFile) {
-      code = await Formatter.format(code);
+      code = await Formatter.format(code, this.config.outputFilePath);
     }
     fs3.writeFileSync(this.config.outputFilePath, code);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antislop/zero-lucid-generator",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Generate Zero schemas from Lucid ORM models",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -19,13 +19,20 @@
     "check-types": "tsc --noEmit",
     "lint": "eslint src tests",
     "lint:fix": "eslint src tests --fix",
-    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\"",
-    "format:check": "prettier --check \"src/**/*.ts\" \"tests/**/*.ts\""
+    "format": "oxfmt \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "format:check": "oxfmt --check \"src/**/*.ts\" \"tests/**/*.ts\""
   },
   "bin": {
     "lucid-zero": "./dist/index.js"
   },
-  "keywords": ["zero", "lucid", "adonisjs", "schema", "generator", "rocicorp"],
+  "keywords": [
+    "zero",
+    "lucid",
+    "adonisjs",
+    "schema",
+    "generator",
+    "rocicorp"
+  ],
   "author": "antislop",
   "license": "ISC",
   "publishConfig": {
@@ -43,8 +50,7 @@
     "@typescript-eslint/parser": "^8.61.0",
     "@vitest/coverage-v8": "^4.1.8",
     "eslint": "^10.4.1",
-    "eslint-config-prettier": "^10.1.8",
-    "prettier": "^3.8.4",
+    "oxfmt": "^0.54.0",
     "tsup": "^8.5.1",
     "tsx": "^4.22.4",
     "typescript": "^6.0.3",