feat(modfile): add run directive support for custom project runners #125

joeykchen · 2025-12-18T09:55:16Z

Add support for 'run' directive in gop.mod/gox.mod files that allows specifying a custom runner command for projects. This enables projects like SPX to define their own run command:

run github.com/goplus/spx/v2/cmd/spxrun

Changes:

Add Run struct type to hold the custom runner package path
Add Run field to File struct
Add parsing logic for 'run' directive in parseVerb function

Add support for 'run' directive in gop.mod/gox.mod files that allows specifying a custom runner command for projects. This enables projects like SPX to define their own run command: run github.com/goplus/spx/v2/cmd/spxrun Changes: - Add Run struct type to hold the custom runner package path - Add Run field to File struct - Add parsing logic for 'run' directive in parseVerb function

gemini-code-assist · 2025-12-18T09:55:30Z

Summary of Changes

Hello @joeykchen, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the module file parsing by adding a new 'run' directive. This directive allows projects to define and utilize custom commands for execution, providing greater flexibility in how projects are run. The change involves updating the core data structures to accommodate this new configuration and implementing the necessary parsing logic to interpret the directive correctly.

Highlights

New 'run' directive: Introduces support for a 'run' directive in gop.mod/gox.mod files, allowing projects to specify custom runner commands.
Run struct definition: Adds a new 'Run' struct type to hold the custom runner package path and its associated syntax information.
File struct update: The 'File' struct now includes a 'Run' field to store the custom runner configuration for a module.
Parsing logic: Implements parsing and validation logic for the 'run' directive within the 'parseVerb' function, ensuring correct usage and handling of the custom runner command.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

codecov · 2025-12-18T09:56:24Z

Codecov Report

❌ Patch coverage is 0% with 12 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.60%. Comparing base (68cd1cc) to head (1252552).

Files with missing lines	Patch %	Lines
modfile/rule.go	0.00%	12 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #125      +/-   ##
==========================================
- Coverage   93.37%   91.60%   -1.77%     
==========================================
  Files           6        6              
  Lines         679      691      +12     
==========================================
- Hits          634      633       -1     
- Misses         27       40      +13     
  Partials       18       18

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

gemini-code-assist

Code Review

This pull request introduces a run directive to gop.mod/gox.mod files, allowing projects to specify a custom runner. The implementation is solid, adding a new Run struct, updating the File struct, and including parsing logic in parseVerb. My main feedback is to rename the Cmd field in the Run struct to Path for better consistency and clarity, as it stores a package path, not an executable command string.

gemini-code-assist · 2025-12-18T09:56:29Z

modfile/rule.go

+// A Run is the run statement that specifies a custom runner for the project.
+// Example: run github.com/goplus/spx/v2/cmd/spxrun
+type Run struct {
+	Cmd    string // the command package path to run the project


For consistency with other structs in this file like Import that use Path for package paths, and to more accurately reflect that this field holds a package path rather than a command string, consider renaming Cmd to Path. This would improve code clarity and maintainability.

Suggested change

Cmd string // the command package path to run the project

Path string // the package path of the custom runner command

gemini-code-assist · 2025-12-18T09:56:29Z

modfile/rule.go

+			wrapError(err)
+			return
+		}
+		f.Run = &Run{Cmd: cmdPath, Syntax: line}


To align with the suggested change of renaming Run.Cmd to Run.Path, this field initialization should be updated accordingly.

Suggested change

f.Run = &Run{Cmd: cmdPath, Syntax: line}

f.Run = &Run{Path: cmdPath, Syntax: line}

xgopilot · 2025-12-18T09:58:33Z

modfile/rule.go

 }

+// A Run is the run statement that specifies a custom runner for the project.
+// Example: run github.com/goplus/spx/v2/cmd/spxrun


Documentation Issue: The example comment appears to have a formatting error. It should use // for the comment prefix to be consistent with Go documentation standards.

Suggested change

// Example: run github.com/goplus/spx/v2/cmd/spxrun

// A Run is the run statement that specifies a custom runner for the project.

// Example: run github.com/goplus/spx/v2/cmd/spxrun

xgopilot · 2025-12-18T09:58:35Z

