diff --git a/packages/dtslint-runner/README.md b/packages/dtslint-runner/README.md index f0b59273..5f2f8c46 100644 --- a/packages/dtslint-runner/README.md +++ b/packages/dtslint-runner/README.md @@ -11,5 +11,18 @@ $ node node_modules/@definitelytyped/dtslint-runner/dist/index.js --path ~/Defin $ node node_modules/@definitelytyped/dtslint-runner/dist/index.js --path . # run all (from DefinitelyTyped root): $ node node_modules/@definitelytyped/dtslint-runner/dist/index.js --path . --selection all + +# after running once, it's faster to add --noInstall +$ node node_modules/@definitelytyped/dtslint-runner/dist/index.js --path . --selection all --noInstall +# you might only want to run a fraction of packages for testing +$ node node_modules/@definitelytyped/dtslint-runner/dist/index.js --path . --selection all --noInstall --shardCount 8 --shardId 1 +# or test only with the $ExpectType rule, which type checks +$ node node_modules/@definitelytyped/dtslint-runner/dist/index.js --path . --selection all --noInstall --expectOnly +# or test only with the $ExpectType rule, which type checks +$ node node_modules/@definitelytyped/dtslint-runner/dist/index.js --path . --selection all --noInstall --expectOnly +# and you might just want to test on the latest Typescript +$ node node_modules/@definitelytyped/dtslint-runner/dist/index.js --path . --selection all --noInstall --expectOnly --onlyTestTsNext +# or a local build of Typescript +$ node node_modules/@definitelytyped/dtslint-runner/dist/index.js --path . --selection all --noInstall --expectOnly --localTypeScriptPath ../ts/built/local ```