Allow programmatic access to queries generator (#706)

edgedb · Aug 1, 2023 · 2b09ed0 · 2b09ed0
1 parent b804348
commit 2b09ed0
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 20 deletions.
diff --git a/packages/generate/src/commandutil.ts b/packages/generate/src/commandutil.ts
@@ -75,7 +75,3 @@ export function readPasswordFromStdin() {
     adapter.process.stdin.on("end", () => resolve(data.trimEnd()));
   });
 }
-
-export function getPackageVersion(): string {
-  return "__@edgedb/generate__VERSION_PLACEHOLDER__";
-}
diff --git a/packages/generate/src/edgeql-js.ts b/packages/generate/src/edgeql-js.ts
@@ -1,12 +1,8 @@
 // tslint:disable:no-console
 
 import { $, adapter, type Client } from "edgedb";
-import {
-  type CommandOptions,
-  getPackageVersion,
-  isTTY,
-  promptBoolean,
-} from "./commandutil";
+import { type CommandOptions, isTTY, promptBoolean } from "./commandutil";
+import { headerComment } from "./genutil";
 import { DirBuilder } from "./builders";
 import { syntax } from "./FILES";
 
@@ -22,8 +18,6 @@ import { generateSetImpl } from "./edgeql-js/generateSetImpl";
 
 const { path, fs, readFileUtf8, exists, walk } = adapter;
 
-const headerComment = `// GENERATED by @edgedb/generate v${getPackageVersion()}\n\n`;
-
 // tslint:disable-next-line
 export const configFileHeader = `// EdgeDB query builder`;
 

diff --git a/packages/generate/src/genutil.ts b/packages/generate/src/genutil.ts
@@ -13,6 +13,10 @@ import { adapter } from "edgedb";
 
 export const splitName = util.splitName;
 
+const PACKAGE_VERSION_TEMPLATE = "__@edgedb/generate__VERSION_PLACEHOLDER__";
+
+export const headerComment = `// GENERATED by @edgedb/generate v${PACKAGE_VERSION_TEMPLATE}\n\n`;
+
 export function toIdent(name: string): string {
   if (name.includes("::")) {
     throw new Error(`toIdent: invalid name ${name}`);

diff --git a/packages/generate/src/interfaces.ts b/packages/generate/src/interfaces.ts
@@ -1,5 +1,6 @@
 // tslint:disable:no-console
-import { CommandOptions, getPackageVersion } from "./commandutil";
+import type { CommandOptions } from "./commandutil";
+import { headerComment } from "./genutil";
 import { $, adapter, type Client } from "edgedb";
 import { DirBuilder } from "./builders";
 
@@ -57,7 +58,7 @@ export async function runInterfacesGenerator(params: {
 
   const file = dir.getPath("interfaces");
   const rendered =
-    `// GENERATED by @edgedb/generate v${getPackageVersion()}\n\n` +
+    headerComment +
     file.render({
       mode: "ts",
       moduleKind: "esm",

diff --git a/packages/generate/src/queries.ts b/packages/generate/src/queries.ts
@@ -1,6 +1,7 @@
 import { $, adapter, type Client } from "edgedb";
 import { Cardinality } from "edgedb/dist/ifaces";
-import { type CommandOptions, getPackageVersion } from "./commandutil";
+import { type CommandOptions } from "./commandutil";
+import { headerComment } from "./genutil";
 import type { Target } from "./genutil";
 
 // generate per-file queries
@@ -103,7 +104,7 @@ currently supported.`);
         console.log(`   ${prettyPath}`);
         await adapter.fs.writeFile(
           filePath,
-          `// GENERATED by @edgedb/generate v${getPackageVersion()}\n\n` +
+          headerComment +
             `${stringifyImports(file.imports)}\n\n${file.contents}`
         );
       }
@@ -126,8 +127,7 @@ currently supported.`);
         console.log(`   ${prettyPath}`);
         await adapter.fs.writeFile(
           f.path,
-          `// GENERATED by @edgedb/generate v${getPackageVersion()}\n\n` +
-            `${stringifyImports(f.imports)}\n\n${f.contents}`
+          headerComment + `${stringifyImports(f.imports)}\n\n${f.contents}`
         );
       }
     } catch (err) {
@@ -148,7 +148,7 @@ currently supported.`);
   //   generate output file
 }
 
-function stringifyImports(imports: { [k: string]: boolean }) {
+export function stringifyImports(imports: { [k: string]: boolean }) {
   if (Object.keys(imports).length === 0) return "";
   return `import type {${Object.keys(imports).join(", ")}} from "edgedb";`;
 }
@@ -170,7 +170,7 @@ async function getMatches(root: string) {
 
 type QueryType = Awaited<ReturnType<(typeof $)["analyzeQuery"]>>;
 
-function generateFiles(params: {
+export function generateFiles(params: {
   target: Target;
   path: string;
   types: QueryType;