tnear / AutocorrectForDevelopers

AutocorrectForDevelopers is a multi-platform script which automatically fixes typos using rules tailored for software developers.

Repository from Github https://github.comtnear/AutocorrectForDevelopersRepository from Github https://github.comtnear/AutocorrectForDevelopers

AutocorrectForDevelopers

AutocorrectForDevelopers is a multi-platform script which automatically fixes typos using rules tailored for software developers. AutocorrectForDevelopers can be run through AutoHotkey (AHK) or Espanso. The script's rules contain many corrections for common developer words involving keywords, classes, methods, programming languages, and software engineering concepts. This script reduces runtime errors and boosts developer productivity.

How does it work?

Corrections happen automatically as you type:

Autocorrect

By default, AutocorrectForDevelopers.ahk runs against all applications (except Microsoft Word), although the script can be customized to enable or disable any application (see the #HotIf/#If statement early in the script).

Installation

AutoHotkey users

Install AutoHotkey v2, then run AutocorrectForDevelopers.ahk.

Espanso users

Install Espanso for your platform, then load the match file AutocorrectForDevelopers.yaml.

To match the behavior of the AutoHotkey script, update your Espanso settings to set undo_backspace to false, and append these word_separators to the default list: "-", "`", "&", "|", "_".

Testing

All tests are run as part of GitHub Actions, ensuring that any new rules and updates do not regress existing behavior.

FAQ

How does AutocorrectForDevelopers.ahk compare to AutoHotkey's official AutoCorrect.ahk script?

Here is AutoHotkey's official autocomplete script. It is based in Wikipedia's common misspellings list which dates back to 2005. Jim Biancolo ported Wikipedia's list to an AutoHotkey script in 2006 and it has been officially hosted by AutoHotkey.com since 2007. The original script is widely influential and has been used successfully by many people for years.

Shown below is a Venn diagram comparing excerpts from the official AutoCorrect.ahk with AutocorrectForDevelopers.ahk:

Venn diagram

AutoCorrect.ahk, shown in yellow, contains many rules for rare words which software engineers are unlikely to need. It also introduces many accented characters which are correct but developer unfriendly. Lastly, the official script hasn't seen much active development in the last 15 years and therefore is missing new technology terminology.

AutocorrectForDevelopers.ahk, shown in purple, contains many common software engineering terms which are absent from AutoCorrect.ahk. Because AutocorrectForDevelopers.ahk is developer-centric, it will fix a higher percentage of your typos.

Does this support Espanso?

Yes! Espanso is a cross-platform (Windows, macOS, Linux) text expander while AutoHotkey is scoped to Microsoft Windows. Load the generated file AutocorrectForDevelopers.yaml in Espanso if you need non-Windows support.

What programming subjects does this script contain?

  • Languages: AutoHotkey, C, C++, C#, COBOL, CSS, FORTRAN, Go, Java, JavaScript, Julia, Kotlin, Lua, MATLAB, Perl, PHP, Python, R, Ruby, Rust, Scala, SQL, Swift, Visual Basic
  • Programs: GDB, Git, PowerShell, UNIX CLI
  • Subjects: algorithms, artificial intelligence, cloud computing, compilers, concurrency, cryptography, databases, distributed systems, linear algebra, machine learning, networking, operating systems, security, statistics, system design
  • (more to come!)

About

AutocorrectForDevelopers is a multi-platform script which automatically fixes typos using rules tailored for software developers.


Languages

Language:AutoHotkey 80.7%Language:Python 19.3%