Skip to content

Commit

Permalink
Merge branch 'master' into v1v2release
Browse files Browse the repository at this point in the history
  • Loading branch information
coilysiren committed Nov 21, 2019
2 parents cca5dd1 + 47016a6 commit 2a06023
Show file tree
Hide file tree
Showing 13 changed files with 105 additions and 21 deletions.
3 changes: 2 additions & 1 deletion .gitignore
@@ -1,3 +1,4 @@
*.coverprofile
*.orig
node_modules/
vendor
vendor
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -25,7 +25,7 @@ Usage documentation exists for each major version. Don't know what version you'r
**Warning**: `v2` is in a beta state.

```
$ go get github.com/urfave/cli.v2
$ go get github.com/urfave/cli/v2
```

```go
Expand Down
1 change: 1 addition & 0 deletions build.go
Expand Up @@ -137,6 +137,7 @@ func GfmrunActionFunc(c *cli.Context) error {
if err != nil {
return err
}
defer file.Close()

var counter int
scanner := bufio.NewScanner(file)
Expand Down
4 changes: 2 additions & 2 deletions context.go
Expand Up @@ -114,8 +114,8 @@ func (c *Context) Lineage() []*Context {
return lineage
}

// value returns the value of the flag corresponding to `name`
func (c *Context) value(name string) interface{} {
// Value returns the value of the flag corresponding to `name`
func (c *Context) Value(name string) interface{} {
return c.flagSet.Lookup(name).Value.(flag.Getter).Get()
}

Expand Down
4 changes: 2 additions & 2 deletions context_test.go
Expand Up @@ -3,8 +3,8 @@ package cli
import (
"context"
"flag"
"sort"
"os"
"sort"
"strings"
"testing"
"time"
Expand Down Expand Up @@ -328,7 +328,7 @@ func TestContextPropagation(t *testing.T) {
parent := NewContext(nil, nil, nil)
parent.Context = context.WithValue(context.Background(), "key", "val")
ctx := NewContext(nil, nil, parent)
val := ctx.Value("key")
val := ctx.Context.Value("key")
if val == nil {
t.Fatal("expected a parent context to be inherited but got nil")
}
Expand Down
18 changes: 17 additions & 1 deletion docs_test.go
Expand Up @@ -64,7 +64,10 @@ func testApp() *App {
}}
app.UsageText = "app [first_arg] [second_arg]"
app.Usage = "Some app"
app.Authors = []*Author{{Name: "Harrison", Email: "harrison@lolwut.com"}}
app.Authors = []*Author{
{Name: "Harrison", Email: "harrison@lolwut.com"},
{Name: "Oliver Allen", Email: "oliver@toyshop.com"},
}
return app
}

Expand Down Expand Up @@ -112,6 +115,19 @@ func TestToMarkdownNoCommands(t *testing.T) {
expectFileContent(t, "testdata/expected-doc-no-commands.md", res)
}

func TestToMarkdownNoAuthors(t *testing.T) {
// Given
app := testApp()
app.Authors = []*Author{}

// When
res, err := app.ToMarkdown()

// Then
expect(t, err, nil)
expectFileContent(t, "testdata/expected-doc-no-authors.md", res)
}

func TestToMan(t *testing.T) {
// Given
app := testApp()
Expand Down
4 changes: 2 additions & 2 deletions flag_test.go
Expand Up @@ -121,8 +121,8 @@ func TestFlagsFromEnv(t *testing.T) {
a := App{
Flags: []Flag{test.flag},
Action: func(ctx *Context) error {
if !reflect.DeepEqual(ctx.value(test.flag.Names()[0]), test.output) {
t.Errorf("ex:%01d expected %q to be parsed as %#v, instead was %#v", i, test.input, test.output, ctx.value(test.flag.Names()[0]))
if !reflect.DeepEqual(ctx.Value(test.flag.Names()[0]), test.output) {
t.Errorf("ex:%01d expected %q to be parsed as %#v, instead was %#v", i, test.input, test.output, ctx.Value(test.flag.Names()[0]))
}
return nil
},
Expand Down
7 changes: 3 additions & 4 deletions template.go
Expand Up @@ -71,10 +71,9 @@ OPTIONS:
{{end}}{{end}}
`

var MarkdownDocTemplate = `% {{ .App.Name }}(8) {{ .App.Description }}
{{ range $Author := .App.Authors}}
% {{ $Author.Name }}
{{- end}}
var MarkdownDocTemplate = `% {{ .App.Name }}(8){{ if .App.Description }} {{ .App.Description }}{{ end }}
{{ range $a := .App.Authors }}
% {{ $a }}{{ end }}
# NAME
Expand Down
7 changes: 5 additions & 2 deletions testdata/expected-doc-full.man
@@ -1,7 +1,10 @@
.nh
.TH greet(8)
.TH greet(8)

.SH Harrison
.SH Harrison harrison@lolwut.com
\[la]mailto:harrison@lolwut.com\[ra]
Oliver Allen oliver@toyshop.com
\[la]mailto:oliver@toyshop.com\[ra]

.SH NAME
.PP
Expand Down
5 changes: 3 additions & 2 deletions testdata/expected-doc-full.md
@@ -1,6 +1,7 @@
% greet(8)
% greet(8)

% Harrison
% Harrison <harrison@lolwut.com>
% Oliver Allen <oliver@toyshop.com>

# NAME

Expand Down
61 changes: 61 additions & 0 deletions testdata/expected-doc-no-authors.md
@@ -0,0 +1,61 @@
% greet(8)


# NAME

greet - Some app

# SYNOPSIS

greet

```
[--another-flag|-b]
[--flag|--fl|-f]=[value]
[--socket|-s]=[value]
```

# DESCRIPTION

app [first_arg] [second_arg]

**Usage**:

```
greet [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]
```

# GLOBAL OPTIONS

**--another-flag, -b**: another usage text

**--flag, --fl, -f**="":

**--socket, -s**="": some 'usage' text (default: value)


# COMMANDS

## config, c

another usage test

**--another-flag, -b**: another usage text

**--flag, --fl, -f**="":

### sub-config, s, ss

another usage test

**--sub-command-flag, -s**: some usage text

**--sub-flag, --sub-fl, -s**="":

## info, i, in

retrieve generic information

## some-command


5 changes: 3 additions & 2 deletions testdata/expected-doc-no-commands.md
@@ -1,6 +1,7 @@
% greet(8)
% greet(8)

% Harrison
% Harrison <harrison@lolwut.com>
% Oliver Allen <oliver@toyshop.com>

# NAME

Expand Down
5 changes: 3 additions & 2 deletions testdata/expected-doc-no-flags.md
@@ -1,6 +1,7 @@
% greet(8)
% greet(8)

% Harrison
% Harrison <harrison@lolwut.com>
% Oliver Allen <oliver@toyshop.com>

# NAME

Expand Down

0 comments on commit 2a06023

Please sign in to comment.