Find Linter and Matching VS Code Plugin to Spell Check Site

[kathrynsilvaconway]

Dependency

• Identify all mispelled words on site and make issues to fix #2401

Overview

Our website needs to be free of misspellings so that our reputation for quality is maintained. For this issue, we will find a third party linter and VS Code plugin to spell check all text in pull requests that will appear on the website.

Action Items

• Research various third party linters to find one we can use to check pull requests for spelling errors.
• Verify that the vendor also makes a matching VS Code plugin that our devs can use locally to check their spelling before pushing code. The linter and the plugin must come from the same source.
  • If you do not find a matching set, bring to merge team/dev leads to discuss next best option and present to product.
• Test the linter/plugin combination in your own repository to be sure they work as expected.
• Once we identify and apply the spell checker go through this spreadsheet from design team
  • Checking off the spelling/grammar errors that have been fixed (don't worry if linter doesn't fix the grammatical errors, we will make a separate issue for another linter if it doesn't fix both)
  • If all spelling errors are corrected then this issue is completed, make a pull request (Merge team may need to install the linter but to verify functionality locally it will be helpful to see the repo it worked in)

Resources/Instructions

• Spreadsheet from design team with all the misspellings they found
• VS Code Plugins for spelling
• Web Based Chrome Extension checker
• Web based external checker - more sensitive than the chrome extension however will only check pages that are linked to main page (not about page, etc.)
• Figma spell check plug in SPELL
• Figma spell check plug in Spellchecker
• Bonnie's Query for spell checkers
  • When going through the query list make sure to check that the spell checker can work in VS Code as well as GitHub CI/CD

[JessicaLucindaCheng]

@kathrynsilvaconway

• I don't think Fix misspelled words on citizen-engagement-card.yml file from "policymaking" to "policy making" #2909 and Identify all mispelled words on site and make issues to fix #2401 are dependencies for this issue. Dependencies are issues that need to be completed before this issue can be worked on. Issue Fix misspelled words on citizen-engagement-card.yml file from "policymaking" to "policy making" #2909 is to be completed after this issue is done because we want the misspellings to be corrected after we find the linter so we have something for the linter to find.
  • completed
• You should include the list of spelling errors to use to check that the plugin is effective. See the bottom of this comment for the list: Identify all mispelled words on site and make issues to fix #2401 (comment)
• You may want to add a link to Identify all mispelled words on site and make issues to fix #2401 in the Resources/Instructions section so that we can trace back where this issue came from.

[ExperimentsInHonesty]

@kathrynsilvaconway Good News! I figured out how to find the CI/CD spell checkers, so that we can try to find the pair that we are looking for. Here are the ones that work on GitHub. This probably includes action. So they may not all be suitable. What we are looking for it one that works on PRs or commits.
https://github.com/marketplace?type=&verification=&query=spell

[ExperimentsInHonesty]

@kathrynsilvaconway issue #2401 is not a dependency, its the issue that informs the making of this issue. #2401 (comment)

[blulady]

@kathrynsilvaconway

* I don't think [Fix misspelled words on citizen-engagement-card.yml file from "policymaking" to "policy making" #2909](https://github.com/hackforla/website/issues/2909) and [Identify all mispelled words on site and make issues to fix #2401](https://github.com/hackforla/website/issues/2401) are dependencies for this issue. Dependencies are issues that need to be completed before this issue can be worked on. Issue [Fix misspelled words on citizen-engagement-card.yml file from "policymaking" to "policy making" #2909](https://github.com/hackforla/website/issues/2909) is to be completed **after** this issue is done because we want the misspellings to be corrected **after** we find the linter so we have something for the linter to find.
  
  * [x]  completed

* You should include the list of spelling errors to use to check that the plugin is effective. See the bottom of this comment for the list: [Identify all mispelled words on site and make issues to fix #2401 (comment)](https://github.com/hackforla/website/issues/2401#issuecomment-1146721700)

* You may want to add a link to [Identify all mispelled words on site and make issues to fix #2401](https://github.com/hackforla/website/issues/2401) in the Resources/Instructions section so that we can trace back where this issue came from.

Using the spelling errors to check if the Spell-Checker we use is a brilliant idea but I am uncertain about some of the items that are in the list because:
`- line 41 "your" to "you're" Mobile_responsiveness.yml grammatical error

• line 33 each changes to each change in Mobile_responsiveness.yml grammatical error
• line 46 figma should be capitalized in Mobile_responsiveness.yml --> Not sure if this will be caught since it isn't a dictionary word
• "it's" should be "its" on homepage in "Hack for LA is a project of Code for America and is it's official Los Angeles chapter." grammatical error
• "Non-profit" button and description "I am a non-profit organization." should be "nonprofit" on homepage both of these are acceptable in Google docs, uncertain if a spell checker would pick this up`

There are some genuine spelling errors:

• "responsivenes" should be "responsiveness" in How to use Figma effectively on Open Source Volunteer Teams card on https://www.hackforla.org/toolkit/
• In 1.5.a Docker installation troubleshooting of CONTRIBUTING.md, fix spelling of "te" to "the" in "the following wiki page is a guide for solving te issue:"
• "elipsis" should be "ellipsis" in "Click the vertical elipsis located at the top right of the survey form" on https://www.hackforla.org/guide-pages/survey-reporting-dashboard-guide
• "elipsis" should be "ellipsis" in "VERTICAL ELIPSIS" on https://www.hackforla.org/guide-pages/survey-reporting-dashboard-guide
• "elipsis" should be "ellipsis" in "(2) Hovering over the new page added within the dropdown menu, you will see a vertical elipsis." on https://www.hackforla.org/guide-pages/survey-reporting-dashboard-guide

Which makes me wonder:

• does the spell checker also address grammatical errors?
• could we have the Dev(or us) create their own spelling/grammatical errors to test when running the spell check?
• is 3546 a dependency for Identify all mispelled words on site and make issues to fix #2401? Do we need to hold on, close or release Identify all mispelled words on site and make issues to fix #2401 because if we have the Dev (or us) create spelling issues that we then test for... but also if we release it by the time someone picks it up, it might not exist anymore? see the comment that follows for answer.