Skip to content

Commit eb6c662

Browse files
committed
formatter: Add newline parameter descriptions
Signed-off-by: Hiroshi Hatake <hatake@clear-code.com>
1 parent 1b2d813 commit eb6c662

File tree

5 files changed

+40
-0
lines changed

5 files changed

+40
-0
lines changed

plugins/formatter/hash.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,14 @@ By default, `hash` formatter result doesn't contain `tag` and `time` fields.
1919

2020
Adds `\n` to the result.
2121

22+
### `newline`
23+
24+
| type | default | version |
25+
|:-----|:------------------------------------------------|:--------|
26+
| enum | `lf (for non-Windows)` or `crlf (for Windows)` | 1.11.5 |
27+
28+
29+
Specify newline characters.
2230

2331
## Example
2432

plugins/formatter/json.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,14 @@ By default, `json` formatter result doesn't contain `tag` and `time` fields.
1919

2020
Adds `\n` to the result.
2121

22+
### `newline`
23+
24+
| type | default | version |
25+
|:-----|:------------------------------------------------|:--------|
26+
| enum | `lf (for non-Windows)` or `crlf (for Windows)` | 1.11.5 |
27+
28+
29+
Specify newline characters.
2230

2331
## Example
2432

plugins/formatter/ltsv.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,14 @@ Delimiter for the key-value field.
3939

4040
Adds `\n` to the result.
4141

42+
### `newline`
43+
44+
| type | default | version |
45+
|:-----|:------------------------------------------------|:--------|
46+
| enum | `lf (for non-Windows)` or `crlf (for Windows)` | 1.11.5 |
47+
48+
49+
Specify newline characters.
4250

4351
## Example
4452

plugins/formatter/out_file.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,14 @@ Overwrites the default value in this plugin.
6262

6363
Overwrites the default value in this plugin.
6464

65+
### `newline`
66+
67+
| type | default | version |
68+
|:-----|:------------------------------------------------|:--------|
69+
| enum | `lf (for non-Windows)` or `crlf (for Windows)` | 1.11.5 |
70+
71+
72+
Specify newline characters.
6573

6674
## Example
6775

plugins/formatter/single_value.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,14 @@ Adds `\n` to the result. If there is a trailing `\n` already, set it `false`.
3030

3131
The value of this field is outputted.
3232

33+
### `newline`
34+
35+
| type | default | version |
36+
|:-----|:------------------------------------------------|:--------|
37+
| enum | `lf (for non-Windows)` or `crlf (for Windows)` | 1.11.5 |
38+
39+
40+
Specify newline characters.
3341

3442
## Example
3543

0 commit comments

Comments
 (0)