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

Commit

Permalink
Add documentation about localTs and expectOnly option (#244)
Browse files Browse the repository at this point in the history
* Add documentation about localTs and expectOnly option

* Update `--expectOnly` description

According to #244 (comment)

Co-Authored-By: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com>
  • Loading branch information
lukyth and sandersn committed Aug 13, 2019
1 parent 0754e73 commit 43859c3
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
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

0 comments on commit 43859c3

Please sign in to comment.