Skip to content

format with gofumpt -w . #18

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

Merged
dearchap merged 1 commit into from
Oct 20, 2025
Merged

format with gofumpt -w . #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 12 additions & 12 deletions docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ func ToTabularMarkdown(cmd *cli.Command, appPath string) (string, error) {
// ToTabularToFileBetweenTags creates a tabular markdown documentation for the `*App` and updates the file between
// the tags in the file. The function errors if either parsing or writing of the string fails.
func ToTabularToFileBetweenTags(cmd *cli.Command, appPath, filePath string, startEndTags ...string) error {
var start, end = "<!--GENERATED:CLI_DOCS-->", "<!--/GENERATED:CLI_DOCS-->" // default tags
start, end := "<!--GENERATED:CLI_DOCS-->", "<!--/GENERATED:CLI_DOCS-->" // default tags

if len(startEndTags) == 2 {
start, end = startEndTags[0], startEndTags[1]
Expand Down Expand Up @@ -128,7 +128,7 @@ func ToTabularToFileBetweenTags(cmd *cli.Command, appPath, filePath string, star
updated := re.ReplaceAll(content, []byte(strings.Join([]string{start, comment, md, end}, "\n")))

// write updated content to file
if err = os.WriteFile(filePath, updated, 0664); err != nil {
if err = os.WriteFile(filePath, updated, 0o664); err != nil {
return err
}

Expand Down Expand Up @@ -364,10 +364,10 @@ type tabularTemplate struct{}

// PrepareCommands converts CLI commands into a structs for the rendering.
func (tt tabularTemplate) PrepareCommands(commands []*cli.Command, appPath, parentCommandName string, level uint) []cliTabularCommandTemplate {
var result = make([]cliTabularCommandTemplate, 0, len(commands))
result := make([]cliTabularCommandTemplate, 0, len(commands))

for _, cmd := range commands {
var command = cliTabularCommandTemplate{
command := cliTabularCommandTemplate{
AppPath: appPath,
Name: strings.TrimSpace(strings.Join([]string{parentCommandName, cmd.Name}, " ")),
Aliases: cmd.Aliases,
Expand All @@ -394,15 +394,15 @@ func (tt tabularTemplate) PrepareCommands(commands []*cli.Command, appPath, pare

// PrepareFlags converts CLI flags into a structs for the rendering.
func (tt tabularTemplate) PrepareFlags(flags []cli.Flag) []cliTabularFlagTemplate {
var result = make([]cliTabularFlagTemplate, 0, len(flags))
result := make([]cliTabularFlagTemplate, 0, len(flags))

for _, appFlag := range flags {
flag, ok := appFlag.(cli.DocGenerationFlag)
if !ok {
continue
}

var f = cliTabularFlagTemplate{
f := cliTabularFlagTemplate{
Usage: tt.PrepareMultilineString(flag.GetUsage()),
EnvVars: flag.GetEnvVars(),
TakesValue: flag.TakesValue(),
Expand Down Expand Up @@ -449,7 +449,7 @@ func (tabularTemplate) PrepareMultilineString(s string) string {
}

func (tabularTemplate) Prettify(s string) string {
var max = func(x, y int) int {
max := func(x, y int) int {
if x > y {
return x
}
Expand All @@ -460,14 +460,14 @@ func (tabularTemplate) Prettify(s string) string {

// search for tables
for _, rawTable := range regexp.MustCompile(`(?m)^(\|[^\n]+\|\r?\n)((?:\|:?-+:?)+\|)(\n(?:\|[^\n]+\|\r?\n?)*)?$`).FindAllString(s, -1) {
var lines = strings.FieldsFunc(rawTable, func(r rune) bool { return r == '\n' })
lines := strings.FieldsFunc(rawTable, func(r rune) bool { return r == '\n' })

if len(lines) < 3 { // header, separator, body
continue
}

// parse table into the matrix
var matrix = make([][]string, 0, len(lines))
matrix := make([][]string, 0, len(lines))
for _, line := range lines {
items := strings.FieldsFunc(strings.Trim(line, "| "), func(r rune) bool { return r == '|' })

Expand All @@ -479,13 +479,13 @@ func (tabularTemplate) Prettify(s string) string {
}

// determine centered columns
var centered = make([]bool, 0, len(matrix[1]))
centered := make([]bool, 0, len(matrix[1]))
for _, cell := range matrix[1] {
centered = append(centered, strings.HasPrefix(cell, ":") && strings.HasSuffix(cell, ":"))
}

// calculate max lengths
var lengths = make([]int, len(matrix[0]))
lengths := make([]int, len(matrix[0]))
for n, row := range matrix {
for i, cell := range row {
if n == 1 {
Expand Down Expand Up @@ -571,7 +571,7 @@ func getFlagDefaultValue(f cli.DocGenerationFlag) string {
return v.GetValue()
}

var ref = reflect.ValueOf(f)
ref := reflect.ValueOf(f)
if ref.Kind() != reflect.Ptr {
return ""
} else {
Expand Down
6 changes: 2 additions & 4 deletions docs_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,8 @@ import (
"github.com/urfave/cli/v3"
)

var (
//go:embed testdata
testdata embed.FS
)
//go:embed testdata
var testdata embed.FS

func expectFileContent(t *testing.T, file, got string) {
data, err := testdata.ReadFile(file)
Expand Down
Loading