search

iterative / shtab

↔️ Automagic shell tab completion for Python CLI applications
https://docs.iterative.ai/shtab
Other
363 stars 35 forks source link

Fix colons in subcommands #110

Closed brentyi closed 1 year ago

brentyi commented 1 year ago

Subcommands like hello:world were formerly not being escaped properly.

sourcery-ai[bot] commented 1 year ago

Sourcery Code Quality Report

✅  Merging this PR will increase code quality in the affected files by 1.07%.

Quality metrics Before After Change
Complexity 29.64 😞 28.85 😞 -0.79 👍
Method Length 100.90 🙂 100.37 🙂 -0.53 👍
Working memory 3.58 ⭐ 3.61 ⭐ 0.03 👎
Quality 45.09% 😞 46.16% 😞 1.07% 👍
Other metrics Before After Change
Lines 990 1006 16
Changed files Quality Before Quality After Quality Change
shtab/init.py 25.89% 😞 25.93% 😞 0.04% 👍
tests/test_shtab.py 76.67% ⭐ 76.78% ⭐ 0.11% 👍

Here are some functions in these files that still need a tune-up:

File Function Complexity Length Working Memory Quality Recommendation
shtab/init.py get_bash_commands 78 ⛔ 589 ⛔ 1.22% ⛔ Refactor to reduce nesting. Try splitting into smaller methods
shtab/init.py complete_zsh 62 ⛔ 902 ⛔ 2.38% ⛔ Refactor to reduce nesting. Try splitting into smaller methods
shtab/init.py complete_tcsh 53 ⛔ 470 ⛔ 4.99% ⛔ Refactor to reduce nesting. Try splitting into smaller methods
tests/test_shtab.py test_add_argument_to_positional 1 ⭐ 171 😞 9 🙂 61.90% 🙂 Try splitting into smaller methods
tests/test_shtab.py test_subparser_aliases 1 ⭐ 172 😞 8 🙂 64.02% 🙂 Try splitting into smaller methods

Legend and Explanation

The emojis denote the absolute quality of the code:

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

codecov-commenter commented 1 year ago

Codecov Report

Base: 91.04% // Head: 74.46% // Decreases project coverage by -16.57% :warning:

Coverage data is based on head (d8a6b85) compared to base (4c0170c). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #110 +/- ## =========================================== - Coverage 91.04% 74.46% -16.58% =========================================== Files 3 2 -1 Lines 335 47 -288 =========================================== - Hits 305 35 -270 + Misses 30 12 -18 ``` | [Impacted Files](https://codecov.io/gh/iterative/shtab/pull/110?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=iterative) | Coverage Δ | | |---|---|---| | [shtab/\_\_init\_\_.py](https://codecov.io/gh/iterative/shtab/pull/110/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=iterative#diff-c2h0YWIvX19pbml0X18ucHk=) | | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=iterative). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=iterative)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

casperdcl commented 1 year ago

Thanks! Sorry for the delay.