Github actionとcspellを使ったブログのビルドプロセスへのスペルチェックの追加

私は、私が私のブログ柱でタイポを持っていると常に心配しています、そして、私は私がこれらのページで横たわっている少数を持っていると思いました.私はそれが好きではないので、私はそれを修正し、それを自動化することを決めた.
解決策は次のとおりです.

大王cSpell 工具

VSコード拡張Code Spell Checker , これは、cspellベースのチェックをIDE内で確認できます

いくつかの単語/パターンを無視したり、辞書に単語を追加するための設定ファイル

私のプル要求の一部として実行するgithubアクション

コードスペルチェッカー拡張モジュールのインストール
ウィンドウで検索するCode Spell Checker そして、それをインストールします.streetsidesoftware.code-spell-checker )
今、あなたはファイルを開くときに固定する必要があるものについてのフィードバックを得る開始します.それは本当に役立つ.

設定ファイルを作成する

加えるcSpell.json ファイルを辞書に追加するには、リポジトリのルートにファイルをキャプチャします.cspellファイルの例can be found here

ビルドの一部として実行する
このためにGithubアクションを利用します.

あなたのrepoのファイルを作成することによって、Githubアクションワークフローを作成します.github/workflows/housekeeping.yml ( .github この場合のフォルダです.

次のように変更し、値を変更します.

name: Housekeeping

on:
  push:
    branches:
      - main # Modify if you use a different main branch name, such as the legacy "master" name.
  pull_request:
    branches:
      - main # Modify if you use a different main branch name, such as the legacy "master" name.

jobs:
  spellchecking:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        name: Check out the code
      - uses: actions/setup-node@v1
        name: Run spell check
        with:
          node-version: "12"
      - run: npm install -g cspell
      - run: cspell --config ./cSpell.json "**/*.md"

このGitHubアクションファイルは何ですか?

これは、メインブランチコミットまたは任意のpr私のメインブランチに対して実行されます

これは、Ubuntuのインスタンスでgithubアクションを実行します

これは、すべてのマークダウンファイルを含むブログのすべてのコードをチェックアウト

これはDeckerハブに公開されているDockerコンテナを引っ張っています.これは他の誰かがノードをセットアップするように設定されています.

コンテナ内でグローバルにcspellをインストールするコマンドを実行します

それは私のconfigファイルを使用して、すべての私のMarkdownファイル上のコンテナのcspellを実行します.エラーが発生した場合は、0以外の終了コードを返します.

このファイルをPRにしたら、チェックを始めました.

ウォッシュ、リンス、リピート
私がPRでこれを可能にした最初、私は多くの失敗を得ました.私は時間をかけて小さなコミットを作り続けました.走ったcspell --config ./cSpell.json "**/*.md" 私の端末から私は行き、問題がゼロになるまで変更を行った.

Voila!
現在、私はVSコードの中でローカルスペルチェックサポートを得て、Githubアクションを通して時間サポートを構築します.無料で!1 .
ハッピースペル!

無料で、私は他の誰かの非常にハードワークのおかげで、彼らはしばしば補償され、サポートされている下にあることを意味します.オープンソースプロジェクトに貢献するか、またはあなたがよりよく働くことを可能にした著者またはグループに寄付することを考えてください.↩