stdfx

func AutoRegister ¶

func AutoRegister(f any) any

AutoRegister annotates a *cobra.Command constructor f to be automatically registered as a sub command in NewRootCommand. Usage example:

fx.Provide(
	stdfx.AutoRegister(firstCommandConstructor),
	stdfx.AutoRegister(secondCommandConstructor),
	stdfx.AutoCommand,
),
fx.Invoke(stdfx.Commander),

func Commander ¶

func Commander(
	lc fx.Lifecycle,
	shutdowner fx.Shutdowner,
	cmd *cobra.Command,
)

Commander can be used as a *cobra.Command invoker for fx. It will start cmd with Context.Background() in a goroutine. It is typically used as last Invoke option in an fx.App to actually start the application using a previously provided root *cobra.Command. The started *cobra.Command shall use cmd.Context() to watch for Done(). The ctx of cmd.Context() will be cancelled when it is time to shutdown. Failure to track cmd.Context() will kill your application after fx.DefaultTimeout - 15 seconds. fx.Lifecycle and fx.Shutdowner are injected into cmd.Context() and can be retrieved by calling [ExtractFromContext].

func ConfigCommand ¶

func ConfigCommand[T any](
	log *slog.Logger,
	configProvider configfx.Provider[T],
) *cobra.Command

ConfigCommand is a *cobra.Command constructor to print, modify and validate config.

func ConfigFile ¶

func ConfigFile[T any](
	configName string,
) func(log *slog.Logger) configfx.Provider[T]

ConfigFile provides your fx.App with a ConfigProvider[T] constructor. The provider - when being constructed - can be used to search for, read and unmarshal your config file to a struct of type *T or error. [configName] shall be the name of a config file without extension. Internally this curries both functions [config.NewSourceFile] and [config.NewProvider] for syntactic sugar. Usage example:

fx.Provide(stdfx.Config[mypkg.ConfStruct]("configname")),

After providing as described above, you will be able to request this provider to fetch the actual config *struct like this:

func buildCommand(
	provider stdfx.ConfigProvider[mypkg.ConfStruct],
) *cobra.Command {
	// fetch the config of type *mypkg.ConfStruct
	cfg, err := provider.Config()
	if err != nil {
		// ...
	}
	// do something using cfg (construct a *cobra.Command for example)
}

func ContainerEntrypoint ¶ added in v0.1.8

func ContainerEntrypoint(tools ...string) func()

ContainerEntrypoint might be used with fx.Invoke and tooling when the calling go program is packaged into a container where it is used as the entrypoint. This will execute any value of `tools` when given as the first argument and if found in $PATH. If tools is empty it will use a default list: ContainerEntrypointDefaultTools. A special value of '*' allows for any tool. There is extra handling when the first argument is the binary name itself: For such cases that argument is silbently shifted out and execution continues.

Example usage:

• fx.Invoke(stdfx.ContainerEntrypoint())
• fx.Invoke(stdfx.ContainerEntrypoint("sh", "bash", "whoami"))
• fx.Invoke(stdfx.ContainerEntrypoint("*"))

Resulting container image invocations:

• docker run --rm -it ghcr.io/choopm/myproject:latest sh -c 'echo hello world'
• docker run --rm -it ghcr.io/choopm/myproject:latest bash -i
• docker run --rm -it ghcr.io/choopm/myproject:latest whoami
• docker run --rm -it ghcr.io/choopm/myproject:latest myproject -c ...

func Shutdown ¶

func Shutdown(ctx context.Context, exitCode int) error

Shutdown uses fx.Shutdowner from ctx to shutdown a fx.App using exitCode. This works when Commander was used to start it. You can use this to shutdown an application unaware of fx during runtime. It might return ErrContextMissingShutdowner in which case it is up to you to directly call os.Exit or panic.

func Unprivileged ¶

func Unprivileged() error

Unprivileged returns an error if being run as root. This takes effect whenever the real or effective user id of the current user process is 0.

func UnprivilegedWarn ¶

func UnprivilegedWarn(log *slog.Logger)

UnprivilegedWarn warns if being run as root. This takes effect whenever the real or effective user id of the current user process is 0.

func VersionCommand ¶

func VersionCommand(version string) func(log *slog.Logger) *cobra.Command

VersionCommand a version *cobra.Command constructor to print version information. Supply your build tag as version and it will add runtime and compiler details.