Skip to content

Commit 33381a6

Browse files
committed
chore: Rename to find-typos
1 parent 8329138 commit 33381a6

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
findtypos
1+
/find-typos

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# findtypos
1+
# find-typos
22

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
44
who want to find typos of their project's name in their codebase.
55

66
## Install
77

8-
go install github.com/twpayne/findtypos@latest
8+
go install github.com/twpayne/find-typos@latest
99

1010
## Usage
1111

12-
findtypos [-format=github-actions] word [path...]
12+
find-typos [-format=github-actions] word [path...]
1313

1414
This will print the filename and line number of minor misspellings of *word* in
1515
each *path* specified.
@@ -23,32 +23,32 @@ ignored, as are non-text files (i.e. files for whose contents
2323
[`net/http.DetectContentType()`](https://pkg.go.dev/net/http#DetectContentType)
2424
returns a content type that does not begin with `text/`)
2525

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.
2727

2828
## Example
2929

3030
Given the input file `example.txt`:
3131

3232
```
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.
3434
3535
fyndtypos finds a number of minor mis-spellings of a single word, including, for
3636
example, the subsitution of a single letter, or the insertion of a single
3737
letter, like finddtypos.
3838
```
3939

40-
Running findtypos prints:
40+
Running find-typos prints:
4141

4242
```console
43-
$ findtypos findtypos example.txt
43+
$ find-typos find-typos example.txt
4444
example.txt:3:1: fyndtypos
4545
example.txt:5:14: finddtypos
4646
```
4747

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,
4949
for example:
5050

51-
findtypos myprojectsweirdname .
51+
find-typos myprojectsweirdname .
5252

5353
## License
5454

go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
module github.com/twpayne/findtypos
1+
module github.com/twpayne/find-typos
22

33
go 1.15

testdata/example.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
This is an example input file for findtypos. It contains a few typos.
1+
This is an example input file for find-typos. It contains a few typos.
22

33
fyndtypos finds a number of minor mis-spellings of a single word, including, for
44
example, the subsitution of a single letter, or the insertion of a single

0 commit comments

Comments
 (0)