Skip to content

Prioritize defaultText over value in docs #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Prioritize defaultText over value in docs #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
16423c2
prioritize default text
joshuaswickirl Apr 10, 2025
90e5d23
init tests
joshuaswickirl Apr 10, 2025
bdc82a0
more tests
joshuaswickirl Apr 11, 2025
a376063
use different default
joshuaswickirl Apr 11, 2025
69089c2
use DocGenerationFlag.GetDefaultText
joshuaswickirl Apr 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 1 addition & 22 deletions docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import (
"fmt"
"io"
"os"
"reflect"
"regexp"
"runtime"
"sort"
Expand Down Expand Up @@ -564,25 +563,5 @@ func getFlagDefaultValue(f cli.DocGenerationFlag) string {
if !f.TakesValue() {
return ""
}

if v, ok := f.(interface{ GetValue() string }); ok {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joshuaswickirl i'm having a hard time wrapping my head around this. You say that DocGenerationFlag has removed GetValue ?? It's still there. So I'm confused why we need all this in the first place. Moreover there is no need to use reflection here. You should be able to use be existing functions to achieve the desired result

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

urfave/cli#1988 (comment)

Copy link
Author

@joshuaswickirl joshuaswickirl Apr 29, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thanks for your response.

I went to use the DocGenerationFlag.GetDefaultText but the response is different between Value and DefaultText. The string response for value is unquoted and for default text is unquoted. I'd assume that you would want the behavior to be the same between Value and DefaultText, if the value is the exact same string.

It seems like the interface implementation is inconsistent but I haven't confirmed.

I'll push up the current state. I appreciate your time.

func buildExtendedTestCommand() *cli.Command {
	return &cli.Command{
		Writer: io.Discard,
		Name:   "greet",
		Flags: []cli.Flag{
			&cli.StringFlag{
				Name:        "socket",
				Aliases:     []string{"s"},
				Usage:       "some 'usage' text",
				Value:       "value",
				// DefaultText: "value", <-- tests fail if this doesn't exit.
				TakesFile:   true,
			},
...

return v.GetValue()
}

var ref = reflect.ValueOf(f)
if ref.Kind() != reflect.Ptr {
return ""
} else {
ref = ref.Elem()
}

if ref.Kind() != reflect.Struct {
return ""
}

if val := ref.FieldByName("Value"); val.IsValid() && val.Type().Kind() != reflect.Bool {
return fmt.Sprintf("%v", val.Interface())
}

return ""
return f.GetDefaultText()
}
23 changes: 17 additions & 6 deletions docs_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ func expectFileContent(t *testing.T, file, got string) {
r := require.New(t)
r.NoError(err)
r.Equal(
string(normalizeNewlines([]byte(got))),
string(normalizeNewlines(data)),
string(normalizeNewlines([]byte(got))),
)
}

Expand All @@ -45,11 +45,12 @@ func buildExtendedTestCommand() *cli.Command {
Name: "greet",
Flags: []cli.Flag{
&cli.StringFlag{
Name: "socket",
Aliases: []string{"s"},
Usage: "some 'usage' text",
Value: "value",
TakesFile: true,
Name: "socket",
Aliases: []string{"s"},
Usage: "some 'usage' text",
Value: "value",
DefaultText: "value",
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#9 (comment)

TakesFile: true,
},
&cli.StringFlag{Name: "flag", Aliases: []string{"fl", "f"}},
&cli.BoolFlag{
Expand All @@ -62,6 +63,11 @@ func buildExtendedTestCommand() *cli.Command {
Name: "hidden-flag",
Hidden: true,
},
&cli.StringFlag{
Name: "dir",
Value: pwd(),
DefaultText: ".",
},
Comment on lines +66 to +70
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to be able to overwrite the default value with default text. In my example here the pwd() is called at build so it'd show my actual $PWD and that wouldn't make sense in the docs.

},
Commands: []*cli.Command{{
Aliases: []string{"c"},
Expand Down Expand Up @@ -182,6 +188,11 @@ func TestToTabularMarkdown(t *testing.T) {
})
}

func pwd() string {
pwd, _ := os.Getwd()
return pwd
}

func TestToTabularMarkdownFailed(t *testing.T) {
tpl := MarkdownTabularDocTemplate
t.Cleanup(func() { MarkdownTabularDocTemplate = tpl })
Expand Down
4 changes: 4 additions & 0 deletions testdata/expected-doc-full.man
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ greet

.nf
[--another-flag|-b]
[--dir]=[value]
[--flag|--fl|-f]=[value]
[--socket|-s]=[value]

Expand Down Expand Up @@ -43,6 +44,9 @@ app [first_arg] [second_arg]
.PP
\fB--another-flag, -b\fP: another usage text

.PP
\fB--dir\fP="": (default: .)

.PP
\fB--flag, --fl, -f\fP="":

Expand Down
3 changes: 3 additions & 0 deletions testdata/expected-doc-full.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ greet

```
[--another-flag|-b]
[--dir]=[value]
[--flag|--fl|-f]=[value]
[--socket|-s]=[value]
```
Expand All @@ -26,6 +27,8 @@ app [first_arg] [second_arg]

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

**--dir**="": (default: .)

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

**--socket, -s**="": some 'usage' text (default: value)
Expand Down
3 changes: 3 additions & 0 deletions testdata/expected-doc-no-authors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ greet

```
[--another-flag|-b]
[--dir]=[value]
[--flag|--fl|-f]=[value]
[--socket|-s]=[value]
```
Expand All @@ -26,6 +27,8 @@ app [first_arg] [second_arg]

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

**--dir**="": (default: .)

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

**--socket, -s**="": some 'usage' text (default: value)
Expand Down
3 changes: 3 additions & 0 deletions testdata/expected-doc-no-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ greet

```
[--another-flag|-b]
[--dir]=[value]
[--flag|--fl|-f]=[value]
[--socket|-s]=[value]
```
Expand All @@ -26,6 +27,8 @@ app [first_arg] [second_arg]

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

**--dir**="": (default: .)

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

**--socket, -s**="": some 'usage' text (default: value)
Expand Down
3 changes: 3 additions & 0 deletions testdata/expected-doc-no-usagetext.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ greet

```
[--another-flag|-b]
[--dir]=[value]
[--flag|--fl|-f]=[value]
[--socket|-s]=[value]
```
Expand All @@ -26,6 +27,8 @@ greet [GLOBAL OPTIONS] [command [COMMAND OPTIONS]] [ARGUMENTS...]

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

**--dir**="": (default: .)

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

**--socket, -s**="": some 'usage' text (default: value)
Expand Down
1 change: 1 addition & 0 deletions testdata/expected-tabular-markdown-custom-app-path.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Global flags:
| `--socket="…"` (`-s`) | some 'usage' text | `value` | *none* |
| `--flag="…"` (`--fl`, `-f`) | | | *none* |
| `--another-flag` (`-b`) | another usage text | `false` | `EXAMPLE_VARIABLE_NAME` |
| `--dir="…"` | | `.` | *none* |

### `config` command (aliases: `c`)

Expand Down
1 change: 1 addition & 0 deletions testdata/expected-tabular-markdown-full.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Global flags:
| `--socket="…"` (`-s`) | some 'usage' text | `value` | *none* |
| `--flag="…"` (`--fl`, `-f`) | | | *none* |
| `--another-flag` (`-b`) | another usage text | `false` | `EXAMPLE_VARIABLE_NAME` |
| `--dir="…"` | | `.` | *none* |

### `config` command (aliases: `c`)

Expand Down