typos/docs/pre-commit.md
2022-01-24 12:30:42 -06:00

785 B

pre-commit

To use typos with pre-commit, point its config at this repository:

repos:
  - repo: https://github.com/crate-ci/typos
    rev: v1.3.6
    hooks:
      - id: typos

The typos id installs a prebuilt executable from GitHub releases. If one does not exist for the target platform, or if one built from sources is preferred, use typos-src as the hook id instead.

Be sure to change rev to use the desired typos git tag or revision.

The hook configuration defaults to writing fixes, which triggers a pre-commit failure if any files are modified. To make it report its findings only instead, override the hook's args with something that does not contain -w/--write-changes, for example [] (meaning pass no options).