Skip to content
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

completions: clear and consistent log messages #2063

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

gaelicWizard
Copy link
Contributor

@gaelicWizard gaelicWizard commented Jan 26, 2022

Description

Many plugins/completions/whatever check if their associated command is already installed before loading. Find, fix, and add in/to all the completions to ensure consistency and improve bash-it doctor.

Since completions are such a focused set of functions, create some helpers to simplify.

Motivation and Context

The _command_exist() (et al) functions were all weird due to having logging shoved in sideways, which was neither informative nor used anywhere. This pulls the logging from the utility functions and adds it to the relevant call sites, as well as adding to several other plugins that could use it.

In particular, some completions or some plugins may be useless but harmless if their associated command is not installed. I've opted to add logging, but not to force an early short-circuit. For example, I've made improvements to a lot of the completions code recently, but I don't have all the relevant tools installed. I load the completion and can test it out anyway, so I don't want to unnecessarily short-circuit it.

The result of all this should be a more reasonable output when $BASH_IT_LOG_LEVEL is set, and from bash-it doctor, as well as avoid polluting theme variables that check for installed utilities.

How Has This Been Tested?

Types of changes

  • Enhancement (non-breaking change which makes things better)

Checklist:

  • My code follows the code style of this project.
  • If my change requires a change to the documentation, I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • If I have added a new file, I also added it to clean_files.txt and formatted it using lint_clean_files.sh.
  • I have added tests to cover my changes, and all the new and existing tests pass.

@gaelicWizard gaelicWizard marked this pull request as ready for review January 26, 2022 06:30
@gaelicWizard gaelicWizard force-pushed the lib/completion/components branch 6 times, most recently from c319aa2 to d119871 Compare January 31, 2022 00:28
@seefood
Copy link
Contributor

seefood commented Nov 7, 2024

Howdie! please merge from master and resolve conflicts so we can move it to review :)

@seefood seefood self-assigned this Nov 7, 2024
@seefood seefood added clean up seems abandoned rattle the cage, and close if nobody wants to keep it going waiting-for-response labels Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clean up seems abandoned rattle the cage, and close if nobody wants to keep it going waiting-for-response
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants