plugins: clear and consistent log messages

pull/2062/head
John D Pell 2022-02-08 17:13:10 -08:00 committed by John D Pell
parent fdff1d81cd
commit 0d813d2376
24 changed files with 185 additions and 141 deletions

View File

@ -93,11 +93,14 @@ plugins/available/base.plugin.bash
plugins/available/basher.plugin.bash
plugins/available/battery.plugin.bash
plugins/available/blesh.plugin.bash
plugins/available/cht.sh.plugin.bash
plugins/available/cmd-returned-notify.plugin.bash
plugins/available/colors.plugin.bash
plugins/available/direnv.plugin.bash
plugins/available/dirs.plugin.bash
plugins/available/docker-machine.plugin.bash
plugins/available/fasd.plugin.bash
plugins/available/fzf.plugin.bash
plugins/available/gif.plugin.bash
plugins/available/git-subrepo.plugin.bash
plugins/available/git.plugin.bash
@ -110,6 +113,7 @@ plugins/available/history.plugin.bash
plugins/available/hub.plugin.bash
plugins/available/java.plugin.bash
plugins/available/jekyll.plugin.bash
plugins/available/jenv.plugin.bash
plugins/available/jump.plugin.bash
plugins/available/latex.plugin.bash
plugins/available/less-pretty-cat.plugin.bash
@ -117,10 +121,12 @@ plugins/available/man.plugin.bash
plugins/available/nginx.plugin.bash
plugins/available/node.plugin.bash
plugins/available/nodenv.plugin.bash
plugins/available/nvm.plugin.bash
plugins/available/osx-timemachine.plugin.bash
plugins/available/osx.plugin.bash
plugins/available/percol.plugin.bash
plugins/available/plenv.plugin.bash
plugins/available/powerline.plugin.bash
plugins/available/projects.plugin.bash
plugins/available/proxy.plugin.bash
plugins/available/pyenv.plugin.bash
@ -128,6 +134,7 @@ plugins/available/python.plugin.bash
plugins/available/rbenv.plugin.bash
plugins/available/ruby.plugin.bash
plugins/available/textmate.plugin.bash
plugins/available/thefuck.plugin.bash
plugins/available/todo.plugin.bash
plugins/available/xterm.plugin.bash
plugins/available/zoxide.plugin.bash

View File

@ -1,11 +1,10 @@
# shellcheck shell=bash
cite about-plugin
about-plugin 'Autojump configuration, see https://github.com/wting/autojump for more details'
# Only supports the Homebrew variant, Debian and Arch at the moment.
# Only supports the Homebrew variant, Debian, and Arch at the moment.
# Feel free to provide a PR to support other install locations
# shellcheck disable=SC1090
if _bash_it_homebrew_check && [[ -s "${BASH_IT_HOMEBREW_PREFIX}/etc/profile.d/autojump.sh" ]]; then
if _bash_it_homebrew_check && [[ -s "${BASH_IT_HOMEBREW_PREFIX?}/etc/profile.d/autojump.sh" ]]; then
source "${BASH_IT_HOMEBREW_PREFIX}/etc/profile.d/autojump.sh"
elif _command_exists dpkg && dpkg -s autojump &> /dev/null; then
source "$(dpkg-query -S autojump.sh | cut -d' ' -f2)"

View File

@ -1,5 +1,4 @@
# shellcheck shell=bash
cite about-plugin
about-plugin 'initializes basher, the shell package manager'
# https://github.com/basherpm/basher
@ -13,4 +12,5 @@ if ! _command_exists basher; then
fi
fi
eval "$(basher init - bash)"
# shellcheck disable=SC1090
source < <(basher init - bash)

View File

@ -1,9 +1,13 @@
cite about-plugin
# shellcheck shell=bash
about-plugin 'Simplify `curl cht.sh/<query>` to `cht.sh <query>`'
# Play nicely if user already installed cht.sh cli tool
if ! _command_exists cht.sh ; then
function cht.sh () {
if _binary_exists cht.sh ; then
_log_warning "You have already installed 'cht.sh', so it's safe to disable this plugin."
return 1
fi
function cht.sh () {
about 'Executes a cht.sh curl query using the provided arguments'
param ' [ ( topic [sub-topic] ) | ~keyword ] [ :list | :help | :learn ]'
example '$ cht.sh :help'
@ -15,7 +19,7 @@ if ! _command_exists cht.sh ; then
group 'cht-sh'
# Separate arguments with '/', preserving spaces within them
local query=$(IFS=/ ; echo "$*")
local query
query=$(IFS=/ ; echo "$*")
curl "cht.sh/${query}"
}
fi
}

