x/urfave-cli
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Making sure examples in README are valid

Browse Source
This commit is contained in:
Dan Buch 2016-04-27 09:21:56 -04:00
parent f688d47415
commit 882dd2cc6b
No known key found for this signature in database
GPG Key ID: FAEF12936DD3E3EC
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -60,9 +60,9 @@ func main() {
app := cli.NewApp() app := cli.NewApp()
app.Name = "boom" app.Name = "boom"
app.Usage = "make an explosive entrance" app.Usage = "make an explosive entrance"
app.Action = func(c *cli.Context) int { app.Action = func(c *cli.Context) error {
fmt.Println("boom! I say!") fmt.Println("boom! I say!")
return 0 return nil
} }
app.Run(os.Args) app.Run(os.Args)
@ -91,9 +91,9 @@ func main() {
app := cli.NewApp() app := cli.NewApp()
app.Name = "greet" app.Name = "greet"
app.Usage = "fight the loneliness!" app.Usage = "fight the loneliness!"
app.Action = func(c *cli.Context) int { app.Action = func(c *cli.Context) error {
fmt.Println("Hello friend!") fmt.Println("Hello friend!")
return 0 return nil
} }
app.Run(os.Args) app.Run(os.Args)
@ -139,8 +139,9 @@ You can lookup arguments by calling the `Args` function on `cli.Context`.
``` go ``` go
... ...
app.Action = func(c *cli.Context) { app.Action = func(c *cli.Context) error {
println("Hello", c.Args()[0]) println("Hello", c.Args()[0])
return nil
} }
... ...
``` ```
@ -158,7 +159,7 @@ app.Flags = []cli.Flag {
Usage: "language for the greeting", Usage: "language for the greeting",
}, },
} }
app.Action = func(c *cli.Context) { app.Action = func(c *cli.Context) error {
name := "someone" name := "someone"
if c.NArg() > 0 { if c.NArg() > 0 {
name = c.Args()[0] name = c.Args()[0]
@ -168,6 +169,7 @@ app.Action = func(c *cli.Context) {
} else { } else {
println("Hello", name) println("Hello", name)
} }
return nil
} }
... ...
``` ```
@ -185,7 +187,7 @@ app.Flags = []cli.Flag {
Destination: &language, Destination: &language,
}, },
} }
app.Action = func(c *cli.Context) { app.Action = func(c *cli.Context) error {
name := "someone" name := "someone"
if c.NArg() > 0 { if c.NArg() > 0 {
name = c.Args()[0] name = c.Args()[0]
@ -195,6 +197,7 @@ app.Action = func(c *cli.Context) {
} else { } else {
println("Hello", name) println("Hello", name)
} }
return nil
} }
... ...
``` ```
@ -276,7 +279,7 @@ Here is a more complete sample of a command using YAML support:
Aliases: []string{"tc"}, Aliases: []string{"tc"},
Usage: "this is for testing", Usage: "this is for testing",
Description: "testing", Description: "testing",
Action: func(c *cli.Context) { Action: func(c *cli.Context) error {
// Action to run // Action to run
}, },
Flags: []cli.Flag{ Flags: []cli.Flag{