SwiftTypoDetector

An easy to install, easy to use, swift typo detector for your console.

BlogPost

Installation

• Run the setup script: ./setup.sh
  • Note: If you get a permission denied error: chmod +x ./setup.sh

The setup script will:

• Install Homebrew (if not already installed)
• Install aspell (dependency) (via brew)
• Install the Ruby gems (via bundle install)
  • Just ffi gem needed

Usage

• Run ./find_typos.rb path/to/your-project
  • Replace path/to/your-project with the real path of your project.
  • Note: If you get a permission denied error: chmod +x ./find_typos.rb

Aside from checking against the US dictionary, the script will also check against the words in this list:

• SwiftGenericWords

Learning words

If you want to provide a set of custom words:

1. Create a file named learned_words.txt inside the project you want to find typos on.

• Note 1: It won't matter if it's in the root or not.
• Note 2: You could even have multiple learned_words.txt and the script will combine them all.

2. Populate the .txt file with one learned word per line (lowercased).

• The script will lowercase the words before matching them to the ones in the .txt file.

You could copy and paste the one in this project:

cp learned_words.txt path/to/your-project

Sorting the learned_words file

If you want to sort the sections of the learned_word file:

• Run the sort script: ./sort_txt_sections.sh path/to/your-project/learned_words.txt
  • Replace path/to/your-project/learned_words.txt with the real path of your txt file.