Add positional pattern support for gel generate queries (#1308)

Enables selective query generation by accepting glob patterns as
positional arguments.

Author: nervetattoo

docs/queries.rst

@@ -48,24 +48,33 @@ Consider the following file tree.
       └── getUser.edgeql
 
 
-The following command will run the ``queries`` generator.
+The following command will run the ``queries`` generator on all ``.edgeql`` files in your project.
 
 .. tabs::
 
   .. code-tab:: bash
     :caption: Node.js
 
     $ npx @edgedb/generate queries
+    
+    # Or process specific files with patterns:
+    $ npx @edgedb/generate queries "queries/*.edgeql"
 
   .. code-tab:: bash
     :caption: Deno
 
     $ deno run --allow-all --unstable https://deno.land/x/edgedb/generate.ts queries
+    
+    # Or with patterns:
+    $ deno run --allow-all --unstable https://deno.land/x/edgedb/generate.ts queries "queries/*.edgeql"
 
   .. code-tab:: bash
     :caption: Bun
 
     $ bunx @edgedb/generate queries
+    
+    # Or with patterns:
+    $ bunx @edgedb/generate queries "queries/*.edgeql"
 
 .. note:: Deno users
 
@@ -182,6 +191,45 @@ We can now use this function in our code.
    Generators work by connecting to the database to get information about the current state of the schema. Make sure you run the generators again any time the schema changes so that the generated code is in-sync with the current state of the schema.
 
 
+File Pattern Selection
+----------------------
+
+By default, the generator scans your entire project for ``*.edgeql`` files. You can specify which files to process using glob patterns as positional arguments.
+
+.. code-block:: bash
+
+  # Process specific files
+  $ npx @edgedb/generate queries "getUser.edgeql" "admin/permissions.edgeql"
+  
+  # Use glob patterns
+  $ npx @edgedb/generate queries "src/**/*user*.edgeql"
+  
+  # Process entire directories
+  $ npx @edgedb/generate queries "queries/" "admin/"
+
+**Pattern Features:**
+
+- **Glob support**: Use ``*``, ``**``, and ``?`` wildcards for flexible matching
+- **Directory expansion**: Bare directory names automatically expand to ``directory/**/*.edgeql``
+- **Schema protection**: Migration and fixup files in ``dbschema/`` are automatically excluded
+- **Multiple patterns**: Specify multiple patterns to process files from different locations
+
+**Examples:**
+
+.. code-block:: bash
+
+  # Process only user-related queries
+  $ npx @edgedb/generate queries "**/*user*.edgeql"
+  
+  # Process queries from specific modules
+  $ npx @edgedb/generate queries "src/queries/" "admin/queries/"
+  
+  # Process a single file
+  $ npx @edgedb/generate queries "scripts/migration-helper.edgeql"
+
+Patterns are resolved relative to your current working directory and will automatically exclude schema management files to prevent accidentally processing migrations.
+
+
 Single-file mode
 ----------------
 
@@ -205,6 +253,9 @@ The following command will run the generator in ``--file`` mode.
 .. code-block:: bash
 
   $ npx @edgedb/generate queries --file
+  
+  # Or generate single file from specific patterns:
+  $ npx @edgedb/generate queries --file "src/queries/*.edgeql" "admin/*.edgeql"
 
 A single file will be generated that exports two functions, ``getUser`` and ``getMovies``. By default this file is generated into the ``dbschema`` directory.
 

packages/generate/package.json

@@ -27,14 +27,15 @@
     "conditional-type-checks": "^1.0.6",
     "esbuild": "^0.21.4",
     "gel": "^2.1.1",
-    "globby": "^14.0.1",
     "jest": "^29.7.0",
     "ts-jest": "^29.1.4",
+    "tsx": "^4.11.0",
     "typescript": "^5.5.2"
   },
   "dependencies": {
     "@iarna/toml": "^2.2.5",
-    "debug": "^4.3.4"
+    "debug": "^4.3.4",
+    "globby": "^14.0.1"
   },
   "scripts": {
     "typecheck": "tsc --project tsconfig.build.json --noEmit",

packages/generate/src/cli.ts

@@ -105,6 +105,17 @@ const run = async () => {
     currentDir = path.join(currentDir, "..");
   }
 
+  // Collect positional arguments (patterns) for queries generator
+  const positionalArgs: string[] = [];
+  if (generator === Generator.Queries) {
+    while (args.length && !args[0]!.startsWith("-")) {
+      positionalArgs.push(args.shift()!);
+    }
+    if (positionalArgs.length > 0) {
+      options.patterns = positionalArgs;
+    }
+  }
+
   while (args.length) {
     let flag = args.shift()!;
     let val: string | null = null;

packages/generate/src/commandutil.ts

@@ -17,6 +17,7 @@ export interface CommandOptions {
   updateIgnoreFile?: boolean;
   useHttpClient?: boolean;
   future?: Partial<Record<keyof typeof defaultFutureFlags, boolean>>;
+  patterns?: string[];
 }
 
 const { input } = systemUtils;

packages/generate/src/queries.ts

@@ -5,7 +5,7 @@ import { type CommandOptions } from "./commandutil";
 import { headerComment } from "./genutil";
 import type { Target } from "./genutil";
 
-const { walk, readFileUtf8 } = systemUtils;
+const { readFileUtf8 } = systemUtils;
 
 // generate per-file queries
 // generate queries in a single file
@@ -40,9 +40,12 @@ currently supported.`);
   // generate one query per file
 
   console.log(`Detected schema directory: ${params.schemaDir}`);
-  const matches = await getMatches(root, params.schemaDir);
+  const matches = await getMatches(root, params.options.patterns);
   if (matches.length === 0) {
-    console.log(`No .edgeql files found outside of ${params.schemaDir}`);
+    const patternMsg = params.options.patterns?.length
+      ? ` matching patterns: ${params.options.patterns.join(", ")}`
+      : ` outside of ${params.schemaDir}`;
+    console.log(`No .edgeql files found${patternMsg}`);
     return;
   }
 
@@ -158,15 +161,23 @@ export function stringifyImports(imports: ImportMap) {
     .join("\n");
 }
 
-async function getMatches(root: string, schemaDir: string) {
-  return walk(root, {
-    match: [/[^/]\.edgeql$/],
-    skip: [
-      /node_modules/,
-      RegExp(`${schemaDir}\\${path.sep}migrations`),
-      RegExp(`${schemaDir}\\${path.sep}fixups`),
-    ],
+async function getMatches(root: string, patterns?: string[]) {
+  // Single code path using globby for both cases
+  const { globby } = await import("globby");
+
+  const searchPatterns = patterns && patterns.length > 0 ? patterns : ["."];
+
+  const allFiles = await globby(searchPatterns, {
+    cwd: root,
+    absolute: true,
+    onlyFiles: true,
+    expandDirectories: {
+      extensions: ["edgeql"],
+    },
+    ignore: ["node_modules/**", `**/migrations/**`, `**/fixups/**`],
   });
+
+  return allFiles;
 }
 
 // const targetToExtension: {[k in Target]: string} = {