Master spell check install#
Master spell check code#

I kept making small commits over time and eventually I got there.

The first time I enabled this with a PR, I got a lot of failures, as one might expect. Once I committed this file to a PR, I saw the checking begin. When it finds an error, it returns a non-zero exit code, which fails the build. It runs cSpell in the container on all my markdown files, using my config file.

Master spell check install#

It runs a command to install cSpell globally within the container.It pulls a Docker container that is published to Docker Hub, which has been set up by someone else to set up Node (thanks, people who care about OSS!).

Master spell check code#

It checks out all my code for the blog, which includes all the markdown files.

It runs the GitHub action on an Ubuntu instance.

It runs on any main branch commit or any PR against my main branch.

jobs : spellchecking : runs-on : ubuntu-latest steps : - uses : actions/ name : Check out the code - uses : actions/ name : Run spell check with : node-version : ' 12' - run : npm install -g cspell - run : cspell -config. pull_request : branches : - main # Modify if you use a different main branch name, such as the legacy 'master' name. Name : Housekeeping on : push : branches : - main # Modify if you use a different main branch name, such as the legacy 'master' name. github is a folder in this case.)Īdd the following, changing the values as they suit you:

Create a GitHub Action workflow by creating a file in your repo at.

Add a cSpell.json file to the root of your repository to capture words to add to the dictionary.

Now, you’ll start getting feedback on what needs fixing when you have a file open. In the extensions window, search for Code Spell Checker and install it (extension ID: de-spell-checker) Installing the Code Spell Checker Extension

A GitHub Action to run as part of my pull requests.

A config file to allow for ignoring some words/patterns or adding words to a dictionary.

A VS Code Extension, Code Spell Checker, that gives me cSpell-based checking within the IDE.

I don’t like that, so I decided to fix it and automate it. I’m always worried I’ll have a typo in my blog posts, and I suspected I had a few lying around in these pages. Adding Spell Checking to my Blog’s Build Process with GitHub Actions and cSpell