Skip to content

Commit 9b32dec

Browse files
committed
docs: add info of new config standard plus legacy
1 parent 4812923 commit 9b32dec

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ __TSLint Config Standard Plus__ contains a [JavaScript Standard Style](http://st
1515
- Small because only exports a [tslint.json](./tslint.json).
1616
- [VS Code User Workspace](https://code.visualstudio.com/docs/getstarted/settings) pre-configured and ready to use.
1717

18+
### Config Standard Plus Legacy
19+
20+
Optional tslint config ([tslint.legacy.json](./tslint.legacy.json)) that extends from default [tslint.json](./tslint.json) but with additional rules overwritten:
21+
22+
- Enforce consistent spaces like the default config.
23+
- Enforce "double" quotes instead of 'single' ones.
24+
- Enforce 4 space indentation instead of 2.
25+
1826
## Rules
1927

2028
*This repo exists thanks to these __awesome__ [TSLint](https://palantir.github.io/tslint/) config projects listed below :tada:*
@@ -50,14 +58,24 @@ npm install tslint-config-standard-plus --save-dev
5058

5159
## Usage
5260

53-
In your `tslint.json` file:
61+
Setup your `tslint.json` in your project as follow:
62+
63+
### Config Standard Plus (default)
5464

5565
```json
5666
{
5767
"extends": "tslint-config-standard-plus"
5868
}
5969
```
6070

71+
### Config Standard Plus Legacy (optional)
72+
73+
```json
74+
{
75+
"extends": "tslint-config-standard-plus/tslint.legacy"
76+
}
77+
```
78+
6179
### Overwrite rules
6280

6381
To overwrite some specific rules add `"rules"` section after `"extends"` in your `tslint.json` file.

0 commit comments

Comments
 (0)