Thanks to visit codestin.com
Credit goes to github.com

Skip to content

nestplus: restore nest:+ functionality to cli #1580

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
kkoreilly merged 8 commits into from
Jul 15, 2025
Merged

nestplus: restore nest:+ functionality to cli #1580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a134929
nestplus: restore nest:+ functionality to cli
rcoreilly Jul 14, 2025
3c21619
Merge branch 'main' into nestplus
kkoreilly Jul 15, 2025
e950228
cli: print error when name conflicts with itself
kkoreilly Jul 15, 2025
c200c8c
cli: add TestNestedConfig
kkoreilly Jul 15, 2025
256b03b
cli: remove old false and true versions of nest
kkoreilly Jul 15, 2025
4431d30
cli.applyShortestUniqueName: if this entry is the shortest unique nam…
kkoreilly Jul 15, 2025
eaded34
cli: fix nest+ behavior by using slices.Delete appropriately
kkoreilly Jul 15, 2025
e03dd94
cli: remove error message for name conflicting with itself, since it …
kkoreilly Jul 15, 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
28 changes: 28 additions & 0 deletions cli/cli_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,3 +378,31 @@ func TestConfigOpen(t *testing.T) {
t.Error(err)
}
}

type testRootConfig struct {
Run testRunConfig
}

type testRunConfig struct {
Run int
Debug bool `nest:"+"`
Log bool
}

func TestNestedConfig(t *testing.T) {
cfg := &testRootConfig{}
fs := &fields{}
addFields(cfg, fs, "")

expected := [][]string{
{"Run.Run"},
{"Run.Debug"},
{"Log", "Run.Log"},
{"Run"},
}

for i, kv := range fs.Order {
field := kv.Value
assert.Equal(t, expected[i], field.Names, "index=%d", i)
}
}
24 changes: 17 additions & 7 deletions cli/field.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,8 @@ func addFieldsImpl(obj any, path string, cmdPath string, allFields *fields, used
ofns := of.Field.Tag.Get("nest")

// whether new and other get to have non-nested version
nfn := nfns == "-" || nfns == "false"
ofn := ofns == "-" || ofns == "false"
nfn := nfns == "-"
ofn := ofns == "-"

if nfn && ofn {
slog.Error(`programmer error: cli: nest:"-" specified on two config fields with the same name; keep nest:"-" on the field you want to be able to access without nesting and remove it from the other one`, "name", name, "field0", of.Name, "field1", nf.Name, "exampleFlagWithoutNesting", "-"+name, "exampleFlagWithNesting", "-"+strcase.ToKebab(nf.Name))
Expand All @@ -193,8 +193,14 @@ func addFieldsImpl(obj any, path string, cmdPath string, allFields *fields, used
applyShortestUniqueName(nf, i, usedNames)
}
} else {
// if no conflict, we get the name
usedNames[name] = nf
// if no conflict, we get the name, unless we are forcing
// nesting, in which case we only get it if it is our full name
nfns := nf.Field.Tag.Get("nest")
if nfns == "+" && name != nf.Name {
nf.Names = slices.Delete(nf.Names, i, i+1) // TODO: is it safe to delete while iterating like this?
} else {
usedNames[name] = nf
}
}
}
allFields.Add(name, nf)
Expand All @@ -206,8 +212,9 @@ func addFieldsImpl(obj any, path string, cmdPath string, allFields *fields, used
// used names, at the given index.
func applyShortestUniqueName(field *field, idx int, usedNames map[string]*field) {
nm := shortestUniqueName(field.Name, usedNames)
// if we already have this name, we don't need to add it, so we just delete this entry
if slices.Contains(field.Names, nm) {
// if we already have this name, we don't need to add it, so we just delete
// this entry (unless this entry is the shortest unique name)
if slices.Contains(field.Names, nm) && field.Names[idx] != nm {
field.Names = slices.Delete(field.Names, idx, idx+1)
} else {
field.Names[idx] = nm
Expand All @@ -232,5 +239,8 @@ func shortestUniqueName(name string, usedNames map[string]*field) string {
return cur
}
}
return cur // TODO: this should never happen, but if it does, we might want to print an error
// It is actually expected for this to happen, for example, when there is
// a Run struct with a Run field inside it (see TestNestedConfig).
// errors.Log(fmt.Errorf("cli: unexpected error: name %q conflicts with itself", name))
return cur
}
Loading