Skip to content

Commit acc93b5

Browse files
authored
Update README.md
1 parent 7447155 commit acc93b5

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313

1414
## Attention
1515

16-
> You need install Java for working with `node-w3c-validator`
17-
> Visit https://java.com for download Java if you not have it
16+
> You need to install the "Java" for working with `node-w3c-validator`
17+
> Visit https://java.com for downloading the "Java" if you not have it
1818
1919

2020
---
@@ -154,7 +154,7 @@ Write reporting result to the path
154154

155155
#### `-b, --buffersize <size>`
156156

157-
Increase [maxBuffer](https://nodejs.org/docs/latest-v10.x/api/child_process.html#child_process_child_process_exec_command_options_callback) size to prevent #3, `!!! OUTPUT ERROR` or `Unexpected end of JSON input` errors. This is because [child_process stdout being truncated](https://github.com/nodejs/node/issues/19218) when validator check a lot of files.
157+
Increase [maxBuffer](https://nodejs.org/docs/latest-v10.x/api/child_process.html#child_process_child_process_exec_command_options_callback) size to prevent [`!!! OUTPUT ERROR` or `Unexpected end of JSON input` errors](https://github.com/dutchenkoOleg/node-w3c-validator/issues/3). This is because [child_process stdout being truncated](https://github.com/nodejs/node/issues/19218) when validator check a lot of files.
158158

159159
##### CLI `-b, --buffersize`
160160

@@ -230,7 +230,7 @@ _Parameters:_
230230

231231
Name | Data type | Description
232232
--- | --- | ---
233-
`err` | `Error / Object.<null>` | if no errors - will be `null`, else - Error object
233+
`err` | `Error / null` | if no errors - will be `null`, otherwise - Error object
234234
`output` | `string` | string with reporting result, if no errors - can be as empty string
235235

236236
### nodeW3CValidator.writeFile(filePath, outputData[, done])
@@ -241,7 +241,7 @@ _Parameters:_
241241

242242
Name | Data type | Argument | Description
243243
--- | --- | --- | ---
244-
`filePath` | `string` | | if no errors - will be `null`, else - Error object
244+
`filePath` | `string` | | relative path to saving a file
245245
`outputData` | `string / Buffer` | | file output content
246246
`done` | `Function` | _optional_ | if exist - it will asynchronous writes output to the filePath. See [fs.writeFile(file, data, callback)](https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback)
247247

@@ -304,6 +304,19 @@ Now you can suppress it
304304
}
305305
```
306306

307+
Or like this with a part of message:
308+
309+
```json
310+
{
311+
"nodeW3Cvalidator": {
312+
"suppressErrors": [],
313+
"suppressWarnings": [
314+
"is not needed and should be omitted"
315+
]
316+
}
317+
}
318+
```
319+
307320
---
308321

309322
## Changelog

0 commit comments

Comments
 (0)