Add positional pattern support for gel generate queries #1308

nervetattoo · 2025-08-30T09:32:01Z

Add positional pattern support to gel generate queries

Summary

Enables selective query generation by accepting glob patterns as positional
arguments.
Due to the bump of es2015 module target to es2020 this probably warrants a major release.

Usage

bunx @gel/generate queries "**/*user*.edgeql"                    # glob patterns
bunx @gel/generate queries "src/queries/*.edgeql" "admin/*.edgeql"  # multiple patterns
bunx @gel/generate queries user-profile.edgeql                   # single files
bunx @gel/generate queries src/                                  # directories
(auto-expands)

Key Features

Pattern matching: Uses globby for efficient file selection
Schema protection: Automatically excludes dbschema/migrations/** and
dbschema/fixups/**
Smart normalization: Directories auto-expand to /**/*.edgeql globs
Context-aware: Patterns resolve relative to current working directory

Changes

Enhanced getMatches() with globby integration for pattern support
Added positional argument collection in CLI parser
Extended CommandOptions interface with patterns?: string[]
Moved globby to runtime dependencies
Added tsx as direct devDep to ensure future PM compatibility
Updated tsconfig for ES2020 dynamic imports

Testing

8 test cases covering pattern matching, schema exclusion, directory traversal,
absolute paths, and edge cases.

Backward Compatibility

✅ Fully backward compatible - no patterns defaults to existing behavior

- Implement CLI parsing to collect positional patterns before flags - Add patterns field to CommandOptions interface - Integrate globby for pattern matching in getMatches() - Add comprehensive test for pattern functionality - Fix TypeScript ESM config to support dynamic imports (es2015 -> es2020) Usage: gel generate queries 'pattern1' 'pattern2' --flags Example: gel generate queries 'src/**/*.edgeql' --target ts

gel-data-cla · 2025-08-30T09:32:05Z

All commit authors signed the Contributor License Agreement.

Copilot

Pull Request Overview

This PR adds support for glob pattern-based file selection in the EdgeDB query generator. It enables developers to selectively generate queries by specifying glob patterns as positional arguments, enhancing workflow efficiency for large projects.

Adds glob pattern support using globby library for selective query generation
Implements schema protection that automatically excludes migration and fixup files
Updates TypeScript module target from ES2015 to ES2020 for dynamic imports

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
packages/generate/tsconfig.esm.json	Updates module target to ES2020 to support dynamic imports
packages/generate/src/queries.ts	Adds pattern matching logic with globby integration and schema exclusion
packages/generate/src/commandutil.ts	Extends CommandOptions interface with patterns field
packages/generate/src/cli.ts	Implements positional argument parsing for pattern collection
packages/generate/package.json	Moves globby to runtime dependencies and adds tsx as dev dependency
packages/generate/test/cli.test.ts	Adds comprehensive test coverage for pattern matching functionality
docs/queries.rst	Updates documentation with pattern usage examples and features

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-02T20:10:52Z

packages/generate/src/queries.ts

+      if (!pattern.endsWith(".edgeql")) {
+        // Special case for current directory
+        if (pattern === ".") {
+          return "./**/*.edgeql";


The pattern ./**/*.edgeql may not behave consistently across different operating systems. Consider using **/*.edgeql instead for better cross-platform compatibility.

Suggested change

return "./**/*.edgeql";

return "**/*.edgeql";

I don't personally know a ton about path portability with globby, but if this is true, I 👍 this comment.

Per globby documentation this is the way to go for portability.

Note that glob patterns can only contain forward-slashes, not backward-slashes, so if you want to construct a glob pattern from path components, you need to use path.posix.join() instead of path.join().

I think the comment was about dropping the leading ./ right, not about the slashes?

packages/generate/test/cli.test.ts

nervetattoo · 2025-09-03T07:30:12Z

Points addressed

scotttrinh · 2025-09-03T20:17:15Z

FYI: Nightly failing due to change of scoping in nightly Gel server. See geldata/gel-go#391

packages/generate/src/queries.ts

…nore options - Replace manual pattern normalization with globby's expandDirectories option - Replace post-processing schema filtering with native ignore patterns - Reduces code complexity by ~25 lines while maintaining all functionality - Better performance for pattern cases through more targeted file traversal - All existing tests continue to pass

packages/generate/src/queries.ts

scotttrinh · 2025-09-08T12:56:59Z

packages/generate/src/queries.ts

+) {
+  if (patterns && patterns.length > 0) {
+    // Use globby to match files with the provided patterns
+    const { globby } = await import("globby");


Since this would not be conditional anymore, we can just move this into a normal import.

That requires setting type module because globby is pure esm. Happy to do that too, which shouldn't matter if this is just used as a bin exclusively.

ahh, ok, let's not bother doing that yet then: we can make that a separate effort to not hold this up longer than it needs to.

scotttrinh

Looks great, and thanks for all of the hard work getting this PR working! 🥇

scotttrinh · 2025-09-11T18:20:42Z

packages/generate/src/cli.ts

+    while (args.length && !args[0]!.startsWith("-")) {
+      positionalArgs.push(args.shift()!);
+    }


This breaks if you accidentally place an option between two positional args, right? Seems fine for now: we should upgrade to a more robust argument parser at some point, but wanted to make a note of it while I was re-reading.

See geldata/gel-js#1308

Add pattern support examples to queries generator docs

969f1a8

scotttrinh requested review from Copilot and scotttrinh September 2, 2025 20:09

Copilot AI reviewed Sep 2, 2025

View reviewed changes

Replace local require calls in tests with top level imports

6e45564

Format code with format:fix

2f49353

scotttrinh reviewed Sep 3, 2025

View reviewed changes

packages/generate/src/queries.ts Outdated Show resolved Hide resolved

packages/generate/src/queries.ts Outdated Show resolved Hide resolved

scotttrinh requested changes Sep 8, 2025

View reviewed changes

nervetattoo added 2 commits September 11, 2025 09:35

Remove redundant ../.. traversal test and unused schemaDir param

448eea8

Prettier

f0082c4

scotttrinh approved these changes Sep 11, 2025

View reviewed changes

scotttrinh merged commit 3e663ba into geldata:master Sep 11, 2025
8 of 9 checks passed

scotttrinh added a commit to geldata/gel that referenced this pull request Sep 11, 2025

Add documentation for new queries patterns

9e90ba3

See geldata/gel-js#1308

scotttrinh mentioned this pull request Sep 11, 2025

Add documentation for new queries patterns geldata/gel#9017

Open

Add positional pattern support for gel generate queries #1308

Add positional pattern support for gel generate queries #1308

Uh oh!

Conversation

nervetattoo commented Aug 30, 2025

Add positional pattern support to gel generate queries

Summary

Usage

Key Features

Changes

Testing

Backward Compatibility

Uh oh!

gel-data-cla bot commented Aug 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

scotttrinh Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

nervetattoo Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

scotttrinh Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nervetattoo commented Sep 3, 2025

Uh oh!

scotttrinh commented Sep 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

scotttrinh Sep 8, 2025

Choose a reason for hiding this comment

Uh oh!

nervetattoo Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

scotttrinh Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

scotttrinh left a comment

Choose a reason for hiding this comment

Uh oh!

scotttrinh Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

gel-data-cla bot commented Aug 30, 2025 •

edited

Loading