GitHub Actionsでeslintを動かすだけでFiles changedにlint errorが表示されて便利

GitHub Actionsでeslintを動かすだけでFiles changedにlint errorが表示されるのが便利すぎたので紹介。

様子

https://github.com/shibayu36/typescript-cli-project/pull/7/files

やり方

GitHub Actionsでsetup-nodeを使った上でeslintを動かすだけ。

• まずGitHub Actionsでlintを実行するように設定する
  • .github/workflows/lint.yml
• npm run lintの実体はこんな感じ
  • package.json

これだけで上で紹介したようにlintのエラーがFiles changedに出てくる。便利。

仕組み

Problem Matchersという仕組みを使っているみたい。例えばsetup-nodeだと

• .github/eslint-stylish.jsonのようにProblem Matchersの正規表現が作られている
• src/main.ts#L36のようにProblem Matchersが有効化されている
  • https://github.com/actions/toolkit/blob/master/docs/commands.md#problem-matchers も参照

のようになっているので、setup-nodeをするだけでeslintの出力をparseしてくれるようになるようだ。

このような仕組みを使えば、自分で便利なProblem Matchersを作れそうだ。

まとめ

今回は、GitHub Actionsでeslintを動かすだけでFiles changedにlint errorが出て便利という紹介と、その仕組みについて軽く調べたのでブログに書いておいた。便利そうなProblem Matchersを思いついたら自分で書いてみようと思う。