Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nchen63 authored Mar 29, 2017
1 parent 4a37d6f commit 5c4ecc7
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,16 @@ The configuration file specifies which rules are enabled and their options. Thes
* - a relative path to a JSON file
*/
"extends": "tslint:latest",
"defaultSeverity": "warning",
"rules": {
/*
* Any rules specified here will override those from the base config we are extending.
*/
"curly": true
"curly": true,
"max-line-length": {
"severity": "error",
"options": 140
}
},
"jsRules": {
/*
Expand All @@ -109,6 +114,12 @@ __`tslint:latest`__ extends `tslint:recommended` and is continuously updated to

See the [core rules list](#core-rules) below for descriptions of all the rules.

##### Severity

The severity level of each rule can use the values `default`, `error`, `warning`/`warn`, and `off`/`none`. If no severity level is specified, `default` is used. The `defaultSeverity` option replaces the severity level for each rule that uses severity level `default` in the current file. Valid values for `defaultSeverity` include `error`, `warning`/`warn`, and `off`/`none`.

The CLI exits with code 2 if an error is reported, and exits with code 0 otherwise.

#### CLI

usage: `tslint [options] file ...`
Expand Down

0 comments on commit 5c4ecc7

Please sign in to comment.