You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-11
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ Usage of misspell:
49
49
-f string
50
50
'csv', 'sqlite3' or custom Golang template for output
51
51
-i string
52
-
ignore the following corrections, commaseparated
52
+
ignore the following corrections, comma-separated
53
53
-j int
54
54
Number of workers, 0 = number of CPUs
55
55
-legal
@@ -265,12 +265,12 @@ To just print probable misspellings:
265
265
<aname="problem"></a>
266
266
### What problem does this solve?
267
267
268
-
This corrects commonly misspelled English words in computer source code, and other text-based formats (`.txt`, `.md`, etc).
268
+
This corrects commonly misspelled English words in computer source code, and other text-based formats (`.txt`, `.md`, etc.).
269
269
270
270
It is designed to run quickly,
271
271
so it can be used as a [pre-commit hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) with minimal burden on the developer.
272
272
273
-
It does not work with binary formats (e.g. Word, etc).
273
+
It does not work with binary formats (e.g. Word, etc.).
274
274
275
275
It is not a complete spell-checking program nor a grammar checker.
276
276
@@ -287,7 +287,7 @@ They all work but had problems that prevented me from using them at scale:
287
287
288
288
* slow, all of the above check one misspelling at a time (i.e. linear) using regexps
289
289
* not MIT/Apache2 licensed (or equivalent)
290
-
* have dependencies that don't work for me (python3, bash, linux sed, etc)
290
+
* have dependencies that don't work for me (python3, bash, linux sed, etc.)
291
291
* don't understand American vs. British English and sometimes makes unwelcome "corrections"
292
292
293
293
That said, they might be perfect for you and many have more features than this project!
@@ -302,7 +302,7 @@ This uses the mighty power of golang's [strings.Replacer](https://golang.org/pkg
302
302
which is an implementation or variation of the [Aho–Corasick algorithm](https://en.wikipedia.org/wiki/Aho–Corasick_algorithm).
303
303
This makes multiple substring matches *simultaneously*.
304
304
305
-
In addition, this uses multiple CPU cores to work on multiple files.
305
+
It also uses multiple CPU cores to work on multiple files concurrently.
306
306
307
307
<aname="issues"></a>
308
308
### What problems does it have?
@@ -328,9 +328,9 @@ Thanks!
328
328
### Why is it making mistakes or missing items in golang files?
329
329
330
330
The matching function is *case-sensitive*,
331
-
so variable names that are multiple worlds either in all-upper or all-lower case sometimes can cause false positives.
331
+
so variable names that are multiple worlds either in all-uppercase or all-lowercase case sometimes can cause false positives.
332
332
For instance a variable named `bodyreader` could trigger a false positive since `yrea` is in the middle that could be corrected to `year`.
333
-
Other problems happen if the variable name uses a English contraction that should use an apostrophe.
333
+
Other problems happen if the variable name uses an English contraction that should use an apostrophe.
334
334
The best way of fixing this is to use the [Effective Go naming conventions](https://golang.org/doc/effective_go.html#mixed-caps)
335
335
and use [camelCase](https://en.wikipedia.org/wiki/CamelCase) for variable names.
336
336
You can check your code using [golint](https://github.com/golang/lint)
@@ -341,15 +341,15 @@ You can check your code using [golint](https://github.com/golang/lint)
341
341
The main code is [MIT](https://github.com/golangci/misspell/blob/master/LICENSE).
342
342
343
343
Misspell also makes uses of the Golang standard library and contains a modified version of Golang's [strings.Replacer](https://golang.org/pkg/strings/#Replacer)
344
-
which are covered under a [BSD License](https://github.com/golang/go/blob/master/LICENSE).
344
+
which is covered under a [BSD License](https://github.com/golang/go/blob/master/LICENSE).
345
345
Type `misspell -legal` for more details or see [legal.go](https://github.com/golangci/misspell/blob/master/legal.go)
Copy file name to clipboardExpand all lines: cmd/misspell/main.go
+1-1
Original file line number
Diff line number
Diff line change
@@ -111,7 +111,7 @@ func main() {
111
111
quietFlag=flag.Bool("q", false, "Do not emit misspelling output")
112
112
outFlag=flag.String("o", "stdout", "output file or [stderr|stdout|]")
113
113
format=flag.String("f", "", "'csv', 'sqlite3' or custom Golang template for output")
114
-
ignores=flag.String("i", "", "ignore the following corrections, commaseparated")
114
+
ignores=flag.String("i", "", "ignore the following corrections, comma-separated")
115
115
locale=flag.String("locale", "", "Correct spellings using locale preferences for US or UK. Default is to use a neutral variety of English. Setting locale to US will correct the British spelling of 'colour' to 'color'")
116
116
mode=flag.String("source", "text", "Source mode: text (default), go (comments only)")
117
117
debugFlag=flag.Bool("debug", false, "Debug matching, very slow")
0 commit comments