From 03737665ef0c5ab684189876c54e4e6bd410e00b Mon Sep 17 00:00:00 2001 From: Kanitkorn S Date: Sat, 10 Aug 2019 13:44:36 +0700 Subject: [PATCH 1/2] Add documentation about localTs and expectOnly option --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 6123a5c4..f9ce274e 100644 --- a/README.md +++ b/README.md @@ -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 and check for type correctness only. + +```sh +dtslint --expectOnly types +``` + # Contributing From 0dcf6a4772d11c03f20f6e3502c8a1511db80bdd Mon Sep 17 00:00:00 2001 From: Kanitkorn Sujautra Date: Tue, 13 Aug 2019 10:37:51 +0700 Subject: [PATCH 2/2] Update `--expectOnly` description According to https://github.com/microsoft/dtslint/pull/244#discussion_r312997359 Co-Authored-By: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f9ce274e..abdb9ddf 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,7 @@ dtslint --localTs node_modules/typescript/lib types ``` - `--expectOnly` -Disable all the lint rules and check for type correctness only. +Disable all the lint rules except the one that checks for type correctness. ```sh dtslint --expectOnly types