codespell VS typos

You probably should use a separate linter for this. I use codespell in Neovim. You can use it from CLI and it is not Python specific.

This plus codespell. Because we’d look like kindergartners otherwise.

I keep making silly tyops like that, so I always add codespell as one of the pre-commit hooks of all the repositories I own.

codespell

codespell checks for typos. We chose this tool because it is based on a list of common typos, which reduces the number of false positives to a minimum.

Something like https://github.com/codespell-project/codespell

--- # .pre-commit-config.yaml # ======================== # # pre-commit clean # pre-commit install # pre-commit install-hooks # # precommit hooks installation # # - pre-commit autoupdate # # - pre-commit run black # # continuous integration # ====================== # # - pre-commit run --all-files # repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.0.1 hooks: - id: trailing-whitespace - id: end-of-file-fixer - id: debug-statements - id: check-merge-conflict - id: sort-simple-yaml - id: fix-encoding-pragma args: ["--remove"] - id: forbid-new-submodules - id: mixed-line-ending args: ["--fix=lf"] description: Forces to replace line ending by the UNIX 'lf' character. - id: check-added-large-files args: ["--maxkb=500"] - id: no-commit-to-branch args: [--branch, master] - id: check-yaml - id: check-json files: ^tests/app/ - id: pretty-format-json args: ["--no-sort-keys", "--autofix"] files: ^tests/app/ - repo: meta hooks: - id: check-hooks-apply - id: check-useless-excludes - repo: https://github.com/ambv/black rev: 21.5b1 hooks: - id: black language_version: python3.9 - repo: https://github.com/PyCQA/bandit rev: 1.7.0 hooks: - id: bandit description: Security oriented static analyser for python code exclude: tests/|scripts/ args: - -s - B101 - repo: https://github.com/codespell-project/codespell rev: v2.1.0 hooks: - id: codespell name: codespell description: Checks for common misspellings in text files. entry: codespell language: python types: [text] - repo: https://github.com/asottile/pyupgrade rev: v2.19.4 hooks: - id: pyupgrade

There is typos though that takes a bit different of an approach to spell checking. When the default is to ask the user (like in a text editor), a regular spell checker is likely better. typos is more meant for being run in an automated fashion.

I recommend you run https://github.com/crate-ci/typos

Oh yeah, I can see you short hashes being a problem. The challenge has been finding the right heuristic for them

Is there good usage examples for this tool? typos simply traverses directories on invocation, wonder if there's a static analysis equivalent for ltrs.

highly recommend adding https://github.com/crate-ci/typos to your CI...very easy to add to a github action, catch fun spelling errors even in camelCased and snake_cased variable names...catch em before they become public facing APIs

I like to use https://github.com/crate-ci/typos as a command-line option. It's built to run as a service or in CI... I run it in our code review software and it has been a big hit.

there's a little comparison table here https://github.com/crate-ci/typos/blob/master/docs/comparison.md

typos