Preventing 4-Hour Time Loss from Typos with Code Spell Checker in VSCode

This is just a follow-up to the title.

• Want to hear about how I wasted 4 hours because I didn't notice a typo in a Rails migration? (I did) [EOF] | Junya Kitayama | zenn
  • https://zenn.dev/junki555/articles/a9ba6e21416314

I wrote the article above.
When I was telling a friend a similar story about my pathetic grumbling...

...Is he a genius?

A senior colleague once told me:
Those who address issues with human resources are third-rate,
while the first-rate address them with systems...

Installing Code Spell Checker in VSCode

https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker

At the time of writing this article,
there is a standard extension with 2,022,291 installs.

I added this to my extensions,

and appended this to User/settings.json so it works with Ruby as well.
(I've minimized the scope for now, but I'll incorporate other languages as I get used to it.)
(I also added a setting to disable Japanese spell checking, referring to the link mentioned later.)

Let's try running it. And then...

Nice!
With this, it seems almost certain that I won't waste another 4 hours on the same mistake.

Adding project-specific words

Adding words is easy.
With the cursor on the word you want to add, open the command palette
and just choose the registration destination with "Add Word to ~".

If you select that, it will create

.vscode/settings.json under the directory currently loaded in VSCode

{
  "cSpell.words": [
    "authenticatable"
  ]
}

and since it creates such a file,
you can share it with team members' environments as a project-specific word by managing it in the repository. Convenient!

References

• Fight typos by introducing Code Spell Checker to VSCode | Qiita
  • https://qiita.com/diescake/items/98c5a099e85775cd917d
• Make Code Spell Checker, which points out typos in VSCode, compatible with the Ruby language | Qiita
  • https://qiita.com/suke_pg/items/0d185c7b37ae592b7314
• Code Spell Checker, an extension for spell-checking within source code in VSCode | Lonely Mobiler
  • https://loumo.jp/archives/24672
• Visual Studio Code Spell Checker that you should install right now | rochefort's blog
  • https://rochefort.hatenablog.com/entry/vscode_spell_checker