-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Vendor codegangsta/cli 8cbee4b7192cea690c9f048e742e6b4c3525fd9e
- Loading branch information
1 parent
d6b6a00
commit 4ac0eeb
Showing
8 changed files
with
1,662 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
Copyright (C) 2013 Jeremy Saenz | ||
All Rights Reserved. | ||
|
||
MIT LICENSE | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
this software and associated documentation files (the "Software"), to deal in | ||
the Software without restriction, including without limitation the rights to | ||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of | ||
the Software, and to permit persons to whom the Software is furnished to do so, | ||
subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS | ||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER | ||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | ||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,306 @@ | ||
package cli | ||
|
||
import ( | ||
"fmt" | ||
"io" | ||
"io/ioutil" | ||
"os" | ||
"time" | ||
) | ||
|
||
// App is the main structure of a cli application. It is recomended that | ||
// an app be created with the cli.NewApp() function | ||
type App struct { | ||
// The name of the program. Defaults to os.Args[0] | ||
Name string | ||
// Description of the program. | ||
Usage string | ||
// Version of the program | ||
Version string | ||
// List of commands to execute | ||
Commands []Command | ||
// List of flags to parse | ||
Flags []Flag | ||
// Boolean to enable bash completion commands | ||
EnableBashCompletion bool | ||
// Boolean to hide built-in help command | ||
HideHelp bool | ||
// Boolean to hide built-in version flag | ||
HideVersion bool | ||
// An action to execute when the bash-completion flag is set | ||
BashComplete func(context *Context) | ||
// An action to execute before any subcommands are run, but after the context is ready | ||
// If a non-nil error is returned, no subcommands are run | ||
Before func(context *Context) error | ||
// An action to execute after any subcommands are run, but after the subcommand has finished | ||
// It is run even if Action() panics | ||
After func(context *Context) error | ||
// The action to execute when no subcommands are specified | ||
Action func(context *Context) | ||
// Execute this function if the proper command cannot be found | ||
CommandNotFound func(context *Context, command string) | ||
// Compilation date | ||
Compiled time.Time | ||
// List of all authors who contributed | ||
Authors []Author | ||
// Name of Author (Note: Use App.Authors, this is deprecated) | ||
Author string | ||
// Email of Author (Note: Use App.Authors, this is deprecated) | ||
Email string | ||
// Writer writer to write output to | ||
Writer io.Writer | ||
} | ||
|
||
// Tries to find out when this binary was compiled. | ||
// Returns the current time if it fails to find it. | ||
func compileTime() time.Time { | ||
info, err := os.Stat(os.Args[0]) | ||
if err != nil { | ||
return time.Now() | ||
} | ||
return info.ModTime() | ||
} | ||
|
||
// Creates a new cli Application with some reasonable defaults for Name, Usage, Version and Action. | ||
func NewApp() *App { | ||
return &App{ | ||
Name: os.Args[0], | ||
Usage: "A new cli application", | ||
Version: "0.0.0", | ||
BashComplete: DefaultAppComplete, | ||
Action: helpCommand.Action, | ||
Compiled: compileTime(), | ||
Writer: os.Stdout, | ||
} | ||
} | ||
|
||
// Entry point to the cli app. Parses the arguments slice and routes to the proper flag/args combination | ||
func (a *App) Run(arguments []string) (err error) { | ||
if a.Author != "" || a.Email != "" { | ||
a.Authors = append(a.Authors, Author{Name: a.Author, Email: a.Email}) | ||
} | ||
|
||
// append help to commands | ||
if a.Command(helpCommand.Name) == nil && !a.HideHelp { | ||
a.Commands = append(a.Commands, helpCommand) | ||
if (HelpFlag != BoolFlag{}) { | ||
a.appendFlag(HelpFlag) | ||
} | ||
} | ||
|
||
//append version/help flags | ||
if a.EnableBashCompletion { | ||
a.appendFlag(BashCompletionFlag) | ||
} | ||
|
||
if !a.HideVersion { | ||
a.appendFlag(VersionFlag) | ||
} | ||
|
||
// parse flags | ||
set := flagSet(a.Name, a.Flags) | ||
set.SetOutput(ioutil.Discard) | ||
err = set.Parse(arguments[1:]) | ||
nerr := normalizeFlags(a.Flags, set) | ||
if nerr != nil { | ||
fmt.Fprintln(a.Writer, nerr) | ||
context := NewContext(a, set, nil) | ||
ShowAppHelp(context) | ||
fmt.Fprintln(a.Writer) | ||
return nerr | ||
} | ||
context := NewContext(a, set, nil) | ||
|
||
if err != nil { | ||
fmt.Fprintf(a.Writer, "Incorrect Usage.\n\n") | ||
ShowAppHelp(context) | ||
fmt.Fprintln(a.Writer) | ||
return err | ||
} | ||
|
||
if checkCompletions(context) { | ||
return nil | ||
} | ||
|
||
if checkHelp(context) { | ||
return nil | ||
} | ||
|
||
if checkVersion(context) { | ||
return nil | ||
} | ||
|
||
if a.After != nil { | ||
defer func() { | ||
afterErr := a.After(context) | ||
if afterErr != nil { | ||
if err != nil { | ||
err = NewMultiError(err, afterErr) | ||
} else { | ||
err = afterErr | ||
} | ||
} | ||
}() | ||
} | ||
|
||
if a.Before != nil { | ||
err := a.Before(context) | ||
if err != nil { | ||
return err | ||
} | ||
} | ||
|
||
args := context.Args() | ||
if args.Present() { | ||
name := args.First() | ||
c := a.Command(name) | ||
if c != nil { | ||
return c.Run(context) | ||
} | ||
} | ||
|
||
// Run default Action | ||
a.Action(context) | ||
return nil | ||
} | ||
|
||
// Another entry point to the cli app, takes care of passing arguments and error handling | ||
func (a *App) RunAndExitOnError() { | ||
if err := a.Run(os.Args); err != nil { | ||
fmt.Fprintln(os.Stderr, err) | ||
os.Exit(1) | ||
} | ||
} | ||
|
||
// Invokes the subcommand given the context, parses ctx.Args() to generate command-specific flags | ||
func (a *App) RunAsSubcommand(ctx *Context) (err error) { | ||
// append help to commands | ||
if len(a.Commands) > 0 { | ||
if a.Command(helpCommand.Name) == nil && !a.HideHelp { | ||
a.Commands = append(a.Commands, helpCommand) | ||
if (HelpFlag != BoolFlag{}) { | ||
a.appendFlag(HelpFlag) | ||
} | ||
} | ||
} | ||
|
||
// append flags | ||
if a.EnableBashCompletion { | ||
a.appendFlag(BashCompletionFlag) | ||
} | ||
|
||
// parse flags | ||
set := flagSet(a.Name, a.Flags) | ||
set.SetOutput(ioutil.Discard) | ||
err = set.Parse(ctx.Args().Tail()) | ||
nerr := normalizeFlags(a.Flags, set) | ||
context := NewContext(a, set, ctx) | ||
|
||
if nerr != nil { | ||
fmt.Fprintln(a.Writer, nerr) | ||
if len(a.Commands) > 0 { | ||
ShowSubcommandHelp(context) | ||
} else { | ||
ShowCommandHelp(ctx, context.Args().First()) | ||
} | ||
fmt.Fprintln(a.Writer) | ||
return nerr | ||
} | ||
|
||
if err != nil { | ||
fmt.Fprintf(a.Writer, "Incorrect Usage.\n\n") | ||
ShowSubcommandHelp(context) | ||
return err | ||
} | ||
|
||
if checkCompletions(context) { | ||
return nil | ||
} | ||
|
||
if len(a.Commands) > 0 { | ||
if checkSubcommandHelp(context) { | ||
return nil | ||
} | ||
} else { | ||
if checkCommandHelp(ctx, context.Args().First()) { | ||
return nil | ||
} | ||
} | ||
|
||
if a.After != nil { | ||
defer func() { | ||
afterErr := a.After(context) | ||
if afterErr != nil { | ||
if err != nil { | ||
err = NewMultiError(err, afterErr) | ||
} else { | ||
err = afterErr | ||
} | ||
} | ||
}() | ||
} | ||
|
||
if a.Before != nil { | ||
err := a.Before(context) | ||
if err != nil { | ||
return err | ||
} | ||
} | ||
|
||
args := context.Args() | ||
if args.Present() { | ||
name := args.First() | ||
c := a.Command(name) | ||
if c != nil { | ||
return c.Run(context) | ||
} | ||
} | ||
|
||
// Run default Action | ||
a.Action(context) | ||
|
||
return nil | ||
} | ||
|
||
// Returns the named command on App. Returns nil if the command does not exist | ||
func (a *App) Command(name string) *Command { | ||
for _, c := range a.Commands { | ||
if c.HasName(name) { | ||
return &c | ||
} | ||
} | ||
|
||
return nil | ||
} | ||
|
||
func (a *App) hasFlag(flag Flag) bool { | ||
for _, f := range a.Flags { | ||
if flag == f { | ||
return true | ||
} | ||
} | ||
|
||
return false | ||
} | ||
|
||
func (a *App) appendFlag(flag Flag) { | ||
if !a.hasFlag(flag) { | ||
a.Flags = append(a.Flags, flag) | ||
} | ||
} | ||
|
||
// Author represents someone who has contributed to a cli project. | ||
type Author struct { | ||
Name string // The Authors name | ||
Email string // The Authors email | ||
} | ||
|
||
// String makes Author comply to the Stringer interface, to allow an easy print in the templating process | ||
func (a Author) String() string { | ||
e := "" | ||
if a.Email != "" { | ||
e = "<" + a.Email + "> " | ||
} | ||
|
||
return fmt.Sprintf("%v %v", a.Name, e) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
// Package cli provides a minimal framework for creating and organizing command line | ||
// Go applications. cli is designed to be easy to understand and write, the most simple | ||
// cli application can be written as follows: | ||
// func main() { | ||
// cli.NewApp().Run(os.Args) | ||
// } | ||
// | ||
// Of course this application does not do much, so let's make this an actual application: | ||
// func main() { | ||
// app := cli.NewApp() | ||
// app.Name = "greet" | ||
// app.Usage = "say a greeting" | ||
// app.Action = func(c *cli.Context) { | ||
// println("Greetings") | ||
// } | ||
// | ||
// app.Run(os.Args) | ||
// } | ||
package cli | ||
|
||
import ( | ||
"strings" | ||
) | ||
|
||
type MultiError struct { | ||
Errors []error | ||
} | ||
|
||
func NewMultiError(err ...error) MultiError { | ||
return MultiError{Errors: err} | ||
} | ||
|
||
func (m MultiError) Error() string { | ||
errs := make([]string, len(m.Errors)) | ||
for i, err := range m.Errors { | ||
errs[i] = err.Error() | ||
} | ||
|
||
return strings.Join(errs, "\n") | ||
} |
Oops, something went wrong.