tkd2017の勉強ブログ

日々の勉強をアウトプットするブログ

textlint-filter-rule-whitelistが外部ファイルに対応しました(v1.2.1)

textlintという日本語文章の校正に便利なツールを使っています。会社のブログでも紹介しました。

textlintのチェックルールはプラグインとして提供されています。その中にtextlint-filter-rule-whitelistという、指定した単語(または正規表現)をチェック対象から外せるフィルタルールがあります。

次のように.textlintrcに除外したい単語を指定することで、チェック時に無視できます。

{
  "filters": {
    "whitelist": {
      "allow": [
        "はてなブログ"
      ]
    }
  }
}

ただ単語が増えてくると.textlintrcが肥えていきそうだったのが気になりました。これをTwitterでつぶやいたところ開発者のazuさんに捕捉され、言われるがままissue立てたらあっという間に実装されてました(v1.2.1)。

圧倒的感謝。

これで次のように定義できるようになりました。

  • whitelist/proper-noun.yml
- はてなブログ
  • .textlintrc
{
  "filters": {
    "whitelist": {
      "whitelistConfigPaths": [
        "./whitelist/proper-noun.yml"
      ]
    }
  }
}

後はこのファイルに単語を追加していけばよくなりました。ファイルで分類することも容易にできます。便利!*1

実は実装の連絡をもらってアップデートしたらエラーで動きませんでした。結論としては、原因はatom pluginで使われているtextlintのバージョンが古いことでした。が、azuさんにhotfixで神速対応していただきすぐに使えるようになりました(v1.2.2)。

この辺のやりとりもissueでさせてもらいました。

github.com

issueオープンからリリースまで18分!

というわけで、ちょっとしたつぶやきから新機能を実装してもらえました。ありがとうございました!

(本当は自分でPR出せたらよかったなぁ)

*1:allowも引き続き使えます