bash-preexec

⚡ preexec and precmd functions for Bash just like Zsh.

2 years after

Build Status GitHub version

Bash-Preexec

preexec and precmd hook functions for Bash in the style of Zsh. They aim to emulate the behavior as described for Zsh.

Bashhub Logo

This project is currently being used in production by Bashhub. Hype!

Quick Start

# Pull down our file from GitHub and write it to our home directory as a hidden file.
curl https://raw.githubusercontent.com/rcaloras/bash-preexec/master/bash-preexec.sh -o ~/.bash-preexec.sh
# Source our file to bring it into our environment
source ~/.bash-preexec.sh
# Define a couple functions.
preexec() { echo "just typed $1"; }
precmd() { echo "printing the prompt"; }

Install

You'll want to pull down the file and add it to your bash profile/configuration (i.e ~/.bashrc, ~/.profile, ~/.bash_profile, etc). It must be the last thing imported in your bash profile.

# Pull down our file from GitHub and write it to our home directory as a hidden file.
curl https://raw.githubusercontent.com/rcaloras/bash-preexec/master/bash-preexec.sh -o ~/.bash-preexec.sh
# Source our file at the end of our bash profile (e.g. ~/.bashrc, ~/.profile, or ~/.bash_profile)
echo '[[ -f ~/.bash-preexec.sh ]] && source ~/.bash-preexec.sh' >> ~/.bashrc

Usage

Two functions preexec and precmd can now be defined and they'll be automatically invoked by bash-preexec if they exist.

  • preexec Executed just after a command has been read and is about to be executed. The string that the user typed is passed as the first argument.
  • precmd Executed just before each prompt. Equivalent to PROMPT_COMMAND, but more flexible and resilient.
    source ~/.bash-preexec.sh
    preexec() { echo "just typed $1"; }
    precmd() { echo "printing the prompt"; }

    Should output something like:

    [email protected]:~/git/bash-preexec (master)$ ls
    just typed ls
    bash-preexec.sh  README.md  test
    printing the prompt

    Function Arrays

    You can also define functions to be invoked by appending them to two different arrays. This is great if you want to have many functions invoked for either hook. Both preexec and precmd functions are added to these by default and don't need to be added manually.

  • $preexec_functions Array of functions invoked by preexec.
  • $precmd_functions Array of functions invoked by precmd.

preexec

# Define some function to use preexec
preexec_hello_world() { echo "You just entered $1"; }
# Add it to the array of functions to be invoked each time.
preexec_functions+=(preexec_hello_world)

precmd

precmd_hello_world() { echo "This is invoked before the prompt is displayed"; }
precmd_functions+=(precmd_hello_world)

You can also define multiple functions to be invoked like so.

precmd_hello_one() { echo "This is invoked on precmd first"; }
precmd_hello_two() { echo "This is invoked on precmd second"; }
precmd_functions+=(precmd_hello_one)
precmd_functions+=(precmd_hello_two)

You can check the functions set for each by echoing its contents.

echo ${preexec_functions[@]}
echo ${precmd_functions[@]}

Subshells

bash-preexec does not support invoking preexec() for subshells by default. It must be enabled by setting __bp_enable_subshells.

# Enable experimental subshell support
export __bp_enable_subshells="true"

This is disabled by default due to buggy situations related to to functrace and Bash's DEBUG trap. See Issue #25

Tests

You can run tests using Bats.

bats test

Should output something like:

[email protected]:~/git/bash-preexec(master)$ bats test
 ✓ No functions defined for preexec should simply return
 ✓ precmd should execute a function once
 ✓ preexec should execute a function with the last command in our history
 ✓ preexec should execute multiple functions in the order added to their arrays
 ✓ preecmd should execute multiple functions in the order added to their arrays

Related Repositories

fasd

fasd

Command-line productivity booster, offers quick access to files and directories, ...

ntfy

ntfy

A utility for sending notifications, on demand and when commands finish. ...

s

s

s is a tool for ssh like z for cd ...

alias-tips

alias-tips

An oh-my-zsh plugin to help remembering those aliases you defined once ...

undistract-me

undistract-me

Notifies you when long-running terminal commands complete ...


Top Contributors

rcaloras ivuk D630 calid evverx PhillipSz

Releases

-   m0.1.0 zip tar
-   0.3.1 zip tar
-   0.3.0 zip tar
-   0.2.3 zip tar
-   0.2.2 zip tar
-   0.2.1 zip tar
-   0.2.0 zip tar
-   0.1.0 zip tar