1
1
<h1 id =" canonical " >Canonical</h1 >
2
2
3
- <!-- [](https://travis-ci.org/gajus/canonical) -->
3
+ [ ![ Travis build status] ( http://img.shields.io/travis/gajus/canonical/master.svg?style=flat-square )] ( https://travis-ci.org/gajus/canonical )
4
4
[ ![ NPM version] ( http://img.shields.io/npm/v/canonical.svg?style=flat-square )] ( https://www.npmjs.com/package/canonical )
5
5
[ ![ js-canonical-style] ( https://img.shields.io/badge/code%20style-canonical-blue.svg?style=flat-square )] ( https://github.com/gajus/canonical )
6
6
@@ -25,7 +25,6 @@ Use this in one of your projects? Include one of these badges in your README to
25
25
[](https://github.com/gajus/canonical)
26
26
```
27
27
28
-
29
28
<h2 id =" canonical-rules " >Rules</h2 >
30
29
31
30
Canonical rules are composed of the following packages:
@@ -35,6 +34,7 @@ Canonical rules are composed of the following packages:
35
34
* [ ` eslint-config-canonical-lodash ` ] ( https://github.com/gajus/eslint-config-canonical-lodash )
36
35
* [ ` eslint-config-canonical-react ` ] ( https://github.com/gajus/eslint-config-canonical-react )
37
36
37
+
38
38
<h2 id =" canonical-usage " >Usage</h2 >
39
39
40
40
<h3 id =" canonical-usage-command-line " >Command Line</h3 >
@@ -76,11 +76,14 @@ When reading from stdin, it is required to provide `--linter` option. See [Comma
76
76
```
77
77
Options:
78
78
--help Show help [boolean]
79
- --stdin Used to indicate that subject body will be read from stdin.
80
- [boolean] [default: false]
81
79
--file-path Name of the file being linted with stdin (if any). Used in
82
80
reporting. [string] [default: "<text>"]
83
- --linter The type of input. [required] [choices: "js", "scss"]
81
+ --fix Used to automatically fix linting issues when possible. Works
82
+ only when linting target is a file (does not work with stdin
83
+ input). [boolean] [default: false]
84
+ --linter The type of input. [choices: "js", "scss"]
85
+ --stdin Used to indicate that subject body will be read from stdin.
86
+ [boolean] [default: false]
84
87
--output-format [choices: "json", "checkstyle", "table"] [default: "table"]
85
88
```
86
89
0 commit comments