Reenable testUsage() as testInvalidUsage() #8014
Conversation
I believe its expected for the argument `-halp` to show the help string in swift-argument-parser, as if there is a `-h` or `--help` anywhere in the arguments all other inputs are disregarded and the help string is shown. Instead use an invalid argument to drive the test and reenable it.
plemarquand
requested review from
bnbarham,
MaxDesiatov,
jakepetroules,
francescomikulis,
xedin,
dschaefer2,
shawnhyam,
bripeticca and
owenv
as code owners
|
@swift-ci test |
| @@ -48,10 +48,9 @@ final class PackageCommandTests: CommandsTestCase { | |||
| XCTAssertMatch(stdout, .contains("USAGE: swift package")) | |||
| } | |||
|
|
|||
| func testUsage() async throws { | |||
| throw XCTSkip("rdar://131126477") | |||
There was a problem hiding this comment.
Do we have this radar resolved then? I find it confusing that any option that starts with -h leads to this unexpected behavior. We should at least raise this on the SAP repo for them to resolve this first, especially as this is a regression from Swift Argument Parser 1.2.2.
There was a problem hiding this comment.
I think this is works as intended, but maybe @natecook1000 can chime in. If any argument resolves to a help flag it takes precedence and shows the help string.
Swift Argument Parser respects combined flags, so -halp is equivalent to -h -a -l -p. Short flags can be combined, and short flags must also be only one character, so -halp isn’t a valid as a single flag. Only short flags can be combined, so —help-foo won’t match —help.
There was a problem hiding this comment.
I'm surprised that's the default, given that both swiftc and clang stick to single dash options, and thus clang -fblocks is clearly not equivalent to clang -f -b -l -o -c -k -s.
There was a problem hiding this comment.
swiftc and clang also use options with -long-name so I wouldn't take them as amazing prior art. arg parser follows the pattern of ls -asl and git clean -Xdf where short names are combined.
There was a problem hiding this comment.
My experience with this type of combined syntax is as a POSIX convention. See 12.2, Guideline #5 in the POSIX Utility Conventions.
There was a problem hiding this comment.
@MaxDesiatov @rauhul Any lingering concerns with this PR/behaviour?
|
@swift-ci test |
1 similar comment
|
@swift-ci test |
I believe its expected for the argument
-halpto show the help string in swift-argument-parser, as if there is a-hor--helpanywhere in the arguments all other inputs are disregarded and the help string is shown.Instead use an invalid argument to drive the test and reenable it.
Some lines in this file used tabs instead of spaces, so the diff is a bit nosier than it should be.