Compare commits

...

1 Commits
v0.0.3 ... main

Author SHA1 Message Date
jolheiser 763d358701
Mention aliases
Signed-off-by: jolheiser <john.olheiser@gmail.com>
2022-09-03 21:40:17 -05:00
2 changed files with 24 additions and 1 deletions

View File

@ -43,6 +43,28 @@ func main() {
```
## Aliases
While the stdlib doesn't directly support flag aliases, this library allows for neater generation using a special syntax.
```go
package main
import "flag"
func main() {
fs := flag.NewFlagSet("myapp", flag.ExitOnError)
stringFlag := fs.String("string", "", "String flag")
fs.StringVar(stringFlag, "s", *stringFlag, "--string")
}
```
In the above code, a second flag was registered with the special `Usage` that simply declared what the long-form flag name was.
In this scenario, `ffmd` will generate docs similar to
```text
--string,-s
```
See the [example](examples/alias).
## License
[MIT](LICENSE)

View File

@ -5,4 +5,5 @@ generated docs.
- [flagset](flagset) - Using only stdlib `flag.FlagSet`
- [single](single) - Using a single `ffcli.Command`
- [multiple](multiple) - Using `ffcli.Command` with multiple sub-commands
- [multiple](multiple) - Using `ffcli.Command` with multiple sub-commands
- [alias](alias) - Using `ffcli.Command` with alias setup