깃헙 액션으로 코드 스펠링 체크를 하자(오타체크)

부끄러운 일이지만
클라이언트분들과 협업을 하면서
주석이나 API Tag에 오타를 내서 이를 수정해달라는 요청을 받았다.

깃헙 액션에 Pull request를 올렸을 때 오타체크를 하는 작업을 할 수 있다.

우선 github workflow에

name: Spellcheck Action
on: push

jobs:
  spellcheck:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: rojopolis/spellcheck-github-actions@0.46.0
        with:
          config_path: config/.spellcheck.yml

이 스크립트를 넣어준다.

spellcheck-github-actions를 사용할 수 있게끔 해준다.
브랜치에 push를 하거나, pull request를 보낼 때 스펠링 체크를 할 수 있다.

이를 위해서 config/ 경로에 spellcheck.yml 파일을 만들어주어야 한다.

matrix:
  - name: Java
    aspell:
      lang: en
    dictionary:
      encoding: utf-8
      wordlists:
        - wordlists.txt
    pipeline:
      - pyspelling.filters.html:
          comments: false
    sources:
      - 'src/main/java/com/plaything/api/domain/*/controller/*Controller.java'    # Controller 디렉토리만 검사
    excludes:
      - 'src/main/generated/**'
      - 'src/test/**'
    default_encoding: utf-8

영어 스펠링을 딕셔너리에 맞춰서 스펠링 체크를 해준다.
처음에 모든 java 파일을 다 했더니 별의별 파일까지 다 스펠링 체크가 되는 탓에

source를 swagger에서 보여지는 Controller부분만 체크하도록 했다.

이렇게 해주면

위 사진처럼 오타가 난 것으로 추정되는 단어들의 목록이 로그로 남는다.

루트 폴더에는 wordlists로 스펠링 체크를 하지 않을 단어들을 넣어준다.

이런식으로 실제 영단어가 아니라서 스펠링체크에 걸리는 어노테이션이나 내가 만든 클래스 명들을 제외목록에 넣어주면 된다.