vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-08-13 13:30:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #31274 from DefinitelyTyped/clarify-readme-linting-rules

Browse Source 
Clarifying tslint.json content instructions
This commit is contained in:
Jesse Trinity
2018-12-11 11:15:46 -08:00
committed by GitHub
parent 95a4800caa 291ba3002e
commit a6097e9dc2
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -2
View File
@@ -169,8 +169,14 @@ If a package was never on DefinitelyTyped, it does not need to be added to `notN
#### Lint
To lint a package, just add a `tslint.json` to that package containing `{ "extends": "dtslint/dt.json" }`. All new packages must be linted.
If a `tslint.json` turns rules off, this is because that hasn't been fixed yet. For example:
All new packages must be linted. To lint a package, add a `tslint.json` to that package containing
```js
{
"extends": "dtslint/dt.json"
}
```
This should be the only content in a finished project's `tslint.json` file. If a `tslint.json` turns rules off, this is because that hasn't been fixed yet. For example:
```js
{