typos-git-commit 0.1.1

Analyze typos json file and does git commits.
typos-git-commit-0.1.1 is not a library.
Visit the last successful build: typos-git-commit-0.5.2

Description

typos-git-commit is a command line tool that processes a typos generated json file to :

  1. correct typos in detected files (via sed)
  2. make a commit at each correction (via a simple git commit command)

It has been written for a one shot project but one may find it to be useful.

Usage

  • Generate a json file with typos, for instance: typos doc/ --exclude *.py --exclude *.js --format json >typos.json
  • In the directory of the repository use typos-git-commit : typos-git-commit --filename typos.json. This command will correct only typos with more than 5 characters and the ones that got only one correction proposal.
  • Review carefully the generated commits even if everything is done to mitigate errors when replacing typos there are situations where this correction is really an error.