やりたいこと
- プロジェクトディレクトリ下でのみ有効なコマンドを作りたい
- 自分が使うためのものなので、Git管理下には置きたくない
手順
方針
- プロジェクトディレクトリに自分専用のフォルダ
tsuemuraを作る -
tsuemura/binにスクリプトを保存する - Gitが
tsuemuraを常に無視するように設定する - プロジェクトフォルダに入った時だけ
tsuemura/binにパスを通すようにする
Gitの設定
MacなどUnix系OSの場合は$HOME/.config/git/ignoreに下記設定を追加する。
$HOME/.config/git/ignore
tsuemura
.envrc
Windowsの場合は事前にignoreファイルのパスをgitに設定しておかないといけない。PowerShellで以下を実行する。
git config --global core.excludesfile "$Env:USERPROFILE\.config\git\ignore"
tsuemura は自分用のスクリプトを入れておく場所。
ついでに.DS_Storeとか.vscodeとかも書いておくと吉。
scriptやbinでなく自分の名前にしてあるのは、プロジェクト内にもともと存在するファイルとの干渉を防ぐ為。
direnvの設定
Homebrewを利用している場合は↓でOK。
$ brew install direnv
シェルの設定(bashの場合)
$ echo 'eval "$(direnv hook bash)"' >> .bashrc
$ source ~/.bashrc
プロジェクトディレクトリに移動して、.envrcというファイルにPATHの設定を書く。
export PATH=./tsuemura/bin:$PATH
direnvの設定を反映する。
$ direnv allow
確認
tsuemura/binに保存したコマンドが、プロジェクトディレクトリ内では動く。
hello-world
#!/usr/bin/bash
echo "Hello World!
$ cd /path/to/your/project
$ hello-world
Hello World!
$ cd
direnv: unloading
$ hello-world
bash: command not found: hello-world