Add HideHelpCommand #1083

AkihiroSuda · 2020-03-05T07:21:33Z

What type of PR is this?

feature

What this PR does / why we need it:

While HideHelp hides both help command and --help flag, HideHelpCommand
only hides help command and leave --help flag as-is.

The behavior of HideHelp is untouched in this commit.

Which issue(s) this PR fixes:

Fixes #523
Replaces #636

Testing

go test -v -run TestHideHelpCommand

Release Notes

Added `HideHelpCommand`. While `HideHelp` hides both `help` command and `--help` flag, `HideHelpCommand` only hides `help` command and leave `--help` flag as-is.

codecov · 2020-03-05T07:22:30Z

Codecov Report

Merging #1083 into master will increase coverage by 0.27%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #1083      +/-   ##
==========================================
+ Coverage   72.91%   73.18%   +0.27%     
==========================================
  Files          33       33              
  Lines        2481     2480       -1     
==========================================
+ Hits         1809     1815       +6     
+ Misses        565      559       -6     
+ Partials      107      106       -1

Impacted Files	Coverage Δ
flag.go	`86.39% <ø> (+0.16%)`	⬆️
app.go	`81.22% <100%> (+2.5%)`	⬆️
command.go	`82.83% <100%> (+0.12%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1b7e4e0...75e7c52. Read the comment docs.

AkihiroSuda · 2020-03-05T07:39:08Z

Any chance to get v2.2.0 released soon with this?

rliebz

Looks good, thanks for pulling this together.

I think the only thing left is getting the coverage check passing.

app.go


        Add HideHelpCommand

While `HideHelp` hides both `help` command and `--help` flag, `HideHelpCommand` only hides `help` command and leave `--help` flag as-is. The behavior of `HideHelp` is untouched in this commit. Fix #523 Replace #636 Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>

lynncyrin · 2020-03-06T07:56:38Z

app.go

-	// append help to commands
-	if len(a.Commands) > 0 {
-		if a.Command(helpCommand.Name) == nil && !a.HideHelp {
-			a.appendCommand(helpCommand)
-
-			if HelpFlag != nil {
-				a.appendFlag(HelpFlag)
-			}
-		}
-	}


❓ (blocking question) this code is being removed because it was duplicated in Setup above, yeah?

Yes, and because of the duplication, this code path was not executed and could not be covered with tests: #1083 (comment)

lynncyrin · 2020-03-06T08:01:40Z

Any chance to get v2.2.0 released soon with this?

I can write up the release notes this weekend probs

AkihiroSuda requested a review from urfave/cli as a code owner Mar 5, 2020

This was referenced Mar 5, 2020

Don't want any commands in the CLI interface (including help) #523

Closed

Add HelpFlag as part of VisibleFlags. #636

Closed

AkihiroSuda force-pushed the AkihiroSuda:hide-help-command branch 2 times, most recently from 2426f97 to 3e5678c Mar 5, 2020

rliebz reviewed Mar 5, 2020

View changes

app.go Outdated Show resolved Hide resolved

AkihiroSuda force-pushed the AkihiroSuda:hide-help-command branch 4 times, most recently from 4604362 to 2129edf Mar 5, 2020

AkihiroSuda force-pushed the AkihiroSuda:hide-help-command branch from 2129edf to 75e7c52 Mar 6, 2020

lynncyrin requested changes Mar 6, 2020

View changes

lynncyrin approved these changes Mar 6, 2020

View changes

lynncyrin requested a review from rliebz Mar 6, 2020

rliebz approved these changes Mar 6, 2020

View changes

lynncyrin mentioned this pull request Mar 9, 2020

Release 2.2.0 #1084

Merged

urfave / cli

Add HideHelpCommand #1083

Add HideHelpCommand #1083

AkihiroSuda commented Mar 5, 2020 •

edited

codecov bot commented Mar 5, 2020 •

edited

AkihiroSuda commented Mar 5, 2020

rliebz left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

lynncyrin commented Mar 6, 2020

urfave / cli

Join GitHub today

Add HideHelpCommand #1083

Add HideHelpCommand #1083

Conversation

AkihiroSuda commented Mar 5, 2020 • edited

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Testing

Release Notes

codecov bot commented Mar 5, 2020 • edited

Codecov Report

AkihiroSuda commented Mar 5, 2020

rliebz left a comment

This comment has been minimized.

lynncyrin Mar 6, 2020 Member

This comment has been minimized.

AkihiroSuda Mar 6, 2020 Author Contributor

This comment has been minimized.

lynncyrin Mar 6, 2020 Member

lynncyrin commented Mar 6, 2020

AkihiroSuda commented Mar 5, 2020 •

edited

codecov bot commented Mar 5, 2020 •

edited