Skip to content

Commit

Permalink
Merge pull request rails#42136 from jbampton/add-docs-on-misspell
Browse files Browse the repository at this point in the history
Add documentation on spell checking with `misspell` [ci skip]
  • Loading branch information
zzak authored May 3, 2021
2 parents 722303b + 7c0341f commit 3682f11
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions guides/source/contributing_to_ruby_on_rails.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 3682f11

Please sign in to comment.