Skip to content
This repository has been archived by the owner on Nov 16, 2023. It is now read-only.

Add documentation about localTs and expectOnly option #244

Merged
merged 2 commits into from
Aug 13, 2019
Merged

Add documentation about localTs and expectOnly option #244

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0373766
Add documentation about localTs and expectOnly option
lukyth Aug 10, 2019
0dcf6a4
Update `--expectOnly` description
lukyth Aug 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,23 @@ For bundled typings, this can go on any line (but should be near the top).
- Add to your `package.json` `scripts`: `"dtslint": "dtslint types"`
- `npm run dtslint`

### Options

- `--localTs`

Use your locally installed version of TypeScript.

```sh
dtslint --localTs node_modules/typescript/lib types
```
- `--expectOnly`

Disable all the lint rules except the one that checks for type correctness.

```sh
dtslint --expectOnly types
```


# Contributing

Expand Down