View File

@ -1,7 +1,10 @@
# shellcheck shell=bash
cite about-plugin
about-plugin 'load direnv, if you are using it: https://direnv.net/'
if _command_exists direnv; then
eval "$(direnv hook bash)"
if ! _binary_exists direnv; then
_log_warning "Could not find 'direnv'."
return 1
fi
# shellcheck disable=SC1090
source < <(direnv hook bash)

View File

@ -1,6 +1,10 @@
cite about-plugin
# shellcheck shell=bash
about-plugin 'load fasd, if you are using it'
_command_exists fasd || return
if ! _binary_exists fasd; then
_log_warning "Unable to locage 'fasd'."
return 1
fi
eval "$(fasd --init auto)"
# shellcheck disable=SC1090
source < <(fasd --init auto)

View File

@ -1,5 +1,4 @@
# shellcheck shell=bash
cite about-plugin
about-plugin 'go environment variables & path configuration'
# Load after basher and goenv
@ -7,7 +6,10 @@ about-plugin 'go environment variables & path configuration'
# Test `go version` because goenv creates shim scripts that will be found in PATH
# but do not always resolve to a working install.
{ _command_exists go && go version &> /dev/null; } || return 0
if ! _binary_exists go || ! go version &> /dev/null; then
_log_warning "Unable to locate a working 'go'."
return 1
fi
export GOROOT="${GOROOT:-$(go env GOROOT)}"
export GOPATH="${GOPATH:-$(go env GOPATH)}"
@ -16,7 +18,7 @@ export GOPATH="${GOPATH:-$(go env GOPATH)}"
# might be managed differently, we add each path's /bin folder to PATH using pathmunge,
# while preserving ordering.
# e.g. GOPATH=foo:bar -> PATH=foo/bin:bar/bin
_bash-it-gopath-pathmunge() {
function _bash-it-gopath-pathmunge() {
_about 'Ensures paths in GOPATH are added to PATH using pathmunge, with /bin appended'
_group 'go'
if [[ -z $GOPATH ]]; then
@ -29,7 +31,7 @@ _bash-it-gopath-pathmunge() {
while [[ $i -gt 0 ]]; do
i=$((i - 1))
if [[ -n "${paths[i]}" ]]; then
pathmunge "${paths[i]}/bin"
pathmunge "${paths[i]}/bin" || true # ignore failures
fi
done
}

View File

@ -1,5 +1,4 @@
# shellcheck shell=bash
cite about-plugin
about-plugin 'load goenv, if you are using it'
# https://github.com/syndbg/goenv
@ -11,29 +10,31 @@ about-plugin 'load goenv, if you are using it'
# - Check if in $PATH already
# - Check if installed manually to $GOENV_ROOT
# - Check if installed manually to $HOME
_command_exists goenv \
|| [[ -n "$GOENV_ROOT" && -x "$GOENV_ROOT/bin/goenv" ]] \
|| [[ -x "$HOME/.goenv/bin/goenv" ]] \
|| return 0
if ! _binary_exists goenv || ! [[ -n "${GOENV_ROOT:-}" && -x "$GOENV_ROOT/bin/goenv" ]] || ! [[ -x "$HOME/.goenv/bin/goenv" ]]; then
_log_warning "Unable to locate 'goenv'."
return 1
fi
# Set GOENV_ROOT, if not already set
export GOENV_ROOT="${GOENV_ROOT:-$HOME/.goenv}"
: "${GOENV_ROOT:=$HOME/.goenv}"
export GOENV_ROOT
# Add GOENV_ROOT/bin to PATH, if that's where it's installed
if ! _command_exists goenv && [[ -x "$GOENV_ROOT/bin/goenv" ]]; then
pathmunge "$GOENV_ROOT/bin"
fi
# Initialize goenv
eval "$(goenv init - bash)"
# shellcheck disable=SC1090 # Initialize goenv
source < <(goenv init - bash)
# If moving to a directory with a goenv version set, reload the shell
# to ensure the shell environment matches expectations.
_bash-it-goenv-preexec() {
function _bash-it-goenv-preexec() {
GOENV_OLD_VERSION="$(goenv version-name)"
}
_bash-it-goenv-precmd() {
if [[ -n $GOENV_OLD_VERSION ]] && [[ "$GOENV_OLD_VERSION" != "$(goenv version-name)" ]]; then
function _bash-it-goenv-precmd() {
if [[ -n "${GOENV_OLD_VERSION:-}" ]] && [[ "$GOENV_OLD_VERSION" != "$(goenv version-name)" ]]; then
exec env -u PATH -u GOROOT -u GOPATH -u GOENV_OLD_VERSION "${0/-/}" --login
fi
unset GOENV_OLD_VERSION

View File

@ -1,7 +1,9 @@
# shellcheck shell=bash
cite about-plugin
about-plugin 'load hub, if you are using it'
if _command_exists hub; then
eval "$(hub alias -s)"
if ! _binary_exists hub; then
_log_warning "Unable to locate 'hub'."
return 1
fi
source < <(hub alias -s)

View File

@ -1,22 +1,23 @@
cite about-plugin
# shellcheck shell=bash
about-plugin 'load jenv, if you are using it'
# Don't modify the environment if we can't find the tool:
# - Check if in $PATH already
# - Check if installed manually to $JENV_ROOT
# - Check if installed manually to $HOME
_command_exists jenv ||
[[ -n "$JENV_ROOT" && -x "$JENV_ROOT/bin/jenv" ]] ||
[[ -x "$HOME/.jenv/bin/jenv" ]] ||
return
if ! _binary_exists jenv && ! [[ -n "${JENV_ROOT:-}" && -x "$JENV_ROOT/bin/jenv" ]] && ! [[ -x "$HOME/.jenv/bin/jenv" ]]; then
_log_warning "Unable to locate 'jenv'."
return 1
fi
# Set JENV_ROOT, if not already set
export JENV_ROOT="${JENV_ROOT:-$HOME/.jenv}"
: "${JENV_ROOT:=$HOME/.jenv}"
export JENV_ROOT
# Add JENV_ROOT/bin to PATH, if that's where it's installed
! _command_exists jenv &&
[[ -x "$JENV_ROOT/bin/jenv" ]] &&
if ! _command_exists jenv && [[ -x "$JENV_ROOT/bin/jenv" ]]; then
pathmunge "$JENV_ROOT/bin"
fi
# Initialize jenv
eval "$(jenv init - bash)"
# shellcheck disable=SC1090 # Initialize jenv
source < <(jenv init - bash)

View File

@ -1,12 +1,11 @@
# shellcheck shell=bash
# shellcheck disable=SC2016
cite about-plugin
about-plugin 'initialize jump (see https://github.com/gsamokovarov/jump). Add `export JUMP_OPTS=("--bind=z")` to change keybinding'
function __init_jump() {
function _bash-it-component-plugin-callback-on-init-jump() {
if _command_exists jump; then
eval "$(jump shell bash "${JUMP_OPTS[@]}")"
source < <(jump shell bash "${JUMP_OPTS[@]:-}")
fi
}
__init_jump
_bash-it-component-plugin-callback-on-init-jump

View File

@ -1,8 +1,10 @@
# shellcheck shell=bash
cite about-plugin
about-plugin 'pygmentize instead of cat to terminal if possible'
_command_exists pygmentize || return
if ! _binary_exists pygmentize; then
_log_warning "${BASH_SOURCE[0]##*/}: unable to initialize without '$_' installed."
return 1
fi
# pigmentize cat and less outputs - call them ccat and cless to avoid that
# especially cat'ed output in scripts gets mangled with pygemtized meta characters

View File

@ -1,14 +1,16 @@
# shellcheck shell=bash
cite about-plugin
about-plugin 'Node.js helper functions'
# Check that we have npm
_command_exists npm || return
if ! _binary_exists npm; then
_log_warning "Unable to locage 'npm'."
return 1
fi
# Ensure local modules are preferred in PATH
pathmunge "./node_modules/.bin" "after"
# If not using nodenv, ensure global modules are in PATH
if [[ ! "$(type -p npm)" == *"nodenv/shims"* ]]; then
if [[ "$(type -p npm)" != *"nodenv/shims"* ]]; then
pathmunge "$(npm config get prefix)/bin" "after"
fi

View File

@ -1,10 +1,15 @@
# shellcheck shell=bash
cite about-plugin
about-plugin 'load nodenv, if you are using it'
export NODENV_ROOT="$HOME/.nodenv"
pathmunge "$NODENV_ROOT/bin"
if _command_exists nodenv; then
eval "$(nodenv init - bash)"
if [[ -d "${NODENV_ROOT:=$HOME/.nodenv}/bin" ]]; then
export NODENV_ROOT
pathmunge "$NODENV_ROOT/bin"
fi
if ! _binary_exists nodenv; then
_log_warning "Unable to locage 'nodenv'."
return 1
fi
# shellcheck disable=SC1090
source < <(nodenv init - bash)

View File

@ -1,31 +1,24 @@
# shellcheck shell=bash
#
# BASH_IT_LOAD_PRIORITY: 225
#
about-plugin 'node version manager configuration'
# Bash-it no longer bundles nvm, as this was quickly becoming outdated.
# Please install nvm from https://github.com/creationix/nvm.git if you want to use it.
cite about-plugin
about-plugin 'node version manager configuration'
# BASH_IT_LOAD_PRIORITY: 225
export NVM_DIR="${NVM_DIR:-$HOME/.nvm}"
# This loads nvm
if _bash_it_homebrew_check && [[ -s "${BASH_IT_HOMEBREW_PREFIX}/nvm.sh" ]]
then
source "${BASH_IT_HOMEBREW_PREFIX}/nvm.sh"
else
[[ -s "$NVM_DIR/nvm.sh" ]] && source "$NVM_DIR/nvm.sh"
: "${NVM_DIR:=$HOME/.nvm}"
export NVM_DIR
# shellcheck disable=SC1091 # This loads nvm
if _bash_it_homebrew_check && [[ -s "${BASH_IT_HOMEBREW_PREFIX?}/nvm.sh" ]]; then
source "${BASH_IT_HOMEBREW_PREFIX?}/nvm.sh"
elif [[ -s "${NVM_DIR}/nvm.sh" ]]; then
source "${NVM_DIR}/nvm.sh"
fi
if ! _command_exists nvm
then
function nvm() {
echo "Bash-it no longer bundles the nvm script. Please install the latest version from"
echo ""
echo "https://github.com/creationix/nvm.git"
echo ""
echo "if you want to use nvm. You can keep this plugin enabled once you have installed nvm."
}
nvm
if ! _command_exists nvm; then
_log_warning "Bash-it no longer bundles the nvm script. Please install the latest version from
https://github.com/creationix/nvm.git"
_log_warning "if you want to use nvm. You can keep this plugin enabled once you have installed nvm."
return 1
fi

View File

@ -1,9 +1,8 @@
# shellcheck shell=bash
cite about-plugin
about-plugin 'Search&Select history with percol'
# Notice
## You have to upgrade bash to bash 4.x on Mac OS X.
## You have to upgrade bash to bash 4.x or higher
## http://stackoverflow.com/questions/16416195/how-do-i-upgrade-bash-in-mac-osx-mountain-lion-and-set-it-the-correct-path
# Install
@ -13,12 +12,15 @@ about-plugin 'Search&Select history with percol'
# Usage
## C-r to search&select from history
_command_exists percol || return
if ! _binary_exists percol; then
_log_warning "Unable to locate 'percol'."
return 1
fi
if [[ ${BASH_VERSINFO[0]} -lt 4 ]]; then
_log_warning "You have to upgrade Bash to Bash v4.x to use the 'percol' plugin."
_log_warning "Your current Bash version is $BASH_VERSION."
return
return 1
fi
function _replace_by_history() {

View File

@ -1,8 +1,4 @@
# shellcheck shell=bash
#
# plugin for plenv
cite about-plugin
about-plugin 'plenv plugin for Perl'
if [[ -d "${HOME}/.plenv/bin" ]]; then
@ -10,7 +6,10 @@ if [[ -d "${HOME}/.plenv/bin" ]]; then
pathmunge "${HOME}/.plenv/bin"
fi
if _command_exists plenv; then
# init plenv
eval "$(plenv init - bash)"
if ! _binary_exists plenv; then
_log_warning "Unable to locage 'plenv'."
return 1
fi
# shellcheck disable=SC1090 # init plenv
source < <(plenv init - bash)

View File

@ -1,9 +1,11 @@
# shellcheck shell=bash
cite about-plugin
about-plugin 'enables powerline daemon'
_command_exists powerline-daemon || return
if ! _binary_exists powerline-daemon; then
_log_warning "Unable to locate '$_'."
return 1
fi
powerline-daemon -q
#the following should not be executed if bashit powerline themes in use
@ -12,8 +14,8 @@ case "$BASH_IT_THEME" in
return
;;
esac
POWERLINE_BASH_CONTINUATION=1
POWERLINE_BASH_SELECT=1
export POWERLINE_BASH_CONTINUATION=1
export POWERLINE_BASH_SELECT=1
bashPowerlineInit="$(python -c \
"import os; \
import powerline;\
@ -22,5 +24,11 @@ bashPowerlineInit="$(python -c \
'bindings', \
'bash', \
'powerline.sh'))")"
[ -e $bashPowerlineInit ] || return
source $bashPowerlineInit
if ! [[ -s ${bashPowerlineInit?} ]]; then
_log_warning "Failed to initialize 'powerline'."
return 1
fi
# shellcheck disable=SC1090
source "${bashPowerlineInit?}"

View File

@ -1,5 +1,4 @@
# shellcheck shell=bash
cite about-plugin
about-plugin 'load pyenv, if you are using it'
# https://github.com/pyenv/pyenv
@ -11,13 +10,14 @@ about-plugin 'load pyenv, if you are using it'
# - Check if in $PATH already
# - Check if installed manually to $PYENV_ROOT
# - Check if installed manually to $HOME
_command_exists pyenv \
|| [[ -n "$PYENV_ROOT" && -x "$PYENV_ROOT/bin/pyenv" ]] \
|| [[ -x "$HOME/.pyenv/bin/pyenv" ]] \
|| return 0
if ! _binary_exists pyenv && ! [[ -n "${PYENV_ROOT:-}" && -x "$PYENV_ROOT/bin/pyenv" ]] && ! [[ -x "$HOME/.pyenv/bin/pyenv" ]]; then
_log_warning "Unable to locate 'pyenv'."
return 1
fi
# Set PYENV_ROOT, if not already set
export PYENV_ROOT="${PYENV_ROOT:-$HOME/.pyenv}"
: "${PYENV_ROOT:=$HOME/.pyenv}"
export PYENV_ROOT
# Add PYENV_ROOT/bin to PATH, if that's where it's installed
if ! _command_exists pyenv && [[ -x "$PYENV_ROOT/bin/pyenv" ]]; then
@ -26,9 +26,11 @@ fi
# Initialize pyenv
pathmunge "$PYENV_ROOT/shims"
eval "$(pyenv init - bash)"
# shellcheck disable=SC1090
source < <(pyenv init - bash)
# Load pyenv virtualenv if the virtualenv plugin is installed.
if pyenv virtualenv-init - &> /dev/null; then
eval "$(pyenv virtualenv-init - bash)"
# shellcheck disable=SC1090
source < <(pyenv virtualenv-init - bash)
fi

View File

@ -1,10 +1,13 @@
# shellcheck shell=bash
cite about-plugin
about-plugin 'load rbenv, if you are using it'
export RBENV_ROOT="$HOME/.rbenv"
: "${RBENV_ROOT:=$HOME/.rbenv}"
export RBENV_ROOT
pathmunge "$RBENV_ROOT/bin"
if _command_exists rbenv; then
eval "$(rbenv init - bash)"
if ! _binary_exists rbenv; then
_log_warning "Unable to locage 'rbenv'."
return 1
fi
source < <(rbenv init - bash)

View File

@ -1,13 +1,15 @@
# shellcheck shell=bash
cite about-plugin
about-plugin 'ruby and rubygems specific functions and settings'
# Make commands installed with 'gem install --user-install' available
# ~/.gem/ruby/${RUBY_VERSION}/bin/
if _command_exists ruby && _command_exists gem; then
pathmunge "$(ruby -e 'print Gem.user_dir')/bin" after
if ! _binary_exists ruby || ! _binary_exists gem; then
_log_warning "Unable to locate 'gem'."
return 1
fi
pathmunge "$(ruby -e 'print Gem.user_dir')/bin" after
function remove_gem() {
about 'removes installed gem'
param '1: installed gem name'

View File

@ -1,9 +1,10 @@
# shellcheck shell=bash
cite about-plugin
about-plugin 'set textmate as a default editor'
if _command_exists mate; then
EDITOR="$(type -p mate) -w"
GIT_EDITOR="$EDITOR"
export EDITOR GIT_EDITOR
if ! _binary_exists mate; then
_log_warning "Unable to locage 'mate'."
return 1
fi
EDITOR="$(type -p mate) -w"
export EDITOR

View File

@ -1,9 +1,12 @@
cite about-plugin
# shellcheck shell=bash
about-plugin 'Initialization for fuck'
# https://github.com/nvbn/thefuck
if _command_exists thefuck; then
# shellcheck disable=SC2046
eval $(thefuck --alias)
if ! _binary_exists thefuck; then
_log_warning "Unable to locate 'thefuck'."
return 1
fi
# shellcheck disable=SC1090
source < <(thefuck --alias)

View File

@ -1,9 +1,9 @@
# shellcheck shell=bash
cite about-plugin
about-plugin 'zoxide is a smarter cd command for your shell.'
if _command_exists zoxide; then
eval "$(zoxide init bash)"
else
if ! _binary_exists zoxide; then
_log_error 'zoxide not found, please install it from https://github.com/ajeetdsouza/zoxide'
return 1
fi
source < <(zoxide init bash)