Google Git
Sign in
fuchsia / third_party / github.com / maruel / subcommands / refs/tags/v1.1.0
commite82ce8f3af113ac6d0afb44bab30fcdef71afcc0[log] [tgz]
authorMarc-Antoine Ruel <maruel@gmail.com>Thu Feb 04 17:50:16 2021 -0500
committerMarc-Antoine Ruel <maruel@gmail.com>Thu Feb 04 18:59:47 2021 -0500
treef73a378ae408a688c70a1b862a6b7425cee787b5
parent9c2bbaba0d70de28cb39a9edf339dd560410cf04 [diff]
Export Usage(); enable subcommand usability

It requires a hack if the user wants to capture help's -advanced flag.
Other than that, it works fine.

Updated sample-complex and added extensive help test to confirm the output.

Fix incorrect CI test on before 1.15 because of a copy paste error.
13 files changed
tree: f73a378ae408a688c70a1b862a6b7425cee787b5
  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.