深酒とお昼寝で忘れる

深酒とお昼寝で忘れる

素面でも意図したことを忘れがちなしらふいとさんは、忘れる前に書き残せたらとても満足

Zsh のカスタマイズは日進月歩 − 失敗したコマンドを履歴に残さない

日々、かなりの頻度でシェルのコマンド履歴を検索します。がんばって入力した、長くてなかなか使わないコマンドなど(複数のコマンドをパイプでつないだり、コマンドに様々なオプションを渡していたり)を履歴の検索なしに再度実行するのはとてもつらいです。

そんな便利なコマンド履歴の検索ですが、気になることもあります。タイプミスやオプションを間違えたりして失敗したコマンドを、うっかりまた履歴から検索して実行してしまうことです。とても非生産的でストレスがたまります。そんな悲劇を回避するため、失敗したコマンドは履歴に残さない設定にしてみました。タイトルにあるとおり、対象のシェルは zsh です。

こちら を参考にしました。zshフック関数(9.3.1 Hook Functions) という仕組みを使います。下記のような設定を .zshrc などに記入すれば良いはずです。

_record_command() {
  typeset -g _LASTCMD=${1%%$'\n'}
  return 1
}
zshaddhistory_functions+=(_record_command)

_update_history() {
  local last_status="$?"
  # hist_ignore_space
  if [[ ! -n ${_LASTCMD%% *} ]]; then
    return
  fi
  # hist_reduce_blanks
  local cmd_reduce_blanks=$(echo ${_LASTCMD} | tr -s ' ')
  # Record the commands that have succeeded
  if [[ ${last_status} == 0 ]]; then
    print -sr -- "${cmd_reduce_blanks}"
  fi
}
precmd_functions+=(_update_history)

コマンド履歴の保存に関するフック関数 zshaddhistory は、ドキュメントによるとコマンドの実行直前に呼ばれるようです。通常はこのタイミングで保存されるのですが、今回は実行結果の成否を見てから保存するかを決めたいのでここでは保存しません。そこで _record_command という関数内でコマンドをグローバルな変数 _LASTCMD に保存しておき 1 を返します(0 を返せば通常どおり HISTFILE に保存されます。2 を返すと履歴ファイルには保存されませんが、Ctrl-P/N などでさかのぼれる内部ヒストリには保存されます)。この関数を zshaddhistory_functions に追加します。

続いて実際に履歴を保存する関数が _update_history になります。postcmd というフック関数があるのかと期待したところ、ないのですが、どうやら precmd 関数がコマンドの実行直後に呼ばれるようなので(呼ばれるタイミングについては この記事 が詳しいです)、こちらを使います。まずはじめに、実行したコマンドの終了ステータスを last_status 変数に保存します。スペースで始まる行(やスペースだけの行)は保存しないようにチェックを行ない(hist_ignore_space 相当)、複数のスペースは tr で一つにまとめます(hist_reduce_blanks 相当)。最後に、終了ステータスが 0 の場合は履歴に print コマンドで保存します(参考:こちら)。この関数を precmd_functions に追加します。

これでおおよそ所望の動作にはなったはずです。*1 ストレスが減って良いですね!

*1:直前の終了ステータスを見ているため失敗するコマンドと成功するコマンドを ; でつなげた場合などには記録されてしまいます。コマンドをつなげる場合には && を使うなどしましょう。