Research alternative spell check packages

[jburns24]

We recently added a spell check package to the bootcamp to fix errors easily and have some automation around typos. The package we picked markdown-spellchecker is not well maintained and not very extensible

https://www.npmjs.com/package/markdown-spellcheck
https://www.npmjs.com/package/cspell

Let's explore something like cspell or another well maintained npm spell checker. Things that I am looking for are

• well maintained
• extensible configuration
• pattern support in dictionaries
• git hook on pre-commit
• and then github action on pull request

[ianhundere]

configured:

• added cspell
• added pre-commit as per:
  • https://www.npmjs.com/package/cspell under "Git commit-hooks"; below is the output when committing:

Projects/devops-bootcamp/package.json:2:19 - Unknown word (bootcamp)
Projects/devops-bootcamp/package.json:4:34 - Unknown word (Bootcamp)
Projects/devops-bootcamp/package.json:19:6 - Unknown word (bootcamp)
Total 0 (delta 0), reused 0 (delta 0), pack-reused 0
remote:
remote: Create a pull request for '265_adds_cspell_and_removes_markdown-spellcheck' on GitHub by visiting:
remote:      https://github.com/liatrio/devops-bootcamp/pull/new/265_adds_cspell_and_removes_markdown-spellcheck
remote:
remote: GitHub found 5 vulnerabilities on liatrio/devops-bootcamp's default branch (2 high, 3 moderate). To find out more, visit:
remote:      https://github.com/liatrio/devops-bootcamp/security/dependabot
remote:
To github.com:liatrio/devops-bootcamp.git
 * [new branch]      265_adds_cspell_and_removes_markdown-spellcheck -> 265_adds_cspell_and_removes_markdown-spellcheck
branch '265_adds_cspell_and_removes_markdown-spellcheck' set up to track 'origin/265_adds_cspell_and_removes_markdown-spellcheck'.

• added config file
• removed markdown-spellcheck

a quick look at the output when it comes across words that aren't found in the respective dictionary:

devops-bootcamp/_sidebar.md:15:10 - Unknown word (Liatrio)
devops-bootcamp/_sidebar.md:66:14 - Unknown word (Kanban)
devops-bootcamp/_sidebar.md:83:19 - Unknown word (Qube)
devops-bootcamp/1-introduction/1.0-overview.md:5:10 - Unknown word (Liatrio's)
devops-bootcamp/1-introduction/1.0-overview.md:6:76 - Unknown word (Bootcamp)
devops-bootcamp/1-introduction/1.1-devops-defined.md:10:18 - Unknown word (Bootcamp)
devops-bootcamp/1-introduction/1.1-devops-defined.md:14:19 - Unknown word (kungfu)
devops-bootcamp/1-introduction/1.1-devops-defined.md:65:7 - Unknown word (Inclusivity)
devops-bootcamp/1-introduction/1.1-devops-defined.md:77:96 - Unknown word (Hightower)
devops-bootcamp/1-introduction/1.1-devops-defined.md:82:17 - Unknown word (toolset)
devops-bootcamp/1-introduction/1.1-devops-defined.md:84:26 - Unknown word (Roadmap)
devops-bootcamp/1-introduction/1.1-devops-defined.md:84:89 - Unknown word (toolset)
devops-bootcamp/1-introduction/1.1-devops-defined.md:84:171 - Unknown word (bootcamp)
devops-bootcamp/1-introduction/1.2-liatrio-and-devops.md:1:3 - Unknown word (Liatrio)
devops-bootcamp/1-introduction/1.2-liatrio-and-devops.md:17:1 - Unknown word (Liatrio)
devops-bootcamp/1-introduction/1.2-liatrio-and-devops.md:39:14 - Unknown word (Liatrio)
devops-bootcamp/1-introduction/1.2.1-dojo.md:2:3 - Unknown word (dōjō)
devops-bootcamp/1-introduction/1.3-basics.md:3:190 - Unknown word (Bootcamp)
devops-bootcamp/1-introduction/1.3.1-unix.md:20:93 - Unknown word (liatrio)
devops-bootcamp/1-introduction/1.3.1-unix.md:22:37 - Unknown word (liatrio)
devops-bootcamp/1-introduction/1.3.1-unix.md:31:7 - Unknown word (liatrio)
devops-bootcamp/1-introduction/1.3.1-unix.md:32:4 - Unknown word (liatrio)
devops-bootcamp/1-introduction/1.3.1-unix.md:96:108 - Unknown word (liatrio)
devops-bootcamp/1-introduction/1.3.1-unix.md:106:499 - Unknown word (Liatrio)
devops-bootcamp/1-introduction/1.3.1-unix.md:130:31 - Unknown word (myfile)
devops-bootcamp/1-introduction/1.3.2-vim.md:9:17 - Unknown word (bootcamp)
devops-bootcamp/1-introduction/1.3.2-vim.md:14:52 - Unknown word (modeless)
devops-bootcamp/1-introduction/1.3.2-vim.md:90:46 - Unknown word (vimtutor)
devops-bootcamp/1-introduction/1.3.3-installations.md:8:8 - Unknown word (distros)
devops-bootcamp/1-introduction/1.3.3-installations.md:10:15 - Unknown word (distros)
devops-bootcamp/1-introduction/1.3.3-installations.md:11:17 - Unknown word (distros)
devops-bootcamp/1-introduction/1.3.3-installations.md:12:15 - Unknown word (pacman)
devops-bootcamp/1-introduction/1.3.3-installations.md:30:32 - Unknown word (devel)
devops-bootcamp/1-introduction/1.3.3-installations.md:31:19 - Unknown word (adoptopenjdk)
devops-bootcamp/1-introduction/1.3.3-installations.md:64:45 - Unknown word (distros)
devops-bootcamp/1-introduction/1.3.3-installations.md:64:336 - Unknown word (distro)
devops-bootcamp/1-introduction/1.3.4-passwords-and-keys.md:26:20 - Unknown word (keepassxc)
devops-bootcamp/1-introduction/1.3.4-passwords-and-keys.md:28:5 - Unknown word (Lastpass)
devops-bootcamp/1-introduction/1.3.4-passwords-and-keys.md:29:1 - Unknown word (Lastpass)
devops-bootcamp/1-introduction/1.3.4-passwords-and-keys.md:34:30 - Unknown word (Lastpass)
devops-bootcamp/1-introduction/1.3.4-passwords-and-keys.md:45:53 - Unknown word (passwordless)
devops-bootcamp/1-introduction/1.3.5-networking.md:9:43 - Unknown word (Bootcamp)
devops-bootcamp/1-introduction/1.3.5-networking.md:33:4 - Unknown word (Hostnames)
devops-bootcamp/1-introduction/1.3.5-networking.md:36:3 - Unknown word (Hostnames)
devops-bootcamp/1-introduction/1.3.5-networking.md:38:35 - Unknown word (hostnames)
...

[ianhundere]

PR is complete, awaiting feedback.

ps 893 lines down to about 95 in regards to the spelling file

[ianhundere]

added husky:

❯ git commit -am "265: more testing."
/Users/ianhundere/Projects/devops-bootcamp/7-kubernetes-container-orchestration/7.0-overview.md:5:22 - Unknown word (Kbectl)
husky - pre-commit hook exited with code 1 (error)

[ianhundere]

i noticed that the markdown job was missing the correct globs to lint all markdown files:

          globs: |
            *.md
            !test/*.md

it should be:

          globs: |
            *.md
            **/*.md

i'm gonna update it, but also ignore the new glob to get my above PR in; !**/*.md.