misspell で無視したい単語をgitで管理する方法

スペルチェッカー misspell。超便利なのでみんな使いましょう

github.com

前提

misspell では、-i オプションにカンマ区切りで、スペルチェックを無視する単語を追加できる

misspell -i "hoge,fuga" .

やりたいこと

misspell のチェックを無視する単語を git で管理したい

  • スペルチェッカー的には間違いだけれど、いろんな経緯で使わざるを得ない単語とか

解決方法

  • 無視する単語を .misspell_ignore.txtに保管
  • そのファイルで -i オプションを作るスクリプトを組んだ

ファイル

.misspell_ignore.txt

hoge
fuga
  • 1行1単語(差分をわかりやすくするため)

./script/misspell.sh

#!/bin/sh
misspell -i `cat .misspell_ignore.txt | tr '\n' ','` -error .
  • .misspell_ignore.txt の中身をカンマ区切りに変換して -i オプションに渡している

これで、無視したい単語をgitで管理できる!! 🎉

CircleCIで使いたい場合

checkout してから、上記のスクリプトを実行する

  misspell:
    docker:
      - image: nickg/misspell
    steps:
      - checkout
      - run: ./script/misspell.sh

workflows:
  version: 2
  ci:
    jobs:
      - misspell

参考

kakakakakku.hatenablog.com