From 7c0341fbdc17a3fb28799ecb231a15ae9e6ffd24 Mon Sep 17 00:00:00 2001 From: John Bampton Date: Tue, 4 May 2021 07:08:48 +1000 Subject: [PATCH] Add documentation on spell checking with `misspell` [ci skip] --- guides/source/contributing_to_ruby_on_rails.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/guides/source/contributing_to_ruby_on_rails.md b/guides/source/contributing_to_ruby_on_rails.md index aae39b0da9..c240463fe4 100644 --- a/guides/source/contributing_to_ruby_on_rails.md +++ b/guides/source/contributing_to_ruby_on_rails.md @@ -275,6 +275,19 @@ Inspecting 1 file For `rails-ujs` CoffeeScript and JavaScript files, you can run `npm run lint` in `actionview` folder. +We are also running [misspell](https://github.com/client9/misspell) which is mainly written in Golang to check +spelling with [GitHub Actions](../../.github/workflows/lint.yml). Correct commonly misspelled English words quickly +with `misspell`. You can run `misspell` locally against all files with: + +```bash +find . -type f | xargs ./misspell -i 'aircrafts,devels,invertions' -error +``` + +Notable `misspell` help options or flags are: + +- `-i` string: ignore the following corrections, comma separated +- `-w`: Overwrite file with corrections (default is just to display) + ### Benchmark Your Code For changes that might have an impact on performance, please benchmark your