Lycolog

概要

• Jinja2で作られている
  • Python向けのテンプレートエンジン
  • これを理解することで自在にカスタマイズできる。たぶん
• テンプレート変数について、まともなリファレンスはないので、mkdocsのGitHubリポジトリを眺めて知るのが早い
  • www.mkdocs.org にも一応書いてあるが、網羅されていない

カスタマイズ方法

• まずはMaterial for MkDocsを読んでリファレンスを理解する
  • 設定で解決する内容ならここで終わり
• テンプレートのカスタマイズが必要な場合、overrides/main.htmlを生やしてブロック単位でいじる
  • 元のブロックはgithub.comを参考にする
  • 構文はjinja.palletsprojects.com

• runコマンドでサービスを指定してコマンドを蹴ると実行結果が取れる
  • e.g. docker-compose run node-git 'npm' 't'
• コマンドを複数繋げる場合はシェルを呼び出してやる
  • e.g. docker-compose run node-git 'sh' '-c' '"ls -la && grep foo"'

MSYS2のzshで.zshを叩いたときに次のエラーが出るときの対策

./test.zsh: 2 行: read: -q: 無効なオプションです
read: 使用法: read [-ers] [-a array] [-d delim] [-i text] [-n nchars] [-N nchars] [-p prompt] [-t timeout] [-u fd] [name ...]

動かないシェルスクリプトのサンプル

• 但しこれは動く
  • echo "yes or no (y/N): "; if read -q; then; echo hello; else echo abort; fi

echo 'yes or no (y/N): '
if read -q; then
  echo y
else
  echo n
fi

解決方法

• 次のようにshebangを入れてやる
  • 多分shが呼ばれているのだと思う

#!/bin/zsh

echo 'yes or no (y/N): '
if read -q; then
  echo y
else
  echo n
fi

いくつか方法があるが、正直どれも使わないに越したことはない。しかし業務上の様々なしがらみなどでやむを得ず使うハメになることがある

ローカルで無視しておきたいがリモートで変更があったときには検知したいケース

リモートの変更まで無視してしまうと事故の元なので一番オススメ
git update-index --[no-]skip-worktreeを使う

• .envのような個々人の環境によって異なるものがリポジトリ管理対象になっているときに使える
• ブランチの切り替え時のコンフリクト対策としてはスクリプトを組んでおくと楽
  • 昔作ったやつ

ブランチ切り替え時のテクニック

• ブランチで--skip-worktreeとなっている対象の変更を隠す

# --skip-worktreeの一括解除
git ls-files -v | grep ^S | sed -r 's/^S.(.+)$/\1/g' | xargs git update-index --no-skip-worktree
# 出てきた変更を全てスタッシュに入れる
git stash push -q -m stash_skiptree

• 前項で隠した変更を再現して、--skip-worktreeし直す

# stashから戻す
git stash pop -q
# この時点での差分に対し--skip-worktree
git diff --name-only HEAD | xargs git update-index --skip-worktree

常に無視しておきたいケース

リモート側で重大な変更があったときにローカルで検知できないので事故りやすい
git update-index --[no-]assume-unchangedを使う
使ったことないので存在だけ記述して終わり

リポジトリの管理下にないファイルを常に無視するケース

--[no-]skip-worktreeも--[no-]assume-unchangedも使えないときにユースケースが存在するやつ

• .git/info/excludeに無視対象のパスを記述することで無視できる
• 自分のローカルにだけこっそり存在するdocker-compose.override.yamlみたいなのを無視するときに使える

余計な例外を投げてくるのが面倒なのでそれを無視できるように

確認環境

内容

"ignore"セクションを追加してそこに書いたファイルから出た例外は無視される

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Listen for Xdebug",
            "type": "php",
            "request": "launch",
            "port": 9001,
            "ignore": [
                "**/vendor/laravel/framework/src/Illuminate/Filesystem/Filesystem.php"
            ]
        }
    ]
}