guard-codespell helps in keeping your code typo free by running codespell when files are modified
Please make sure to have Guard and codespell installed before you start.
Add guard-codespell
to your Gemfile
.
group :development do
gem 'guard-codespell'
end
and then execute:
$ bundle install
See guard documentation for how to add a guard plugin and how to use guard.
Some configuration options are available to use with guard-codespell.
Option | Type | Description |
---|---|---|
all_on_start |
Boolean | Run codespell when starting guard |
config |
String | Path to a codespell config file |
debug |
Boolean | Show the codespell command that is used when guard-codespell runs |
only_git_changes |
Boolean | Only run codespell on files tracked by git (the result of git status --porcelain is used to create the list of files to check for errors. |
Here's an example on how to use those options in your Guardfile
guard :codespell, config: ".codespellrc", debug: true, only_git_changes: true do
end
Bug reports and pull requests are welcome on GitHub at https://github.com/hooktstudios/guard-codespell. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Guard::Codespell project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.