#396 Display the tools help output on 'ide help <tool>' #434

slskiba · 2024-07-01T11:48:59Z

Resolves #396.

While initially #396 sounded like a great idea, it might be troublesome in practice. Taking for example aws, aws help prints an incredibly long list of services (380+) to use with the aws cli, cluttering the output immensly.

I therefore suggest the following solution to this issue:

printToolHelp in ToolCommandlet runs the tool with the provided help command as input. The help command is by default set to null in ToolCommandlet, so if a tool does not specify otherwise, no tool-specific help is provided.
Tools that have a help output that is desirably for IDEasy-users, can specify the help command (e.g. Github CLI, see example output below). Most likely, this will be specified as -h, --help, or help for different tools.
Tools that have no or undesirable <tool> help output can override ToolCommandlet's printToolHelp (e.g. AWS CLI, instead of printing 400+ lines of usage help, we can advise the user to use aws help for detailed usage help)

Example output for ide help aws:

ide> help aws
__       ___ ___  ___
\ \     |_ _|   \| __|__ _ ____ _
 > >     | || |) | _|/ _` (_-< || |
/_/ ___ |___|___/|___\__,_/__/\_, |
   |___|                       |__/

Current version of IDE is SNAPSHOT
Usage: ide [option]* aws [<args>*]
Tool commandlet for AWS CLI.
The AWS Command Line Interface (AWS CLI) is an open source tool for managing AWS resources. Detailed documentation can be found at https://docs.aws.amazon.com/cli/

Values:
<args>  The commandline arguments to pass to the tool.
To get detailed help about the usage of the AWS CLI, use "aws help"

Options:
--locale        the locale (e.g. '--locale=de' for German language).
-b | --batch    enable batch mode (non-interactive).
-d | --debug    enable debug logging.
-f | --force    enable force mode.
-o | --offline  enable offline mode (skip updates or git pull, fail downloads or git clone).
-q | --quiet    disable info logging (only log success, warning or error).
-t | --trace    enable trace logging.

Example output for ide help gh:

ide> help gh
__       ___ ___  ___
\ \     |_ _|   \| __|__ _ ____ _
 > >     | || |) | _|/ _` (_-< || |
/_/ ___ |___|___/|___\__,_/__/\_, |
   |___|                       |__/

Current version of IDE is SNAPSHOT
Usage: ide [option]* gh [<args>*]
Tool commandlet for GitHub CLI.
GitHub CLI (Command Line Interface) allows to interact with GitHub repositories, issues, and pull requests from the command line. Detailed documentation can be found at https://cli.github.com/manual/

Values:
<args>  The commandline arguments to pass to the tool.

Work seamlessly with GitHub from the command line.

USAGE
  gh <command> <subcommand> [flags]

CORE COMMANDS
  auth:        Authenticate gh and git with GitHub
  browse:      Open the repository in the browser
  codespace:   Connect to and manage codespaces
  gist:        Manage gists
  issue:       Manage issues
  org:         Manage organizations
  pr:          Manage pull requests
  project:     Work with GitHub Projects.
  release:     Manage releases
  repo:        Manage repositories

GITHUB ACTIONS COMMANDS
  cache:       Manage GitHub Actions caches
  run:         View details about workflow runs
  workflow:    View details about GitHub Actions workflows

ALIAS COMMANDS
  co:          Alias for "pr checkout"

ADDITIONAL COMMANDS
  alias:       Create command shortcuts
  api:         Make an authenticated GitHub API request
  attestation: Work with artifact attestations
  completion:  Generate shell completion scripts
  config:      Manage configuration for gh
  extension:   Manage gh extensions
  gpg-key:     Manage GPG keys
  label:       Manage labels
  ruleset:     View info about repo rulesets
  search:      Search for repositories, issues, and pull requests
  secret:      Manage GitHub secrets
  ssh-key:     Manage SSH keys
  status:      Print information about relevant issues, pull requests, and notifications across repositories
  variable:    Manage GitHub Actions variables

HELP TOPICS
  actions:     Learn about working with GitHub Actions
  environment: Environment variables that can be used with gh
  exit-codes:  Exit codes used by gh
  formatting:  Formatting options for JSON data exported from gh
  mintty:      Information about using gh with MinTTY
  reference:   A comprehensive reference of all gh commands

FLAGS
  --help      Show help for command
  --version   Show gh version

EXAMPLES
  $ gh issue create
  $ gh repo clone cli/cli
  $ gh pr checkout 321

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual


Options:
--locale        the locale (e.g. '--locale=de' for German language).
-b | --batch    enable batch mode (non-interactive).
-d | --debug    enable debug logging.
-f | --force    enable force mode.
-o | --offline  enable offline mode (skip updates or git pull, fail downloads or git clone).
-q | --quiet    disable info logging (only log success, warning or error).
-t | --trace    enable trace logging.

coveralls · 2024-07-01T11:52:31Z

Pull Request Test Coverage Report for Build 9743644633

Details

0 of 0 changed or added relevant lines in 0 files are covered.
11 unchanged lines in 5 files lost coverage.
Overall coverage decreased (-0.05%) to 60.283%

Files with Coverage Reduction	New Missed Lines	%
com/devonfw/tools/ide/tool/docker/Docker.java	1	4.76%
com/devonfw/tools/ide/tool/gh/Gh.java	1	66.67%
com/devonfw/tools/ide/tool/aws/Aws.java	2	5.71%
com/devonfw/tools/ide/commandlet/HelpCommandlet.java	2	93.37%
com/devonfw/tools/ide/tool/ToolCommandlet.java	5	69.93%

Totals
Change from base Build 9708861274:	-0.05%
Covered Lines:	4994
Relevant Lines:	7974

💛 - Coveralls

coveralls · 2024-07-01T11:52:54Z

Pull Request Test Coverage Report for Build 9743646050

Details

0 of 0 changed or added relevant lines in 0 files are covered.
9 unchanged lines in 5 files lost coverage.
Overall coverage decreased (-0.03%) to 60.294%

Files with Coverage Reduction	New Missed Lines	%
com/devonfw/tools/ide/tool/docker/Docker.java	1	4.76%
com/devonfw/tools/ide/tool/gh/Gh.java	1	66.67%
com/devonfw/tools/ide/tool/aws/Aws.java	2	5.71%
com/devonfw/tools/ide/commandlet/HelpCommandlet.java	2	93.37%
com/devonfw/tools/ide/tool/ToolCommandlet.java	3	70.92%

Totals
Change from base Build 9708861274:	-0.03%
Covered Lines:	4994
Relevant Lines:	7972

💛 - Coveralls

coveralls · 2024-07-02T10:22:31Z

Pull Request Test Coverage Report for Build 9759176562

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

0 of 0 changed or added relevant lines in 0 files are covered.
23 unchanged lines in 18 files lost coverage.
Overall coverage decreased (-0.02%) to 60.313%

Files with Coverage Reduction	New Missed Lines	%
com/devonfw/tools/ide/tool/terraform/Terraform.java	1	33.33%
com/devonfw/tools/ide/tool/helm/Helm.java	1	66.67%
com/devonfw/tools/ide/tool/docker/Docker.java	1	4.76%
com/devonfw/tools/ide/tool/gradle/Gradle.java	1	40.0%
com/devonfw/tools/ide/tool/gh/Gh.java	1	66.67%
com/devonfw/tools/ide/tool/dotnet/DotNet.java	1	66.67%
com/devonfw/tools/ide/tool/kotlinc/Kotlinc.java	1	66.67%
com/devonfw/tools/ide/tool/oc/Oc.java	1	66.67%
com/devonfw/tools/ide/tool/npm/Npm.java	1	95.65%
com/devonfw/tools/ide/tool/quarkus/Quarkus.java	1	66.67%

Totals
Change from base Build 9708861274:	-0.02%
Covered Lines:	4996
Relevant Lines:	7981

💛 - Coveralls

jan-vcapgemini

Thanks for your additions. Looks good to me. Can be merged as soon as my small CR's are addressed.

cli/src/main/java/com/devonfw/tools/ide/commandlet/HelpCommandlet.java

cli/src/main/java/com/devonfw/tools/ide/tool/ToolCommandlet.java

coveralls · 2024-07-03T13:17:57Z

Pull Request Test Coverage Report for Build 9778567475

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

0 of 0 changed or added relevant lines in 0 files are covered.
56 unchanged lines in 20 files lost coverage.
Overall coverage increased (+0.3%) to 60.643%

Files with Coverage Reduction	New Missed Lines	%
com/devonfw/tools/ide/tool/terraform/Terraform.java	1	33.33%
com/devonfw/tools/ide/tool/helm/Helm.java	1	66.67%
com/devonfw/tools/ide/tool/docker/Docker.java	1	4.76%
com/devonfw/tools/ide/tool/gradle/Gradle.java	1	40.0%
com/devonfw/tools/ide/tool/gh/Gh.java	1	66.67%
com/devonfw/tools/ide/tool/dotnet/DotNet.java	1	66.67%
com/devonfw/tools/ide/tool/kotlinc/Kotlinc.java	1	66.67%
com/devonfw/tools/ide/tool/oc/Oc.java	1	66.67%
com/devonfw/tools/ide/tool/npm/Npm.java	1	95.65%
com/devonfw/tools/ide/tool/quarkus/Quarkus.java	1	66.67%

Totals
Change from base Build 9708861274:	0.3%
Covered Lines:	5147
Relevant Lines:	8177

💛 - Coveralls

jan-vcapgemini · 2024-07-04T10:45:30Z

If possible, please add a simple test to increase the test coverage here too. Just a check for a tool starting its simulated help command if it was found should suffice I guess.

hohwille

@slskiba thanks for your PR. Well done - your solution looks good to me. 👍
I left a review comment for design improvement. Please have a look. Then we can merge.

cli/src/main/java/com/devonfw/tools/ide/commandlet/HelpCommandlet.java

hohwille

@slskiba thanks. Ready for merge now 👍

coveralls · 2024-07-05T13:15:10Z

Pull Request Test Coverage Report for Build 9808878877

Details

0 of 0 changed or added relevant lines in 0 files are covered.
68 unchanged lines in 19 files lost coverage.
Overall coverage decreased (-0.04%) to 61.755%

Files with Coverage Reduction	New Missed Lines	%
com/devonfw/tools/ide/tool/terraform/Terraform.java	1	33.33%
com/devonfw/tools/ide/tool/helm/Helm.java	1	66.67%
com/devonfw/tools/ide/tool/docker/Docker.java	1	4.76%
com/devonfw/tools/ide/tool/gradle/Gradle.java	1	80.0%
com/devonfw/tools/ide/tool/gh/Gh.java	1	66.67%
com/devonfw/tools/ide/tool/dotnet/DotNet.java	1	66.67%
com/devonfw/tools/ide/tool/kotlinc/Kotlinc.java	1	66.67%
com/devonfw/tools/ide/tool/oc/Oc.java	1	66.67%
com/devonfw/tools/ide/tool/npm/Npm.java	1	95.65%
com/devonfw/tools/ide/tool/quarkus/Quarkus.java	1	66.67%

Totals
Change from base Build 9808498015:	-0.04%
Covered Lines:	5276
Relevant Lines:	8226

💛 - Coveralls

jan-vcapgemini

Looks good.

cli/src/main/java/com/devonfw/tools/ide/commandlet/HelpCommandlet.java

cli/src/main/java/com/devonfw/tools/ide/tool/ToolCommandlet.java

slskiba added 2 commits July 1, 2024 13:10

Run tool help on 'help <tool>'

c5e9187

Simplify check to print help

02cba2d

slskiba self-assigned this Jul 1, 2024

slskiba added 2 commits July 2, 2024 12:16

Add tool specific help commands

11b9642

Add space before tool help

7e55b11

slskiba changed the title ~~#396 WIP: Display the tools help output on 'ide help <tool>'~~ #396 Display the tools help output on 'ide help <tool>' Jul 2, 2024

slskiba marked this pull request as ready for review July 2, 2024 10:24

jan-vcapgemini requested changes Jul 3, 2024

View reviewed changes

Add javadoc

9b42410

mvomiero assigned hohwille Jul 4, 2024

hohwille approved these changes Jul 5, 2024

View reviewed changes

cli/src/main/java/com/devonfw/tools/ide/commandlet/HelpCommandlet.java Outdated Show resolved Hide resolved

hohwille added help help/usage output CLI IDEasy command-line-interface (parsing args, etc.) labels Jul 5, 2024

hohwille added this to the release:2024.07.001 milestone Jul 5, 2024

slskiba added 2 commits July 5, 2024 10:28

Address review comments

b85ae55

Keep bundle as parameter in printHelp

871546f

hohwille approved these changes Jul 5, 2024

View reviewed changes

Merge branch 'main' into feature/396-tool-usage-help

001858c

jan-vcapgemini approved these changes Jul 5, 2024

View reviewed changes

cli/src/main/java/com/devonfw/tools/ide/commandlet/HelpCommandlet.java Outdated Show resolved Hide resolved

cli/src/main/java/com/devonfw/tools/ide/tool/ToolCommandlet.java Outdated Show resolved Hide resolved

hohwille merged commit 02b24d3 into devonfw:main Jul 5, 2024
4 checks passed

jan-vcapgemini added the reviewed Marks PRs that have been presented in the sprint-review meeting or that do not need to be presented. label Jul 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#396 Display the tools help output on 'ide help <tool>' #434

#396 Display the tools help output on 'ide help <tool>' #434

slskiba commented Jul 1, 2024 •

edited

Loading

coveralls commented Jul 1, 2024 •

edited

Loading

coveralls commented Jul 1, 2024 •

edited

Loading

coveralls commented Jul 2, 2024 •

edited

Loading

jan-vcapgemini left a comment

coveralls commented Jul 3, 2024 •

edited

Loading

jan-vcapgemini commented Jul 4, 2024

hohwille left a comment

hohwille left a comment

coveralls commented Jul 5, 2024 •

edited

Loading

jan-vcapgemini left a comment

#396 Display the tools help output on 'ide help <tool>' #434

#396 Display the tools help output on 'ide help <tool>' #434

Conversation

slskiba commented Jul 1, 2024 • edited Loading

coveralls commented Jul 1, 2024 • edited Loading

Pull Request Test Coverage Report for Build 9743644633

Details

💛 - Coveralls

coveralls commented Jul 1, 2024 • edited Loading

Pull Request Test Coverage Report for Build 9743646050

Details

💛 - Coveralls

coveralls commented Jul 2, 2024 • edited Loading

Pull Request Test Coverage Report for Build 9759176562

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

jan-vcapgemini left a comment

Choose a reason for hiding this comment

coveralls commented Jul 3, 2024 • edited Loading

Pull Request Test Coverage Report for Build 9778567475

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

jan-vcapgemini commented Jul 4, 2024

hohwille left a comment

Choose a reason for hiding this comment

hohwille left a comment

Choose a reason for hiding this comment

coveralls commented Jul 5, 2024 • edited Loading

Pull Request Test Coverage Report for Build 9808878877

Details

💛 - Coveralls

jan-vcapgemini left a comment

Choose a reason for hiding this comment

slskiba commented Jul 1, 2024 •

edited

Loading

coveralls commented Jul 1, 2024 •

edited

Loading

coveralls commented Jul 1, 2024 •

edited

Loading

coveralls commented Jul 2, 2024 •

edited

Loading

coveralls commented Jul 3, 2024 •

edited

Loading

coveralls commented Jul 5, 2024 •

edited

Loading