typos-git-commit 0.1.4

This program analyzes a json file produced with `typos` and makes commits for each correction.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

# Description

`typos-git-commit` is a command line tool that processes a [`typos`](https://crates.io/crates/typos-cli)
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

You can use the option `--noop` to print what will be executed.
If you need to have a summary of all typos you can use `--only-list-typos`
option. You can add some details to this summary with `--details` option.

* 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 (by default)
  characters and the ones that got only one correction proposal. To
  modify the minimum length one may use `--minlen` or `-m` option.
* 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.

# Changelog

* v0.1.4
  * Adds boundary word limits into sed's regex to avoid unwanted corrections.