Githubのプルリク時にeslintをチェック(reviewdog)

reviewdog/action-eslint: Run eslint with reviewdog

導入

.github/workflows/reviewdog.yml を追加し、以下をコピペする

.github/workflows/reviewdog.yml

name: reviewdog
on: [pull_request]
jobs:
  eslint:
    name: runner / eslint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: reviewdog/action-eslint@v1
        with:
          reporter: github-pr-review # Change reporter.
          eslint_flags: 'src/**/*.{ts,tsx,js,jsx}'

手順

1. eslintに引っかかりそうなコードをコミットする。例）console.log()など
2. プルリクを作る
3. Actionsが動くのを確認する

しばらく待つとプルリクのコメント欄に自動で指摘が入る。

eslintに引っかかった場合に、エラーとして通知したい

上記のままであれば、指摘は入るがAll checks have passedとなっていてレビュアーは失敗に気づかないこともあるかもしれない。
eslintチェックに引っかかった場合にはエラーとしたい

fail_on_error: 'true'を追加します。

.github/workflows/reviewdog.yml

name: reviewdog
on: [pull_request]
jobs:
  eslint:
    name: runner / eslint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: reviewdog/action-eslint@v1
        with:
          reporter: github-pr-review # Change reporter.
          eslint_flags: 'src/**/*.{ts,tsx,js,jsx}'
          fail_on_error: 'true'　←　追加

これで、次のコミット時でActionが走り、All checks have failedになりました。