@@ -47,26 +47,28 @@ $ curl -sSL https://git.io/JcGER | bash
47
47
after that, you will get ` /usr/local/bin/autocorrect ` command.
48
48
49
49
``` bash
50
- AutoCorrect 1.0.0
50
+ AutoCorrect
51
51
52
- Automatically add whitespace between CJK (Chinese, Japanese, Korean) and half-width characters (alphabetical letters ,
53
- numerical digits and symbols ).
52
+ A linter and formatter for help you improve copywriting, to correct spaces, punctuations between CJK (Chinese, Japanese ,
53
+ Korean ).
54
54
55
55
USAGE:
56
56
autocorrect [FLAGS] [OPTIONS] [file]...
57
57
58
58
FLAGS:
59
+ --debug Print debug message.
60
+ --type Directly use set file type
59
61
--fix Automatically fix problems and rewrite file.
60
62
-h, --help Prints help information
61
63
--lint Lint and output problems.
62
64
-V, --version Prints version information
63
65
64
66
OPTIONS:
65
- --type < filetype> Directly use set file type [default: ]
66
67
--format < formatter> Choose an output formatter. [default: diff] [possible values: json, diff]
68
+ --threads < threads> Number of threads, 0 - use number of CPU [default: 0]
67
69
68
70
ARGS:
69
- < file> ... Target filepath or dir for format
71
+ < file> ... Target filepath or dir for format [default: .]
70
72
```
71
73
72
74
## Usage
@@ -86,7 +88,7 @@ $ autocorrect text.txt
86
88
87
89
$ autocorrect --fix text.txt
88
90
$ autocorrect --fix zh-CN.yml
89
- $ autocorrect --fix ./
91
+ $ autocorrect --fix
90
92
```
91
93
92
94
#### Lint
@@ -106,7 +108,7 @@ $ autocorrect --lint text.txt
106
108
You also can lint multiple files:
107
109
108
110
``` bash
109
- $ autocorrect --lint .
111
+ $ autocorrect --lint
110
112
```
111
113
112
114
### Ignore option
@@ -172,7 +174,7 @@ autocorrect:
172
174
stage: build
173
175
image: huacnlee/autocorrect:latest
174
176
script:
175
- - autocorrect --lint .
177
+ - autocorrect --lint
176
178
# Enable allow_failure if you wants.
177
179
# allow_failure: true
178
180
` ` `
0 commit comments