burningalchemist / sql_exporter

Database-agnostic SQL Exporter for Prometheus
MIT License
329 stars 65 forks source link

Help shows incorrect syntax #595

Closed MrCaffeen closed 1 month ago

MrCaffeen commented 1 month ago

Describe the bug Script shows single dash in application help --help but app requires double dash

To Reproduce run executable from command line, help options show single dash

Expected behavior Should display double dash as expected & Required

burningalchemist commented 1 month ago

Hi @MrCaffeen, this behaviour is defined by the standard Golang's library flag (link), that's used in the project, and is not something I may change.

...The following forms are permitted:

-flag
--flag   // double dashes are also permitted
-flag=x
-flag x  // non-boolean flags only
One or two dashes may be used; they are equivalent...

Originally, Golang only supported single-dash arguments. As of Go 1.18, the package does support both single dash (-) and double dash (--) for flags.

The help is generated automatically and follows the historical precedence.

If for some reason single dash doesn't work on your machine, just use double dash. 👍