Skip to content

Provide shell completion for cz #305

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.

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

Conversation

danvergara
Copy link
Contributor

Description

As mentioned in #137 , this PR add auto-completion to cz using argcomplete

Checklist

  • Add test cases to all the changes you introduce
  • Run ./script/format and ./script/test locally to ensure this change passes linter check and test
  • Test the changes on the local machine manually
  • Update the documentation for the changes

Expected behavior

If the proper activation is set, the auto-completion can performed just by pressing the
tab key.

Steps to Test This Pull Request

  1. Run the tests
  2. Activate the virtual environment provided by the project/Poetry
  3. Activate the auto-completion. For one-time activation of argcomplete for Commitizen only, use:
    $ eval "$(register-python-argcomplete cz)"
  4. Type incomplete commands and flags from Commitizen and just pres the tab key.

Additional context

Related to #137

@danvergara danvergara force-pushed the provide-shell-completion-for-cz branch from 47d935a to 61c13e4 Compare November 14, 2020 22:11
@codecov
Copy link

codecov bot commented Nov 14, 2020

Codecov Report

Merging #305 (61c13e4) into master (720befe) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #305   +/-   ##
=======================================
  Coverage   96.96%   96.97%           
=======================================
  Files          33       33           
  Lines         924      926    +2     
=======================================
+ Hits          896      898    +2     
  Misses         28       28           
Flag Coverage Δ
unittests 96.97% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
commitizen/__version__.py 100.00% <100.00%> (ø)
commitizen/cli.py 97.50% <100.00%> (+0.13%) ⬆️

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 de44a0a...61c13e4. Read the comment docs.

Copy link
Member

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one looks good to me. I also tested it locally and it works. @woile Could you please check this one? Thanks 🙂

@woile woile merged commit 87b39d4 into commitizen-tools:master Dec 2, 2020
@woile
Copy link
Member

woile commented Dec 2, 2020

Thanks a lot!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants