하고 싶은 것, 했던 것

Typescript 형식 오류가 포함 된 코드를 GitHub의 보호 지점에 병합하지 않도록 GitHub Actions 게다가 tsc 가 검지한 개소에 PR 코멘트로 주석해 주었으면 하는 날이 있다. 이번은 reviewdog 을 사용해 자동으로 주석하게 했다.
tsc 가 사용되고 있는 기성품 reviewdog 에, GitHub Action 의 에러를 자동으로 주석해 준다 그렇게 하지 않을까 하는 생각.

주석이 달린 모습
Run eslint with reviewdog

구현한 workflow

전제

프로젝트에 eslint의 TypeScript가 도입되었습니다.

yarn add -D typescript

구현한 Workflow

구현한 Workflow의 포인트는 이하 2점.

npmパッケージ 의 을 사용하는 것으로, typescript 위에서 Github　Action

Github　Actions 단계.

.github/workflows/main.yml

name: Test
on: [pull_request]

jobs:
  build:
    name: build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      # ref: https://github.com/actions/setup-node#v2
      - uses: actions/setup-node@v2
        with:
          node-version: "14"
      # ref: https://github.com/reviewdog/reviewdog#github-action-reviewdogaction-setup
      - uses: reviewdog/action-setup@v1
        with:
          reviewdog_version: latest
      # ref: https://github.com/actions/cache/blob/main/examples.md#node---yarn
      - name: Get yarn cache directory path
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"
      - uses: actions/cache@v2
        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-
      - name: Install Dependencies
        run: yarn --frozen-lockfile
      # ref: https://github.com/reviewdog/reviewdog#available-pre-defined-errorformat
      - name: Typecheck
        run: tsc --pretty false --noEmit | reviewdog -f=tsc -reporter=github-pr-review -fail-on-error=true
        env:
          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.github_token }}

각 포인트에 대해

reviewdog/action-setup@v1
reviewdog/action-setup@v1 에서 reviewdog 위에 Typecheck 를 설치했습니다. GitHub Actions는 다양한 체크 툴의 출력에 대응하고 reviewdog 옵션을 붙여 실행하면 그 일람을 볼 수 있다. 이 검사 도구의 출력을 받아 결과를 reviewdog의 PR에 주석을 달 수 있습니다.
-list 결과

terminal

 ❯❯❯ reviewdog -list
rdjson          Reviewdog Diagnostic JSON Format (JSON of DiagnosticResult message)                                             - https://github.com/reviewdog/reviewdog
rdjsonl         Reviewdog Diagnostic JSONL Format (JSONL of Diagnostic message)                                                 - https://github.com/reviewdog/reviewdog
diff            Unified Diff Format                                                                                             - https://en.wikipedia.org/wiki/Diff#Unified_format
checkstyle      checkstyle XML format                                                                                           - http://checkstyle.sourceforge.net/
ansible-lint    (ansible-lint -p playbook.yml) Checks playbooks for practices and behaviour that could potentially be improved  - https://github.com/ansible/ansible-lint
brakeman        (brakeman --quiet --format tabs) A static analysis security vulnerability scanner for Ruby on Rails applications- https://github.com/presidentbeef/brakeman
cargo-check     (cargo check -q --message-format=short) Check a local package and all of its dependencies for errors            - https://github.com/rust-lang/cargo
clippy          (cargo clippy -q --message-format=short) A bunch of lints to catch common mistakes and improve your Rust code   - https://github.com/rust-lang/rust-clippy
dotenv-linter   Lightning-fast linter for .env files. Written in Rust                                                           - https://github.com/dotenv-linter/dotenv-linter
dotnet          (dotnet build -clp:NoSummary -p:GenerateFullPaths=true --no-incremental --nologo -v q) .NET Core CLI            - https://docs.microsoft.com/en-us/dotnet/core/tools/
eslint          (eslint [-f stylish]) A fully pluggable tool for identifying and reporting on patterns in JavaScript            - https://github.com/eslint/eslint
eslint-compact  (eslint -f compact) A fully pluggable tool for identifying and reporting on patterns in JavaScript              - https://github.com/eslint/eslint
fasterer        Speed improvements suggester                                                                                    - https://github.com/DamirSvrtan/fasterer
go-consistent   Source code analyzer that helps you to make your Go programs more consistent                                    - https://github.com/quasilyte/go-consistent
golangci-lint   (golangci-lint run --out-format=line-number) GolangCI-Lint is a linters aggregator.                             - https://github.com/golangci/golangci-lint
golint          linter for Go source code                                                                                       - https://github.com/golang/lint
gosec           (gosec -fmt=golint) Golang Security Checker                                                                     - https://github.com/securego/gosec
govet           Vet examines Go source code and reports suspicious problems                                                     - https://golang.org/cmd/vet/
haml-lint       Tool for writing clean and consistent HAML                                                                      - https://github.com/sds/haml-lint
hlint           Linter for Haskell source code                                                                                  - https://github.com/ndmitchell/hlint
msbuild         (msbuild /property:GenerateFullPaths=true /nologo /v:q) Microsoft Build Engine                                  - https://docs.microsoft.com/en-us/visualstudio/msbuild/msbuild
pep8            Python style guide checker                                                                                      - https://pypi.python.org/pypi/pep8
phpstan         (phpstan --error-format=raw) PHP Static Analysis Tool - discover bugs in your code without running it!          - https://github.com/phpstan/phpstan
psalm           (psalm --output-format=text) Psalm is a static analysis tool for finding errors in PHP                          - https://github.com/vimeo/psalm
puppet-lint     Check that your Puppet manifests conform to the style guide                                                     - https://github.com/rodjek/puppet-lint
reek            (reek --single-line) Code smell detector for Ruby                                                               - https://github.com/troessner/reek
rubocop         A Ruby static code analyzer, based on the community Ruby style guide                                            - https://github.com/rubocop-hq/rubocop
sbt             the interactive build tool                                                                                      - http://www.scala-sbt.org/
sbt-scalastyle  Scalastyle - SBT plugin                                                                                         - http://www.scalastyle.org/sbt.html
scalac          Scala compiler                                                                                                  - http://www.scala-lang.org/
scalastyle      Scalastyle - Command line                                                                                       - http://www.scalastyle.org/command-line.html
slim-lint       Tool to help keep your Slim files clean and readable                                                            - https://github.com/sds/slim-lint
sorbet          A fast, powerful type checker designed for Ruby                                                                 - https://github.com/sorbet/sorbet
standardjs      (standard) JavaScript style guide, linter, and formatter                                                        - https://github.com/standard/standard
standardrb      (standard) Ruby style guide, linter, and formatter                                                              - https://github.com/testdouble/standard
stylelint       A mighty modern CSS linter                                                                                      - https://github.com/stylelint/stylelint
tsc             TypeScript compiler                                                                                             - https://www.typescriptlang.org/
tslint          An extensible linter for the TypeScript language                                                                - https://github.com/palantir/tslint

TypeCheck 단계

.github/workflows/main.yml 부분

 - name: Typecheck
        run: tsc --pretty false --noEmit | reviewdog -f=tsc -reporter=github-pr-review -fail-on-error=true
        env:
          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.github_token }}

GitHub 의 컴파일러인 reviewdog -list 는 TypeScript 옵션을 붙이면 에러 출력이 단순화된다. tsc 가 받아들인다 --pretty false 의 출력은 단순화된 (분)편이므로, 이 옵션을 부여한 것을 파이프( reviewdog )로 tsc 에 보낸다.
| 의 유무에 따른 차이

terminal

❯❯❯ tsc
src/components/IndexPage.tsx:3:7 - error TS2322: Type 'string' is not assignable to type 'number'.

3 const a: number = "hoge";
        ~


Found 1 error.

❯❯❯ tsc --pretty false
src/components/IndexPage.tsx(3,7): error TS2322: Type 'string' is not assignable to type 'number'.

reviewdog 에는 tsc --pretty 옵션으로 어느 체크 툴의 출력이 입력되고 있는지 전하고 있다. 여기서 reviewdog 옵션과 필요한 환경 변수를 붙이는 것으로, 자동으로 PR에 코멘트가 된다. 필요한 환경 변수는 -f이며, -reporter=github-pr-review의 $REVIEWDOG_GITHUB_API_TOKEN에서는 위와 같은 설정을 하면 된다.

또 GitHub Actions 에 Workflow 옵션을 붙이는 것으로, 에러가 입력되면 reviewdog 의 PR 의 체크를 실패시키도록 하고 있다.

끝에

최근 저는 비록 혼자 만드는 것도 -fail-on-error=true 등을 정돈하는 것을 즐겨 하고 있습니다. 우리가 내는 PR에 코멘트를 묻지 않는 곳, bot에라도 코멘트되면 활기차고 좋은 것이군요. 혼자 만드는 프로젝트야말로 그 점을 확인할 필요가 없는데, 거기서, 로봇이 되고 고양이가 낙지 나름대로 자신의 부주의를 지적해 주었으면 하는 것은, 뭔가 만들기에 있어서 묶어 플레이에 재미를 느끼는 손수이기 때문이다 라고 생각합니다.