Check your spelling!

ยท

2 min read

It's easy to make a mistake in spelling when writing stuff online and worse - when writing code ๐Ÿง‘โ€๐Ÿ’ป๐Ÿ‘ฉโ€๐Ÿ’ป๐Ÿ‘จโ€๐Ÿ’ป to build software. It's especially important to write code with less or 0 spelling mistakes when others are also going to read your code - which is most probably the case, either now or in the near or far future

Spelling mistakes can cause problems for people to search through code using their search ๐Ÿ”๐Ÿ”Ž๐Ÿ”ฆ๐Ÿ‘€ features like Command + F or Ctrl + F in their text editor / IDE. Of course spelling mistakes are NOT a problem when you use modern tools โš’๏ธ ๐Ÿงฐ ๐Ÿ› ๏ธ to search through code using Find References and similar features of the text editor / IDE which understand the language and do search ๐Ÿ”๐Ÿ”ฆ๐Ÿ”Ž๐Ÿ‘€

I personally feel it's better to use words with less or 0 spelling mistakes, especially in source code

I personally use Code Spell Checker VS Code Extension in my Visual Studio Code. It's developed by https://streetsidesoftware.com/ . They have published a lot of Open Source VS Code Extensions - https://marketplace.visualstudio.com/publishers/streetsidesoftware

Street Side Software has created a lot of Open Source software, which you can find at https://github.com/streetsidesoftware

CSpell is their main project I think - https://github.com/streetsidesoftware/cspell , https://cspell.org/

And there are lot of projects around the CSpell ecosystem, like the Code Spell Checker VS Code Extension and then there are more - https://github.com/streetsidesoftware/cspell-dicts , https://github.com/streetsidesoftware/vscode-cspell-dict-extensions , https://github.com/streetsidesoftware/cspell-action , https://github.com/streetsidesoftware/cspell-cli

They have dictionaries for various Spoken Languages and also for various Programming Languages and for many things Programming related - for example, a dictionary for AWS - https://github.com/streetsidesoftware/cspell-dicts/tree/main/dictionaries/aws , a dictionary for Docker - https://github.com/streetsidesoftware/cspell-dicts/tree/main/dictionaries/docker , a dictionary for Google Cloud - https://github.com/streetsidesoftware/cspell-dicts/tree/main/dictionaries/google , a dictionary for Kubernetes - https://github.com/streetsidesoftware/cspell-dicts/tree/main/dictionaries/k8s . They have dictionaries for other stuff too, like specialized dictionaries for some things - a dictionary for company names - https://github.com/streetsidesoftware/cspell-dicts/tree/main/dictionaries/companies , a dictionary for crypto currencies - https://github.com/streetsidesoftware/cspell-dicts/tree/main/dictionaries/cryptocurrencies and more!

You can find all the dictionaries that are available for use in https://github.com/streetsidesoftware/cspell-dicts , the dictionaries are well documented :)

I'm already using Code Spell Checker Extension for VS Code already and it's great ๐Ÿ˜Œ๐Ÿ˜Š๐Ÿ‘. I recommend you to start using it or something similar to it that can help you make less spelling mistakes in your software project source code or even documentation / docs

ย