Add a pre-commit hook definition to run codespell

[marco-c]

No description provided.

[codecov-io]

Codecov Report

Merging #1117 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1117   +/-   ##
=======================================
  Coverage   91.33%   91.33%           
=======================================
  Files           4        4           
  Lines         727      727           
  Branches      106      106           
=======================================
  Hits          664      664           
  Misses         46       46           
  Partials       17       17

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2888c75...1b6e02b. Read the comment docs.

[larsoner]

I have never used this before. I looked only briefly at the docs

https://pre-commit.com/

Is the purpose of adding the file to codespell's repo just to provide a template for other git repos that want to use codespell as a pre-commit hook? Or is there more to i?

[marco-c]

Is the purpose of adding the file to codespell's repo just to provide a template for other git repos that want to use codespell as a pre-commit hook? Or is there more to i?

Yes, that's it. I've created a temporary repository to do it at https://github.com/marco-c/pre-commit-codespell, but I'm going to remove it if this PR is merged. Here's an example usage: mozilla/bugbug#411.

Here's another example of pre-commit hook definition, for black: https://github.com/python/black/blob/master/.pre-commit-hooks.yaml.

[larsoner]

Great, thanks!

[asottile]

Adding this to the website -- thanks all! pre-commit/pre-commit.com#237