diff --git a/.gitignore b/.gitignore index d9a8e3c..809bc3c 100644 --- a/.gitignore +++ b/.gitignore @@ -17,3 +17,5 @@ bin/ # Added by goreleaser init: dist/ + +.envrc \ No newline at end of file diff --git a/cmd/vbantxt/main.go b/cmd/vbantxt/main.go index 1ac09fa..f39cbee 100644 --- a/cmd/vbantxt/main.go +++ b/cmd/vbantxt/main.go @@ -1,108 +1,106 @@ +// Package main implements a command-line tool for sending text messages over VBAN using the vbantxt library. package main import ( - "flag" + "errors" "fmt" "os" "path/filepath" + "runtime/debug" + "strings" "time" + "github.com/charmbracelet/log" "github.com/onyx-and-iris/vbantxt" - log "github.com/sirupsen/logrus" + "github.com/peterbourgon/ff/v4" + "github.com/peterbourgon/ff/v4/ffhelp" + "github.com/peterbourgon/ff/v4/fftoml" ) -type opts struct { - host string - port int - streamname string - bps int - channel int - ratelimit int - configPath string - loglevel string +var version string // Version will be set at build time + +// Flags holds the command-line flags for the VBANTXT client. +type Flags struct { + Host string + Port int + Streamname string + Bps int + Channel int + Ratelimit int + ConfigPath string // Path to the configuration file + Loglevel string // Log level + Version bool // Version flag } -func exit(err error) { +func exitOnError(err error) { _, _ = fmt.Fprintf(os.Stderr, "Error: %s\n", err) os.Exit(1) } func main() { - var ( - host string - port int - streamname string - loglevel string - configPath string - bps int - channel int - ratelimit int - ) + var flags Flags - flag.StringVar(&host, "host", "localhost", "vban host") - flag.StringVar(&host, "h", "localhost", "vban host (shorthand)") - flag.IntVar(&port, "port", 6980, "vban server port") - flag.IntVar(&port, "p", 6980, "vban server port (shorthand)") - flag.StringVar(&streamname, "streamname", "Command1", "stream name for text requests") - flag.StringVar(&streamname, "s", "Command1", "stream name for text requests (shorthand)") - - flag.IntVar(&bps, "bps", 256000, "vban bps") - flag.IntVar(&bps, "b", 256000, "vban bps (shorthand)") - flag.IntVar(&channel, "channel", 0, "vban channel") - flag.IntVar(&channel, "c", 0, "vban channel (shorthand)") - flag.IntVar(&ratelimit, "ratelimit", 20, "request ratelimit in milliseconds") - flag.IntVar(&ratelimit, "r", 20, "request ratelimit in milliseconds (shorthand)") + // VBAN specific flags + fs := ff.NewFlagSet("vbantxt") + fs.StringVar(&flags.Host, 'H', "host", "localhost", "VBAN host") + fs.IntVar(&flags.Port, 'p', "port", 6980, "VBAN port") + fs.StringVar(&flags.Streamname, 's', "streamname", "Command1", "VBAN stream name") + fs.IntVar(&flags.Bps, 'b', "bps", 256000, "VBAN BPS") + fs.IntVar(&flags.Channel, 'n', "channel", 0, "VBAN channel") + fs.IntVar(&flags.Ratelimit, 'r', "ratelimit", 20, "VBAN rate limit (ms)") configDir, err := os.UserConfigDir() if err != nil { - exit(err) + exitOnError(fmt.Errorf("failed to get user config directory: %w", err)) } defaultConfigPath := filepath.Join(configDir, "vbantxt", "config.toml") - flag.StringVar(&configPath, "config", defaultConfigPath, "config path") - flag.StringVar(&configPath, "C", defaultConfigPath, "config path (shorthand)") - flag.StringVar(&loglevel, "loglevel", "warn", "log level") - flag.StringVar(&loglevel, "l", "warn", "log level (shorthand)") - flag.Parse() + // Configuration file and logging flags + fs.StringVar(&flags.ConfigPath, 'C', "config", defaultConfigPath, "Path to the configuration file") + fs.StringVar(&flags.Loglevel, 'l', "loglevel", "warn", "Log level (debug, info, warn, error, fatal, panic)") + fs.BoolVar(&flags.Version, 'v', "version", "Show version information") - level, err := log.ParseLevel(loglevel) + err = ff.Parse(fs, os.Args[1:], + ff.WithEnvVarPrefix("VBANTXT"), + ff.WithConfigFileFlag("config"), + ff.WithConfigAllowMissingFile(), + ff.WithConfigFileParser(fftoml.Parser{Delimiter: "."}.Parse), + ) + switch { + case errors.Is(err, ff.ErrHelp): + fmt.Fprintf(os.Stderr, "%s\n", ffhelp.Flags(fs, "vbantxt [flags] ")) + os.Exit(0) + case err != nil: + exitOnError(fmt.Errorf("failed to parse flags: %w", err)) + } + + if flags.Version { + if version == "" { + info, ok := debug.ReadBuildInfo() + if !ok { + exitOnError(errors.New("failed to read build info")) + } + version = strings.Split(info.Main.Version, "-")[0] + } + fmt.Printf("vbantxt version: %s\n", version) + os.Exit(0) + } + + level, err := log.ParseLevel(flags.Loglevel) if err != nil { - exit(fmt.Errorf("invalid log level: %s", loglevel)) + exitOnError(fmt.Errorf("invalid log level: %s", flags.Loglevel)) } log.SetLevel(level) - o := opts{ - host: host, - port: port, - streamname: streamname, - bps: bps, - channel: channel, - ratelimit: ratelimit, - configPath: configPath, - loglevel: loglevel, - } + log.Debugf("Loaded configuration: %+v", flags) - // Load the config only if the host, port, and streamname flags are not provided. - // This allows the user to override the config values with command line flags. - if !flagsPassed([]string{"host", "h", "port", "p", "streamname", "s"}) { - config, err := loadConfig(configPath) - if err != nil { - exit(err) - } - - o.host = config.Host - o.port = config.Port - o.streamname = config.Streamname - } - log.Debugf("opts: %+v", o) - - client, closer, err := createClient(o) + client, closer, err := createClient(&flags) if err != nil { - exit(err) + exitOnError(err) } defer closer() - for _, arg := range flag.Args() { + for _, arg := range fs.GetArgs() { err := client.Send(arg) if err != nil { log.Error(err) @@ -111,14 +109,14 @@ func main() { } // createClient creates a new vban client with the provided options. -func createClient(o opts) (*vbantxt.VbanTxt, func(), error) { +func createClient(flags *Flags) (*vbantxt.VbanTxt, func(), error) { client, err := vbantxt.New( - o.host, - o.port, - o.streamname, - vbantxt.WithBPSOpt(o.bps), - vbantxt.WithChannel(o.channel), - vbantxt.WithRateLimit(time.Duration(o.ratelimit)*time.Millisecond)) + flags.Host, + flags.Port, + flags.Streamname, + vbantxt.WithBPSOpt(flags.Bps), + vbantxt.WithChannel(flags.Channel), + vbantxt.WithRateLimit(time.Duration(flags.Ratelimit)*time.Millisecond)) if err != nil { return nil, nil, err } diff --git a/go.mod b/go.mod index d9aef90..ea986fc 100644 --- a/go.mod +++ b/go.mod @@ -5,14 +5,31 @@ go 1.23.0 toolchain go1.24.1 require ( - github.com/BurntSushi/toml v1.5.0 - github.com/sirupsen/logrus v1.9.3 - github.com/stretchr/testify v1.9.0 + github.com/charmbracelet/log v0.4.2 + github.com/peterbourgon/ff/v4 v4.0.0-alpha.4 + github.com/stretchr/testify v1.10.0 ) require ( + github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect + github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc // indirect + github.com/charmbracelet/lipgloss v1.1.0 // indirect + github.com/charmbracelet/x/ansi v0.8.0 // indirect + github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd // indirect + github.com/charmbracelet/x/term v0.2.1 // indirect github.com/davecgh/go-spew v1.1.1 // indirect + github.com/go-logfmt/logfmt v0.6.0 // indirect + github.com/kr/pretty v0.1.0 // indirect + github.com/lucasb-eyer/go-colorful v1.2.0 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/mattn/go-runewidth v0.0.16 // indirect + github.com/muesli/termenv v0.16.0 // indirect + github.com/pelletier/go-toml/v2 v2.0.9 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/rivo/uniseg v0.4.7 // indirect + github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect + golang.org/x/exp v0.0.0-20231006140011-7918f672742d // indirect golang.org/x/sys v0.33.0 // indirect + gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect gopkg.in/yaml.v3 v3.0.1 // indirect ) diff --git a/go.sum b/go.sum index 830a237..7e803d1 100644 --- a/go.sum +++ b/go.sum @@ -1,21 +1,64 @@ -github.com/BurntSushi/toml v1.5.0 h1:W5quZX/G/csjUnuI8SUYlsHs9M38FC7znL0lIO+DvMg= -github.com/BurntSushi/toml v1.5.0/go.mod h1:ukJfTF/6rtPPRCnwkur4qwRxa8vTRFBF0uk2lLoLwho= +github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k= +github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8= +github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc h1:4pZI35227imm7yK2bGPcfpFEmuY1gc2YSTShr4iJBfs= +github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc/go.mod h1:X4/0JoqgTIPSFcRA/P6INZzIuyqdFY5rm8tb41s9okk= +github.com/charmbracelet/lipgloss v1.1.0 h1:vYXsiLHVkK7fp74RkV7b2kq9+zDLoEU4MZoFqR/noCY= +github.com/charmbracelet/lipgloss v1.1.0/go.mod h1:/6Q8FR2o+kj8rz4Dq0zQc3vYf7X+B0binUUBwA0aL30= +github.com/charmbracelet/log v0.4.2 h1:hYt8Qj6a8yLnvR+h7MwsJv/XvmBJXiueUcI3cIxsyig= +github.com/charmbracelet/log v0.4.2/go.mod h1:qifHGX/tc7eluv2R6pWIpyHDDrrb/AG71Pf2ysQu5nw= +github.com/charmbracelet/x/ansi v0.8.0 h1:9GTq3xq9caJW8ZrBTe0LIe2fvfLR/bYXKTx2llXn7xE= +github.com/charmbracelet/x/ansi v0.8.0/go.mod h1:wdYl/ONOLHLIVmQaxbIYEC/cRKOQyjTkowiI4blgS9Q= +github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd h1:vy0GVL4jeHEwG5YOXDmi86oYw2yuYUGqz6a8sLwg0X8= +github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd/go.mod h1:xe0nKWGd3eJgtqZRaN9RjMtK7xUYchjzPr7q6kcvCCs= +github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ= +github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/go-logfmt/logfmt v0.6.0 h1:wGYYu3uicYdqXVgoYbvnkrPVXkuLM1p1ifugDMEdRi4= +github.com/go-logfmt/logfmt v0.6.0/go.mod h1:WYhtIu8zTZfxdn5+rREduYbwxfcBr/Vr6KEVveWlfTs= +github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY= +github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/mattn/go-runewidth v0.0.16 h1:E5ScNMtiwvlvB5paMFdw9p4kSQzbXFikJ5SQO6TULQc= +github.com/mattn/go-runewidth v0.0.16/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= +github.com/muesli/termenv v0.16.0 h1:S5AlUN9dENB57rsbnkPyfdGuWIlkmzJjbFf0Tf5FWUc= +github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3VfY/Cnk= +github.com/pelletier/go-toml/v2 v2.0.9 h1:uH2qQXheeefCCkuBBSLi7jCiSmj3VRh2+Goq2N7Xxu0= +github.com/pelletier/go-toml/v2 v2.0.9/go.mod h1:tJU2Z3ZkXwnxa4DPO899bsyIoywizdUvyaeZurnPPDc= +github.com/peterbourgon/ff/v4 v4.0.0-alpha.4 h1:aiqS8aBlF9PsAKeMddMSfbwp3smONCn3UO8QfUg0Z7Y= +github.com/peterbourgon/ff/v4 v4.0.0-alpha.4/go.mod h1:H/13DK46DKXy7EaIxPhk2Y0EC8aubKm35nBjBe8AAGc= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= -github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ= -github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= -github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= -golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= +github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no= +github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM= +golang.org/x/exp v0.0.0-20231006140011-7918f672742d h1:jtJma62tbqLibJ5sFQz8bKtEM8rJBtfilJ2qTU199MI= +golang.org/x/exp v0.0.0-20231006140011-7918f672742d/go.mod h1:ldy0pHrwJyGW56pPQzzkH36rKxoZW1tw7ZJpeKx+hdo= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw= golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= -gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=