AuHau / allot

Parse placeholder and wildcard text commands

allot

allot is a small Golang library to match and parse commands with pre-defined strings. For example use allot to define a list of commands your CLI application or Slackbot supports and check if incoming requests are matching your commands.

The allot library supports placeholders and regular expressions for parameter matching and parsing.

Usage

cmd := allot.New("revert <commits:integer> commits on <project:string> at (stage|prod)")
match, err := cmd.Match("revert 12 commits on example at prod")

if (err != nil)
  commits, _ = match.Integer("commits")
  project, _ = match.String("project")
  env, _ = match.Match(2)

  fmt.Printf("Revert \"%d\" on \"%s\" at \"%s\"", commits, project, env)
} else {
  fmt.Println("Request did not match command.")
}

Regex escaping

If you want to support regex escaping and hence characters like []() in your commands than use allot.NewWithEscaping() instead of allot.New().

Examples

See the hanu Slackbot framework for a usecase for allot:

• Host a Golang Slack bot on Heroku

Credits

• Go coverage script from Mathias Lafeldt