1
- # findtypos
1
+ # find-typos
2
2
3
- findtypos finds typos of a single word. It is primarily useful for developers
3
+ find-typos finds typos of a single word. It is primarily useful for developers
4
4
who want to find typos of their project's name in their codebase.
5
5
6
6
## Install
7
7
8
- go install github.com/twpayne/findtypos @latest
8
+ go install github.com/twpayne/find-typos @latest
9
9
10
10
## Usage
11
11
12
- findtypos [-format=github-actions] word [path...]
12
+ find-typos [-format=github-actions] word [path...]
13
13
14
14
This will print the filename and line number of minor misspellings of * word* in
15
15
each * path* specified.
@@ -23,32 +23,32 @@ ignored, as are non-text files (i.e. files for whose contents
23
23
[ ` net/http.DetectContentType() ` ] ( https://pkg.go.dev/net/http#DetectContentType )
24
24
returns a content type that does not begin with ` text/ ` )
25
25
26
- If no * path* s are specified, then findtypos reads from the standard input.
26
+ If no * path* s are specified, then find-typos reads from the standard input.
27
27
28
28
## Example
29
29
30
30
Given the input file ` example.txt ` :
31
31
32
32
```
33
- This is an example input file for findtypos . It contains a few typos.
33
+ This is an example input file for find-typos . It contains a few typos.
34
34
35
35
fyndtypos finds a number of minor mis-spellings of a single word, including, for
36
36
example, the subsitution of a single letter, or the insertion of a single
37
37
letter, like finddtypos.
38
38
```
39
39
40
- Running findtypos prints:
40
+ Running find-typos prints:
41
41
42
42
``` console
43
- $ findtypos findtypos example.txt
43
+ $ find-typos find-typos example.txt
44
44
example.txt:3:1: fyndtypos
45
45
example.txt:5:14: finddtypos
46
46
```
47
47
48
- In general, you would run findtypos in the root of your project as a CI step,
48
+ In general, you would run find-typos in the root of your project as a CI step,
49
49
for example:
50
50
51
- findtypos myprojectsweirdname .
51
+ find-typos myprojectsweirdname .
52
52
53
53
## License
54
54
0 commit comments