Skip to content

Fix duplicate options showing up in command help output #68

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
merged 1 commit into from
Mar 6, 2020
Merged

Fix duplicate options showing up in command help output #68

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
17 changes: 11 additions & 6 deletions Sources/ArgumentParser/Usage/HelpGenerator.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ internal struct HelpGenerator {
}

struct Section {
struct Element {
struct Element: Hashable {
var label: String
var abstract: String = ""
var discussion: String = ""
Expand Down Expand Up @@ -125,7 +125,9 @@ internal struct HelpGenerator {
static func generateSections(commandStack: [ParsableCommand.Type]) -> [Section] {
var positionalElements: [Section.Element] = []
var optionElements: [Section.Element] = []

/// Used to keep track of elements already seen from parent commands.
var alreadySeenElements = Set<Section.Element>()

for commandType in commandStack {
let args = Array(ArgumentSet(commandType))

Expand Down Expand Up @@ -158,10 +160,13 @@ internal struct HelpGenerator {
}

let element = Section.Element(label: synopsis, abstract: description, discussion: arg.help.help?.discussion ?? "")
if case .positional = arg.kind {
positionalElements.append(element)
} else {
optionElements.append(element)
if !alreadySeenElements.contains(element) {
alreadySeenElements.insert(element)
if case .positional = arg.kind {
positionalElements.append(element)
} else {
optionElements.append(element)
}
}
}
}
Expand Down
2 changes: 0 additions & 2 deletions Tests/EndToEndTests/SubcommandEndToEndTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@ extension SubcommandEndToEndTests {
USAGE: foo a --name <name> --bar <bar>

OPTIONS:
--name <name>
--name <name>
--bar <bar>
-h, --help Show help information.
Expand All @@ -96,7 +95,6 @@ extension SubcommandEndToEndTests {
USAGE: foo b --name <name> --baz <baz>

OPTIONS:
--name <name>
--name <name>
--baz <baz>
-h, --help Show help information.
Expand Down