Export main function

[adbjo]

allows creating custom goose binary without replicating CLI logic

[mfridman]

This is typically not exported, and I'm not sure I want to allow a dependency on the CLI code. Note, there will be some changes to this coming very soon: #663

I'm curious, what are you trying to do where the goose package isn't sufficient?

[adbjo]

hello there!

We want to embed go migrations in the goose binary.
Currently, this is done by implementing a custom CLI interface alongside the migrations, which is a bit annoying.

The laziest way to do it was to simply export the main function, so that is what I did. There are probably better ways to achieve this. The issue you linked looks promising :)

It would be really nice with a GooseCLI function or something that accepted configuration as input.

[mfridman]

Ah, okay I think I understand. You want to use Go migrations but also leverage the default CLI behaviour from goose without re-implementing flags/args logic within your binary code.

I'll need to think about this. The goose.Run set of commands were meant to bridge this gap, although there's still all the configuration, flags and env bits you need to glue together.

Need to think about this, because anything that becomes part of the public API surface we try very hard to keep backwards-compatible. Most CLIs keep this in ./internal/cli since it's only ever used as an executable, but this is a bit of a special case because of the intersection of Go migrations + CLI functionality.

[mfridman]

Okay, I've come around on this. I think there's some benefit to making the CLI bits available to users.

I don't want to expose main.go, but instead will isolate the CLI bits into a separate package cli, which will have the following 2 exported functions:

func Main() {

}

# and

func Run(ctx context.Context, args []string, opts ...RunOptions) error {

}

Which will enable you to call cli.Main() or cli.Run(context.Background(), os.Args[1:]) in your applications. There are a few options that can modify the underlying state. This will also make it easier to test the goose CLI without having to compile it.