sedを使ってファイル内を簡単に置換する方法

Buildのスクリプトとか、デバッグ用に少しだけファイルを書き換えておきたいのだが手動で毎回変えるのが面倒なのでコマンドを一発叩けばできないかという需要は結構あったりする。

そんなケースでsedコマンドは一発でファイルを書き換えて上書きしてくれるので便利である。例としてgatsby-config.jsというファイルがあり、その中に次のように書かれているとする。

  plugins: [
    `gatsby-plugin-preact`, // enable this for production
    {

gatsby-plugin-preactのPluginはProductionでのみ有効にしておきたいので、この部分を開発中はコメントアウトしておきたい。

この時下記のコマンドでコメントアウトが可能である。

sed -i -e "s|\`gatsby-plugin-preact\`|// \`gatsby-plugin-preact\`|g" gatsby-config.js

-iは上書きのオプション。--in-placeの略なのでこれを指定しても良い。ちなみにin-placeはメモリを使わずに入力データを直接書き換えるというコンピュータ用語である。

-eはexpressionで次に正規表現が続く。s/変更前/変更後/gのように記述しても良いが、特殊文字が多くあった時にエスケープ処理が面倒であり、コードの可読性も落ちるので|で区切ることをおすすめする。

|で区切ると正規表現ではなく単純な置換とみなされ、Linuxコマンドの構文と間違われないように一部文字(例のバッククォートぐらいだと思われる)はエスケープする必要があるが、ほぼ直接値を記入することができ可読性が高い。

alias preactoff='sed -i -e "s|\`gatsby-plugin-preact\`|// \`gatsby-plugin-preact\`|g" gatsby-config.js'
alias preacton='sed -i -e "s|// \`gatsby-plugin-preact\`|\`gatsby-plugin-preact\`|g" gatsby-config.js'