Make generated output files optional by GeertJohan · Pull Request #46 · printeers/trek

GeertJohan · 2026-01-15T08:20:03Z

Fixes #37

GeertJohan · 2026-01-15T08:30:13Z

example/migrations/001_init.up.sql

@@ -1,10 +0,0 @@
-- ** Database generated with pgModeler (PostgreSQL Database Modeler).


The file still exists but its empty because there are no diffs.

Copilot

Pull request overview

This PR makes generated output files (SQL, PNG, SVG) optional and configurable through the trek.yaml configuration file, addressing issue #37. When output types are defined in the config, files are generated at customizable or default paths. The initial migration logic has also been updated to generate diffs instead of directly copying SQL files.

Changes:

Added output configuration section to control which file types (SQL, PNG, SVG) are generated
Refactored SQL export to use a temporary directory, only copying to output path if enabled
Added SVG export capability and made PNG export conditional

Reviewed changes

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

Show a summary per file

File	Description
`internal/configuration/config.go`	Added `Output`, `OutputFile` types and `GetOutputPath()` method to support optional output files
`internal/templates/trek.yaml.tmpl`	Updated template to include empty `output` section for SQL and SVG by default
`internal/pgmodeler.go`	Renamed functions (consistent casing) and added `PgmodelerExportSVG()` function
`cmd/generate.go`	Modified generation logic to conditionally create output files and use temp directory for SQL
`tests/output/trek.yaml`, `example/trek.yaml`	Added `output` configuration sections
`tests/output/.gen.{sql,svg}`, `example/.gen.{sql,svg}`	New generated output files
`tests/output/migrations/001_init.up.sql`, `example/migrations/001_init.up.sql`	Updated migration files with different content structure

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

cmd/generate.go

internal/configuration/config.go

Copilot

Pull request overview

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

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

cmd/generate.go

internal/configuration/config.go

Copilot

Pull request overview

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

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-15T09:46:21Z

internal/templates/trek.yaml.tmpl

  - name: {{.}}{{end}}
+output:
+  sql: {}
+  svg: {}


The trek.yaml template now includes output configuration for sql and svg but not png. Consider documenting this behavior or adding a comment in the template to explain that png can also be configured if needed. This would help users understand all available output options.

Suggested change

svg: {}

svg: {}

# Note: PNG output can also be configured here if needed, for example:

# png: {}

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot

Pull request overview

Copilot reviewed 8 out of 14 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

cmd/generate.go

provokateurin · 2026-01-17T07:37:41Z

cmd/generate.go

+		sqlContent, err = os.ReadFile(tmpSQLPath)
+		if err != nil {
+			return "", fmt.Errorf("failed to read sql file: %w", err)
+		}
+		err = os.WriteFile(filepath.Join(wd, sqlPath), sqlContent, 0o644) //nolint:gosec


Why not copy the file without read/write?

How? There is no os.Copy right?

io.Copy, but I guess in doesn't really matter given the amount of data we're handling here.

provokateurin · 2026-01-17T07:39:17Z

example/trek.yaml

+  sql: {}
+  svg: {}


For the example it would be nice to have one with an explicit path.

I thought about that, but the example is generated via trek init which doesn't have env vars to set these.. I don't think adding env vars there makes sense. I think instead we should improve documentation in general. And/or maybe the example dir shouldn't be generated?

Yeah maybe get rid of the example, since it's empty anyway it doesn't have that much value and it isn't even useful as a starting point, since we have trek init.

Lets pick that up in a separate story/PR; to improve docs in general.

provokateurin

Please regenerate the tests

GeertJohan · 2026-01-17T12:09:34Z

Rebased. Also re-ran tests but it didn't make any changes.

provokateurin · 2026-01-17T12:16:23Z

Also re-ran tests but it didn't make any changes.

Shouldn't the config file change after?

GeertJohan · 2026-01-17T12:21:14Z

The config file already has the new outputs right?

GeertJohan force-pushed the configurable-output-files branch 2 times, most recently from 7f0f622 to f0f8faa Compare January 15, 2026 08:29

GeertJohan commented Jan 15, 2026

View reviewed changes

GeertJohan requested review from Copilot and provokateurin and removed request for Copilot January 15, 2026 08:30

Copilot started reviewing on behalf of GeertJohan January 15, 2026 08:30 View session

Copilot AI reviewed Jan 15, 2026

View reviewed changes

cmd/generate.go Show resolved Hide resolved

cmd/generate.go Outdated Show resolved Hide resolved

internal/configuration/config.go Outdated Show resolved Hide resolved

GeertJohan force-pushed the configurable-output-files branch from f0f8faa to 6b4904e Compare January 15, 2026 08:45

GeertJohan requested a review from Copilot January 15, 2026 08:54

Copilot started reviewing on behalf of GeertJohan January 15, 2026 08:55 View session

Copilot AI reviewed Jan 15, 2026

View reviewed changes

cmd/generate.go Show resolved Hide resolved

cmd/generate.go Show resolved Hide resolved

internal/configuration/config.go Show resolved Hide resolved

GeertJohan force-pushed the configurable-output-files branch from 6b4904e to eaa31b8 Compare January 15, 2026 09:33

GeertJohan requested a review from Copilot January 15, 2026 09:41

Copilot started reviewing on behalf of GeertJohan January 15, 2026 09:41 View session

Copilot AI reviewed Jan 15, 2026

View reviewed changes

GeertJohan requested a review from Copilot January 15, 2026 09:58

Copilot started reviewing on behalf of GeertJohan January 15, 2026 09:58 View session

Copilot AI reviewed Jan 15, 2026

View reviewed changes

cmd/generate.go Show resolved Hide resolved

cmd/generate.go Show resolved Hide resolved

provokateurin reviewed Jan 17, 2026

View reviewed changes

provokateurin requested changes Jan 17, 2026

View reviewed changes

Make generated output files optional

98fc879

GeertJohan force-pushed the configurable-output-files branch from eaa31b8 to 98fc879 Compare January 17, 2026 12:09

GeertJohan merged commit 3deb338 into main Jan 17, 2026
2 checks passed

GeertJohan deleted the configurable-output-files branch January 17, 2026 12:23

		@@ -1,10 +0,0 @@
		-- ** Database generated with pgModeler (PostgreSQL Database Modeler).

-  svg: {}
+  svg: {}
+  # Note: PNG output can also be configured here if needed, for example:
+  # png: {}

Conversation

GeertJohan commented Jan 15, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

provokateurin left a comment

Choose a reason for hiding this comment

Uh oh!

GeertJohan commented Jan 17, 2026

Uh oh!

provokateurin commented Jan 17, 2026

Uh oh!

GeertJohan commented Jan 17, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants