This package enables seamless integration of Componego Framework with Urfave CLI V2.
It supports all features of the Urfave CLI, offering a convenient solution for processing command-line arguments within the Componego Framework.
An application must be launched in a specific way for this functionality to work:
package main
import (
"github.com/componego/componego"
"github.com/componego/urfave-cli-integration"
"github.com/YOUR-USER-OR-ORG-NAME/YOUR-REPO-NAME/internal/application"
)
func main() {
urfave_cli_integration.RunAndExit(application.New(), componego.ProductionMode)
}This is necessary because the current integration may launch different Componego applications depending on the command-line arguments.
You can access the Urfave CLI context and modify any command options within the application. For example, you can add a couple of required flags for the command line:
package application
import (
"github.com/componego/componego"
"github.com/componego/urfave-cli-integration"
"github.com/urfave/cli/v2"
)
type Application struct {
}
func New() *Application {
return &Application{}
}
// ApplicationName belongs to interface componego.Application.
func (a *Application) ApplicationName() string {
return "Application Name v0.0.1"
}
// ApplicationCLI belongs to interface urfave_cli_integration.ApplicationCLI.
func (a *Application) ApplicationCLI(cmd *cli.Command) {
cmd.Flags = []cli.Flag{
&cli.StringFlag{
Name: "config",
Usage: "config filename",
Required: true,
},
}
// ...
}
// ApplicationConfigInit belongs to interface componego.ApplicationConfigInit.
func (a *Application) ApplicationConfigInit(_ componego.ApplicationMode, options any) (map[string]any, error) {
cliCtx := options.(*cli.Context) // <----
// ...
}
// ApplicationAction belongs to interface componego.Application.
func (a *Application) ApplicationAction(env componego.Environment, options any) (int, error) {
cliCtx := options.(*cli.Context) // <----
// ...
}
var (
_ componego.Application = (*Application)(nil)
_ componego.ApplicationConfigInit = (*Application)(nil)
_ urfave_cli_integration.ApplicationCLI = (*Application)(nil)
)Subcommands can be added as follows:
// ApplicationCLI belongs to interface urfave_cli_integration.ApplicationCLI.
func (a *Application) ApplicationCLI(cmd *cli.Command) {
cmd.Subcommands = []*cli.Command{
urfave_cli_integration.ToCommand("subcommand", application.New()),
}
// ....
}Examples are available here.
We are open to improvements and suggestions. Pull requests are welcome.
The source code of the repository is licensed under the MIT license.