Epic: Process results of sitewide spell check and preparing cspell configuration file

[roslynwythe]

Dependencies

• Epic: Create template, spreadsheet and list of issues for spellcheck audit #5248

Overview

Code Spell Checker in VSCode flags a large number of words, most of which are not misspellings but rather abbreviations and HfLA-specific terms that should be specified as valid words in the Code Spell Checker configuration file. We will build a configuration file that specifies which files and words should be excluded from spell checking, and we also need to fix misspelled words.

Action Items

• Create issue Epic: Create template, spreadsheet and list of issues for spellcheck audit #5248
  • Create a row for each file (html, md, json, yaml) file that contains text for display on the website and is appropriate to include in the Code Spell Check, in the HfLA spelling audit spreadsheet¹
  • To exclude files from spell checking, use the setting cSpell:ignore in cspell.json
  • Create Epic for creating auditing issues
  • Each issue will cover one file.
  • The issue will require that for each word flagged as an error, if the word is actually misspelled, a row is populated in the "misspelled words" sheet. If it is a false positive, the word should be listed in the "whitelist words" sheet, if it is not already listed.
• Create Epic for fixing misspellings
• Create Epic for adding false positives to spell checker configuration file

Resources/Instructions

• ? part of Create a Roll Out Plan for adding Code Spell Checker VS Code Extension #4349

Footnotes

1. HfLA spelling audit spreadsheet ↩

[roslynwythe]

CLosed as not planned. The planned child issues were listed in #4349 (comment)

[roslynwythe]

• Closed as not planned. See Epic: Create issues to add false positives to cspell.json #5312.