Skip to content

Commit

Permalink
build: configure codespell to fix misspellings
Browse files Browse the repository at this point in the history
Requires python^3.11.0 to use pyproject.toml

Exclude everything in `docs/_build`,
and the exact lines in `.codespell.ignore`

Also add to pre-commit checks
  • Loading branch information
JorisVincent committed Sep 22, 2023
1 parent 44a303b commit 37bac3d
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .codespell.ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
**F**indable, **A**ccessible, **I**nteroperable, and **R**eusable
Pflügers Archiv für die gesamte Physiologie. 3: 13-15.
7 changes: 6 additions & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,9 @@ repos:
hooks:
- id: flake8
# Ignore all format-related checks as Black takes care of those.
args: ["--ignore", "E203,E501,W503,F403", "--select", "E,W,F", '--per-file-ignores=__init__.py:F401,F405,E402', '--exclude','tests/*']
args: ["--ignore", "E203,E501,W503,F403", "--select", "E,W,F", '--per-file-ignores=__init__.py:F401,F405,E402', '--exclude','tests/*']

- repo: https://github.com/codespell-project/codespell
rev: v2.2.4
hooks:
- id: codespell
5 changes: 5 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,8 @@ type = "github"

[tool.semantic_release.publish]
upload_to_vcs_release = true # upload sdist, wheel to release-tag


[tool.codespell]
skip = "./docs/_build/*"
exclude-file = ".codespell.ignore"

0 comments on commit 37bac3d

Please sign in to comment.