iterative / shtab

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

misc zsh fixes #93

Closed Freed-Wu closed 1 year ago

Freed-Wu commented 2 years ago
sourcery-ai[bot] commented 2 years ago

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 0.64%.

Quality metrics Before After Change
Complexity 28.85 😞 29.32 😞 0.47 👎
Method Length 100.54 🙂 102.02 🙂 1.48 👎
Working memory 3.61 ⭐ 3.69 ⭐ 0.08 👎
Quality 46.16% 😞 45.52% 😞 -0.64% 👎
Other metrics Before After Change
Lines 1009 1026 17
Changed files Quality Before Quality After Quality Change
shtab/init.py 25.93% 😞 25.34% 😞 -0.59% 👎
tests/test_shtab.py 76.78% ⭐ 76.78% ⭐ 0.00%

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 64 ⛔ 959 ⛔ 2.11% ⛔ 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!

casperdcl commented 2 years ago

@Freed-Wu Thanks! You wrote fixes #91 in a commit message, just clarifying you meant fixes #90, right?

Freed-Wu commented 1 year ago

@Freed-Wu Thanks! You wrote fixes #91 in a commit message, just clarifying you meant fixes #90, right?

It also fix #91, which path completion failed in zsh. Because they are simple, I put them in one PR. If you like, I can split them to many PRs.

casperdcl commented 1 year ago

/tag v1.5.8 6779de6