dotfilesの設定をする

chouxcreams

このへんの記事を参考にして自分のdotfiles(.zshrc,.zprofileとか)をgitで管理できるようにする

社会人になってPCの環境構築する機会も増えたため、自分の私用PCのdotfilesをpublicで公開して社用PCでもいい感じに展開できるといいなって思った。

chouxcreams

上の記事を読んでchezmoiってやつもかなり良さそうだと思った。
ただし

環境ごとの差分を書く
ssh秘密鍵などの管理
などが今の所必要ないとおもうので一旦シンプルな構成でいこうと思う

chouxcreams

まずはGitHub上でリポジトリを作ってクローン
https://github.com/chouxcreams/dotfiles

gh repo clone chouxcreams/dotfiles # 自分のリポジトリを指定すること

chouxcreams

一旦ファイルをdotfiles以下に移動してみる(まだcommitやpushはしない！)

mv ~/.zshrc ~/.zprofile ~/.zshenv ~/dotfiles

このままだと.zshrcなどが読み込まれないので環境変数ZDOTDIRを.zshenvで設定する

echo 'export ZDOTDIR="$HOME/dotfiles"' >> ~/dotfiles/.zshenv

ホームディレクトリに.zshenvがないと設定したZDOTDIRすら読み込めないのでシンボリックリンクを貼る

ln -s ~/dotfiles/.zshenv

再起動して読み込めてそうなことを確認する

exec $SHELL -l

chouxcreams

gitのログに残す前にヤバそうな環境変数がないかざっと確認する
何らかのパスワードとか書いてたら良くないので

chouxcreams

ZDOTDIRを設定したことで、.zsh_historyも~/dotfiles以下に移動したの忘れてた

mv ~/.zsh_history ~/dotfiles

あとホームディレクトリにzshのコマンド履歴を保持する.zhistoryと.zsh_historyの2種類があった。この記事によるとCatalina以降では.zsh_historyに保管されるらしいので.zhistoryを削除

コマンド履歴をgitに残す必要ないので.gitignoreを作成

touch ~/dotfiles/.gitignore

この記事みたいにホワイトリスト形式の.gitignoreを作る

.gitignore

### all ignore ###
/*
/.**

### not ignore ###
!/README.md
!/LICENSE
!/.zshenv
!/.zprofile
!/.zshrc

chouxcreams

ついでなので.zshrc,.zprofile,.zshenvの違いを確認してそれぞれの記述を整理する(.zprofileのこの記述、.zshrcに書いたほうがいいやん！的な)。以下の記事が参考になった。

.zprofileの中身がなくなった

chouxcreams

.zshrcの中身をzinitの設定、zinitのプラグイン、path、環境変数の設定、エイリアスの設定、ぐらいの粒度ででブロック分けする。
ついでにpathの書き方もexport PATH=/path/to/hoge:$PATHから以下の記事のような書き方に変更

これでいい感じになったのでcommitしてpush

chouxcreams

初期化スクリプトを書く。とりあえず.zshenvのシンボリックリンク貼るだけ。

init.sh

#! /bin/sh

DOTPATH="$HOME/dotfiles"
ln -s $DOTPATH/.zshenv $HOME/.zshenv

chouxcreams

https://hodalog.com/docker-and-git-commands-auto-completion-in-mac-os-catalina/ を参考にgit/dockerのコマンドをtabで補完できるように設定する。
以下を初期化スクリプトに追記

init.sh

# gitの補完用スクリプトのダウンロード
curl -o $HOME/dotfiles/.zsh/completion/git-completion.bash https://raw.githubusercontent.com/git/git/master/contrib/completion/git-completion.bash
curl -o $HOME/dotfiles/.zsh/completion/_git https://raw.githubusercontent.com/git/git/master/contrib/completion/git-completion.zsh

# dockerの補完用スクリプトのダウンロード
curl -o $HOME/.zsh/completion/_docker https://raw.githubusercontent.com/docker/cli/master/contrib/completion/zsh/_docker

以下を.zshrcに追記

.zshrc

### gitやdockerの補完の設定
zstyle ':completion:*:*:git:*' script ~/dotfiles/.zsh/completion/git-completion.bash
fpath=(~/dotfiles/.zsh/completion $fpath)
autoload -Uz compinit && compinit -i

chouxcreams

上の記事を参考にGithub Actionsによる自動テストを書く

macos.yml

name: macos

on:
  push:
    branches: [ main ]

jobs:
  macos-test:
    runs-on: macos-latest

    steps:
    - uses: actions/checkout@v2

    - name: Run init.sh
      run: ${GITHUB_WORKSPACE}/init.sh

    - name: Load .zshenv
      run: |
        zsh ~/.zshenv 2> error.log; cat error.log
        if [ -s error.log ]; then false; fi

    - name: Load .zprofile
      run: |
        zsh ${ZDOTDIR}/.zprofile 2> error.log; cat error.log
        if [ -s error.log ]; then false; fi

    - name: Load .zshrc
      run: |
        zsh ${ZDOTDIR}/.zshrc 2> error.log; cat error.log
        if [ -s error.log ]; then false; f

lint.yml

name: lint

on:
  push:
    branches: [ main ]

jobs:
  lint-check:
    runs-on: macos-latest

    steps:
    - uses: actions/checkout@v2

    - name: Check init.sh
      run: shellcheck ${GITHUB_WORKSPACE}/init.sh

    - name: Check .zshenv
      run: shellcheck ${GITHUB_WORKSPACE}/.zshenv --exclude=SC2148,SC1090

    - name: Check .zprofile
      run: shellcheck ${GITHUB_WORKSPACE}/.zprofile --exclude=SC2148,SC1090

    - name: Check .zshrc
      run: shellcheck ${GITHUB_WORKSPACE}/.zshrc --exclude=SC2148,SC1090

chouxcreams

shellcheckはzsh的pathの書き方するだけで通らなくなるし、brewのインストールの自動化もまだやってないので、init.shだけ実行するように書き換えた

このスクラップは2021/06/23にクローズされました