modfile/rule.go

+// A Run is the run statement that specifies a custom runner for the project.
+// Example: run github.com/goplus/spx/v2/cmd/spxrun
+type Run struct {
+	Cmd    string // the command package path to run the project


Clarity Improvement: The term "command package path" could be clearer. Consider specifying that this is a Go package import path.

Suggested change

Cmd string // the command package path to run the project

Cmd string // Go package import path of the custom runner command

xgopilot · 2025-12-18T09:58:37Z

modfile/rule.go

 	XGo       *XGo
 	Compiler  *Compiler // the underlying go compiler in go.mod (not gox.mod)
 	Projects  []*Project
+	Run       *Run     // custom runner command


Optional - Field Ordering: Consider grouping file-level configuration directives (XGo, Compiler, Run) together, separate from collection fields (Projects, ClassMods). This would improve logical organization:

Suggested change

Run *Run // custom runner command

Run *Run // custom runner for executing the project (from run directive)

And move it to line 45 (after Compiler, before Projects).

xgopilot · 2025-12-18T09:58:39Z

modfile/rule.go

+			return
+		}
+		if len(args) != 1 {
+			errorf("usage: run cmdPkgPath")


Minor - Error Message: Consider making the usage message clearer by showing a concrete example format:

Suggested change

errorf("usage: run cmdPkgPath")

errorf("usage: run <package-import-path>")

Or: "usage: run github.com/org/project/cmd/runner"

xgopilot · 2025-12-18T09:58:50Z

Review Summary

Solid implementation that follows existing codebase patterns well. The run directive integrates cleanly with proper validation and error handling.

Key findings:

✅ Performance: Efficient with minimal allocations
✅ Security: Appropriate for build config files
⚠️ Documentation: Minor clarity improvements suggested
⚠️ Testing: No test coverage for new directive

Main action item: Fix comment formatting on line 36. Consider adding test cases following patterns in gop_test.go.

gemini-code-assist bot reviewed Dec 18, 2025

View reviewed changes

xgopilot bot reviewed Dec 18, 2025

View reviewed changes

This was referenced Dec 18, 2025

Feat: Run the project directly on PC using xgo run . goplus/spx#1072

Open

For Xgo Run goplus/spx#1082

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(modfile): add run directive support for custom project runners #125

feat(modfile): add run directive support for custom project runners #125

joeykchen commented Dec 18, 2025

Uh oh!

gemini-code-assist bot commented Dec 18, 2025

Uh oh!

codecov bot commented Dec 18, 2025

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Dec 18, 2025

Uh oh!

gemini-code-assist bot Dec 18, 2025

Uh oh!

xgopilot bot Dec 18, 2025

Uh oh!

xgopilot bot Dec 18, 2025

Uh oh!

xgopilot bot Dec 18, 2025

Uh oh!

xgopilot bot Dec 18, 2025

Uh oh!

xgopilot bot commented Dec 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	Cmd string // the command package path to run the project
	Path string // the package path of the custom runner command

	f.Run = &Run{Cmd: cmdPath, Syntax: line}
	f.Run = &Run{Path: cmdPath, Syntax: line}

	// Example: run github.com/goplus/spx/v2/cmd/spxrun
	// A Run is the run statement that specifies a custom runner for the project.
	// Example: run github.com/goplus/spx/v2/cmd/spxrun

	Cmd string // the command package path to run the project
	Cmd string // Go package import path of the custom runner command

	Run *Run // custom runner command
	Run *Run // custom runner for executing the project (from run directive)

	errorf("usage: run cmdPkgPath")
	errorf("usage: run <package-import-path>")

feat(modfile): add run directive support for custom project runners #125

Are you sure you want to change the base?

feat(modfile): add run directive support for custom project runners #125

Conversation

joeykchen commented Dec 18, 2025

Uh oh!

gemini-code-assist bot commented Dec 18, 2025

Summary of Changes

Highlights

Footnotes

Uh oh!

codecov bot commented Dec 18, 2025

Codecov Report

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

xgopilot bot Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

xgopilot bot Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

xgopilot bot Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

xgopilot bot Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

xgopilot bot commented Dec 18, 2025

Review Summary

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant