Bash completion for flags

[mabelzhang]

🎉 New feature

Part of gazebosim/gz-tools#1
Used together with gazebosim/gz-tools#87

Summary

Bash completion script for flags available to this subcommand.
This is a standalone function that depends on a new script in gazebosim/gz-tools#87 to call this.

Test it

After sourcing the dependent script in ign-tools, source the script in this PR:

. src/cmd/gui.bash_completion.sh

If you just tab, you get the default system tab-completion that shows the files in the current directory:

$ ign gui <tab>

If you type -, and then tab, you get the tab-completion for all the flags available for this subcommand:

$ ign gui -<tab>
--config         --help           --standalone     --versions       -h               -s               
--force-version  --list           --verbose        -c               -l               -v               

Then you can type partial flags, and it'll do tab-completion normally for you, such as

$ ign gui --ver
--verbose   --versions  

It also works for multiple flags, like ign gui --<flag1> --<flag2> ...

Checklist

• Signed all commits for DCO
• Added tests
• Added example and/or tutorial
• Updated documentation (as needed)
• Updated migration guide (as needed)
• Consider updating Python bindings (if the library has them)
• codecheck passed (See contributing)
• All tests passed (See test coverage)
• While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

[codecov]

Codecov Report

Merging #392 (8c634be) into ign-gui3 (aafacbf) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           ign-gui3     #392   +/-   ##
=========================================
  Coverage     31.12%   31.12%           
=========================================
  Files            29       29           
  Lines          1343     1343           
=========================================
  Hits            418      418           
  Misses          925      925           

---

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 aafacbf...8c634be. Read the comment docs.

[chapulina]

Same comments as in plugin, let's use gz wherever we can, and see if it's possible to write a test that checks that the flags are the same on the autocomplete file and the command itself.

[codecov]

Codecov Report

Merging #392 (2866b7a) into ign-gui3 (e3cf225) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           ign-gui3     #392   +/-   ##
=========================================
  Coverage     65.45%   65.45%           
=========================================
  Files            29       29           
  Lines          3216     3216           
=========================================
  Hits           2105     2105           
  Misses         1111     1111           

---

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 e3cf225...2866b7a. Read the comment docs.

[mabelzhang]

I think the comments are addressed. Ready for another pass.

[chapulina]

Thanks for iterating! It's working for me after I source:

. install/share/gz/gz1.completion

[chapulina]

Fixed the tests in 2866b7a, inspired by gazebosim/gz-plugin#57

[Blast545]

@mabelzhang This PR introduced a regression in the Gazebo Citadel Windows buildfarm, see:
ign_gui-ign-3-win#93/testReport/junit/(root)/ignTest/GuiHelpVsCompletionFlags/

C:\Jenkins\workspace\ign_gui-ign-3-win\ws\ign-gui\src\ign_TEST.cc:131
Expected: (std::string::npos) != (helpOutput.find(flag)), actual: 18446744073709551615 vs 18446744073709551615
'HAVE_IGN_TOOLS-NOTFOUND' is not recognized as an internal or external command,
operable program or batch file.

Would you please take a look? It seems like an extra environment variable has to be set on Windows to get the proper output from the command line on that test.

[chapulina]

This PR introduced a regression in the Gazebo Citadel Windows

Ah sorry that's on me, I totally missed the failing Windows test. On it.