bash や git の設定、mac の初期設定などをまとめた、いわゆる dotfiles を作りました。 ついでに GitHub Actions でテストなどを実行する CI も構築してみました。
動機
dotfiles を作る理由なんて限られてますが、初期設定の度に前の環境を思い出してポチポチするのが手間だからというのと、設定のコード管理ができるからです。 つまり作りたいから作った感じです。
開発環境
使用しているマシンとツールを先に示しておきます。
- macbook pro (2019, macOS Mojave)
- Git
- Bash
- iTerm2
- VSCode
zsh とか fish とか高度そうなシェルは使わず、まずは基本を抑えてからがいいと考えて Bash にしています。 macOS Catalina からデフォルトシェルが zsh になったという噂は聞いていますが、そのときはそのときで対応するつもりです。
デフォルトのターミナルはデフォルトのものから iTerm2 になんとなく変えてみました。 コマンドを叩くときは大抵エディタでプログラムを書きますし、コーディングに愛用している VSCode であればターミナルも同じ画面で使用できるので iTerm2 単体ではほとんど使っていません。
ファイル構成
現在のメインマシンである mac での使用を前提に作っています。 dotfiles の中身はこんな感じです。
.
├── .bash_profile
├── .bashrc
├── .gitconfig
├── iterm2
│ ├── com.googlecode.iterm2.plist # iTerm2の設定
│ ├── iceberg.itermcolors # カラーテーマ
│ └── init.sh
├── vscode
│ ├── init.sh
│ ├── install.sh
│ ├── settings.json # 言語やエディタの設定
│ ├── snippets # スニペット
│ │ ├── go.json
│ │ ├── go.mod.json
│ │ └── latex.json
│ └── vscode_extensions # 拡張機能のリスト
├── init.sh
├── install.sh
├── macos.sh
└── .github
└── workflows
├── lint.yml
└── macos.yml
.bash_profile, .bashrc は Bash の設定ファイル、.gitconfig は git の設定ファイルです。
ホームディレクトリにシンボリックリンクを貼ることで、dotfiles のリポジトリ内でファイルを管理しつつ、システムから設定を参照することができます。
シンボリックリンクを貼る処理は init.sh に書いており、運用の際はこれを一番始めに実行することにします。
# 例: .bash_profileのシンボリックリンク
CURRENT_DIR=$(cd "$(dirname "$0")"; pwd)
ln -fs "$CURRENT_DIR/.bash_profile" ~
install.sh は主にアプリケーションのインストールを実行します。
基本的に Homebrew でインストールしています。
macos.sh は mac の初期設定用のスクリプトで、Dock,Finder,Safari、トラックパッドなどの設定を記述しています。
iterm2, vscode ディレクトリはその名の通りで特定のアプリケーションの設定を行います。
これも同様に init.sh と install.sh が含まれており、リポジトリのルートにあるものとは独立させています。
使い方
実行
init.sh, install.sh の順に実行するだけです。
bash init.sh
bash install.sh
vscode や iterm2 内のファイルも同様です。
bash vscode/init.sh
bash vscode/install.sh
bash iterm2/init.sh
注意点として、. init.sh や source init.sh のような実行方法だと、カレントディレクトリのパスを正しく取得できなくなるため失敗します。
上記のように bash コマンドの引数にスクリプトを指定する方法か、実行権限を付与して実行する方法でないとうまくいきません。
僕はこれで 1 時間潰しました…
VSCode の拡張機能
既に VSCode を利用していてインストール済みの拡張機能をリストアップ・記録する場合は、次のようなコマンドを実行します。
code --list-extensions > vscode/vscode_extensions
拡張機能のインストールは vscode/vscode_extensions のファイルを参照して行います。
今見てみると、vscode でディレクトリを切っているのでファイル名は vscode_extensions ではなく extensions の方がスマートですね。
GitHub Actions でスクリプトの文法チェックとテスト
GitHub の master ブランチへのプッシュをトリガーとして、スクリプトの文法チェックと macOS 上でのテストを実行するワークフローを作りました。
# .github/workflows/lint.yml
name: lint
on:
push:
branches:
- master
paths:
- '**.sh'
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Run ShellCheck
uses: reviewdog/action-shellcheck@v1
env:
shellcheck_flags: --exclude=SC1090
shellcheck というツールでスクリプトの文法チェックを行うアクション (reviewdog/action-shellcheck@v1) を使わせてもらい、ファイル名が .sh で終わるファイルに変更があった際にチェックを走らせるようにしました。
# .github/workflows/macos.yml
name: macOS
on:
push:
branches:
- master
paths:
- '**'
- '!README.md'
- '!.gitignore'
jobs:
macos-test:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- run: bash init.sh
- run: bash install.sh
- run: bash iterm2/init.sh
- run: bash vscode/init.sh
- run: bash vscode/install.sh
- run: bash macos.sh
macos.yml では、一連のスクリプトを実行して macOS 上での動作確認を取るようにしています。
その他自動化できなかった/しなかった項目
できると嬉しいが急を要さないもの、検索しても見当たらなかった設定項目などを、今後の改善点として以下に挙げます。
google IME の設定
mac のセットアップに関する記事を見ると、日本語入力システムには大抵 google IME を使っているようでした。 mac デフォルトのと比べても google IME の方が使いやすいと感じたのでこれを使っています。
日本語入力の環境設定（句読点を “,.” にして、記号や数字の半角・全角の設定）が GUI でできるのはもちろんですが、これを CLI で設定する方法が見つからなかったので TODO リスト入りとなっています。
TouchBar の表示をファンクションキーにする
2019 年の macbook pro には本来ファンクションキーがある場所に TouchBar というインターフェースが付いており、ソフトウェアキーが配置できるスペースがあります。
デフォルトだとここに音量や画面輝度の調節キーがあるのですが、見慣れないキーが気になって遊んでしまいそうになりますし、なんだかんだ一番しっくりくるファンクションキーを表示する設定にしています。
これを CLI で設定する方法もパッと見つけられず、できませんでした。 よく探せば見つかりそうな気がする設定項目 No.1 ではあります。
セットアップのワンライナー化
現状だとスクリプトを 1 つずつ指定して実行するフローになっていますが、OS、目的ごとに、たった 1 つのコマンドで必要なスクリプト全てを実行できたら素晴らしいと思います。
makefile を書いたり全体の統括的なスクリプトを用意したりして実現する案と、依存関係のシンプルさを重視してワンライナー化は諦める方針とで考え中です。
pmset
pmset コマンドで mac の電源管理設定ができます。
スリープまでの時間、ディスプレイをオフにするまでの時間、スタンバイモードの有効化/無効化などなど、バッテリーの持ちに関わる部分なので、普段の使用状況を鑑みながら最適化していきたいところです。
まとめ
エイリアスやキーボード設定でオレオレ仕様にするのは好みではないので必要最低限の設定 +α という感じです。
早く実機で試してみたい…