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

Re-order items to be more logical.

Browse Source
This commit is contained in:
Tom Limoncelli 2020-03-31 18:58:39 -04:00
parent 84c98fac3e
commit be370eb485
1 changed files with 50 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
docs/migrate-v1-to-v2.md
View File

@ -1,6 +1,16 @@
Migration Guide: v1 to v2 Migration Guide: v1 to v2
=== ===
v2 has a number of breaking changes but converting is relatively
straightforward: make the changes documented below then resolve any
compiler errors. We hope this will be sufficient for most typical
users.
If you find any issues not covered by this document, please post a
comment on [Issue 921](https://github.com/urfave/cli/issues/921) or
consider sending a PR to help improve this guide.
<!-- toc --> <!-- toc -->
* [Flags before args](#flags-before-args) * [Flags before args](#flags-before-args)
@ -16,15 +26,6 @@ Migration Guide: v1 to v2
<!-- tocstop --> <!-- tocstop -->
v2 has a number of breaking changes but converting is relatively
straightforward: make the changes documented below then resolve any
compiler errors. We hope this will be sufficient for most typical
users.
If you find any issues not covered by this document, please post a
comment on [Issue 921](https://github.com/urfave/cli/issues/921) or
consider sending a PR to help improve this guide.
# Flags before args # Flags before args
In v2 flags must come before args. This is more POSIX-compliant. You In v2 flags must come before args. This is more POSIX-compliant. You
@ -72,6 +73,46 @@ cli.StringFlag{
Sadly v2 doesn't warn you if a comma is in the name. Sadly v2 doesn't warn you if a comma is in the name.
# Actions returns errors
A command's `Action:` now returns an `error`.
* OLD: `Action: func(c *cli.Context) {`
* NEW: `Action: func(c *cli.Context) error {`
Compiler messages you might see:
```
cannot use func literal (type func(*cli.Context)) as type cli.ActionFunc in field value
```
# cli.Flag changed
`cli.Flag` is now a list of pointers.
What this means to you:
If you make a list of flags, add a `&` in front of each
item. cli.BoolFlag, cli.StringFlag, etc.
* OLD:
```go
app.Flags = []cli.Flag{
cli.BoolFlag{
```
* NEW:
```go
app.Flags = []cli.Flag{
&cli.BoolFlag{
```
Compiler messages you might see:
```
cli.StringFlag does not implement cli.Flag (Apply method has pointer receiver)
```
# Commands are now lists of pointers # Commands are now lists of pointers
Occurrences of `[]Command` have been changed to `[]*Command`. Occurrences of `[]Command` have been changed to `[]*Command`.
@ -106,33 +147,6 @@ Compiler messages you might see:
cannot use cli.Command literal (type cli.Command) as type *cli.Command in argument to cannot use cli.Command literal (type cli.Command) as type *cli.Command in argument to
``` ```
# cli.Flag changed
`cli.Flag` is now a list of pointers.
What this means to you:
If you make a list of flags, add a `&` in front of each
item. cli.BoolFlag, cli.StringFlag, etc.
* OLD:
```go
app.Flags = []cli.Flag{
cli.BoolFlag{
```
* NEW:
```go
app.Flags = []cli.Flag{
&cli.BoolFlag{
```
Compiler messages you might see:
```
cli.StringFlag does not implement cli.Flag (Apply method has pointer receiver)
```
# Appending Commands # Appending Commands
Appending to a list of commands needs to be changed since the list is Appending to a list of commands needs to be changed since the list is
@ -147,19 +161,6 @@ Compiler messages you might see:
cannot use c (type *cli.Command) as type cli.Command in append cannot use c (type *cli.Command) as type cli.Command in append
``` ```
# Actions returns errors
A command's `Action:` now returns an `error`.
* OLD: `Action: func(c *cli.Context) {`
* NEW: `Action: func(c *cli.Context) error {`
Compiler messages you might see:
```
cannot use func literal (type func(*cli.Context)) as type cli.ActionFunc in field value
```
# Everything else # Everything else
Compile the code and work through any errors. Most should Compile the code and work through any errors. Most should