Github Actionsでのtypo防止

README.md

yarn add cspell -d

https://zenn.dev/75asa/articles/vanish-typo-by-github-action-and-vscode#github-actions-%E3%81%AE%E8%A8%AD%E5%AE%9A

cspell.cjs

// .cspell/cspell.cjs

/** @type { import("@cspell/cspell-types").CSpellUserSettings } */
module.exports = {
  $schema:
    "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
  version: "0.2",
  // dictionaryDefinitions[number].name と同じ名前を指定する
  dictionaries: ["words"],
  // カスタム辞書ファイル配列、複数指定可能
  dictionaryDefinitions: [
    // 辞書ファイル
    {
      name: "words",
      path: "./words.txt",
      addWords: true,
    },
  ],
  // cSpell 除外設定
  ignorePaths: [
    "./yarn.lock",
    "**/*.json",
    "**/*.svg",
    "**/*.md",
    "**/*.mjs",
    "**/*.sh",
    "**/*.yml",
    "**/*.yaml",
    "**/*.config.js",
    "**/*.config.ts",
    "**/api.ts",
    "**/.cspell/**/*",
  ],
}

settings.json

// .vscode/settings.json

{
  "cSpell.customDictionaries": {
    "words": {
      "name": "words",
      "path": "${workspaceRoot}/.cspell/words.txt",
      "description": "Words used in this project",
      "addWords": true
    },
    "custom": true,
    "internal-terms": false
  }
}

spell-check.yml

name: spell-check

on:
  pull_request:
    types: [opened, synchronize, edited]

jobs:
  spell-check:
    runs-on: ubuntu-latest
    # [bot]を含む場合は除外
    if: ${{ !contains(github.actor, '[bot]') }}
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0
      - uses: reviewdog/action-setup@v1
        with:
          reviewdog_version: latest
      - uses: actions/setup-node@v2
        with:
          node-version: "18.x"
      - name: Install dependencies
        run: yarn --frozen-lockfile
        shell: bash
      - uses: reviewdog/action-setup@v1
        with:
          reviewdog_version: latest
      - name: execute spell-check
        env:
          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          git diff remotes/origin/$GITHUB_BASE_REF --name-only \
            | yarn spell-check \
            | reviewdog -efm="%f:%l:%c - %m" -reporter=github-pr-review

words.txt

// .cspell/words.txt

reviewdog
YYYYMMDDEEE
hhmm
gtag
nextjs