Google Git
Sign in
fuchsia / third_party / github.com / maruel / subcommands / refs/tags/v1.1.1
commit7642663bf7467dd2ee5d443a737003516b87f159[log] [tgz]
authorRobert Iannucci <iannucci@chromium.org>Wed Sep 22 12:54:03 2021 -0700
committerGitHub <noreply@github.com>Wed Sep 22 15:54:03 2021 -0400
tree3f13aa362ec02ff2db07ad704787590b15a84d54
parent76e231eeaca7ff66be919327f1a05aa592097547 [diff]
Allow GetFlags to return nil. (#9)

This allows individual subcommands to indicate that they would like to
take full control of the 'args' parsing. This is useful for when 'flag'
is insufficiently groovy, or when writing wrapper programs where some
or even none of the flags need to be interpreted by the wrapper itself
(e.g. merely passed through to the target program).

Without this, invocations such as `prog subcommand -flag` will fail
because `-flag` would be interpreted as an 'unknown flag'.
4 files changed
tree: 3f13aa362ec02ff2db07ad704787590b15a84d54
  1. .github/
  2. sample-complex/
  3. sample-simple/
  4. subcommandstest/
  5. .gitignore
  6. codecov.yml
  7. go.mod
  8. go.sum
  9. LICENSE
  10. logger.go
  11. README.md
  12. subcommands.go
  13. subcommands_test.go
README.md

subcommands golang library

This package permits a Go application to implement subcommands support similar to what is supported by the ‘go’ tool.

The library is designed so that the test cases can run concurrently. Using global flags variables is discouraged to keep your program testable concurrently.

The intended command is found via heuristic search;

  • exact match
  • unique prefix, e.g. lo will run longcommand as long as there's no command with the same prefix.
  • case insensitivity; for those weird enough to use Upper Cased Commands.
  • levenshtein distance; where longcmmand or longcmomand will properly trigger longcommand.

PkgGoDev Coverage Status

Examples

  • See sample-simple for a barebone sample skeleton usable as-is.
  • See sample-complex for a complex sample using advanced features.
  • See module subcommands/subcommandstest for tools to help testing an application using subcommands. One of the main benefit is t.Parallel() just works, because subcommands help wrapping global variables.