Skip to content

Create initial spell check configuration file #5313

@roslynwythe

Description

@roslynwythe

Overview

As developers introducing the use of the VSCode Code Spell Checker extension, we need to provide a folder-level configuration file cspell.json in the website folder, which will establish site spell check settings.

Action Items

  • You must use VS Code as your local text editor to install the VS Code extension for spell checking your codebase, The recommended installation method is to install Code Spell Checker directly from the VS Code text editor1. The extension can also be installed via the VS Code Marketplace website2
  • Create a new file cspell.json in the website (root) folder.
  • Copy/paste the following:
{
    "version": "0.2",
    "language": "en",
    // words - list of words to be always considered correct
    "words": [
        "collabathon"   
    ],
    "ignorePaths": [
        "node_modules",
        ".github"
    ]
}
  • Save the file then test the VSCode Spell Checker extension:
    • Open a few files in .github/workflows and confirm that no spell check errors appear
    • Open the file _includes/about-page/about-card-sustainability.html
      • Confirm that the term Collabathon is not marked as an error or unknown word
      • Confirm that the term Undebate is marked as an unknown word
  • Add/Commit the file cspell.json and proceed with a Pull Request in the usual manner

Resources/Instructions

Footnotes

  1. Installing Code Spell Checker from the VS Code text editor

  2. Code Spell Checker - VS Marketplace

Metadata

Metadata

Assignees

Type

No type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions