From 09209d6c8cd00e6b91a98bcfbe13472b056dca66 Mon Sep 17 00:00:00 2001 From: Orta Date: Mon, 9 Sep 2019 19:01:32 +0200 Subject: [PATCH] Update README.md (#38247) * Update README.md * Update README.md --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 286ebed9a9..e9f7c626a2 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,8 @@ Also see the [definitelytyped.org](http://definitelytyped.org) website, although * [Create a new package](#create-a-new-package) * [Common mistakes](#common-mistakes) * [Removing a package](#removing-a-package) - * [Lint](#lint) + * [Linter](#lint) + * [Verifying](#verifying) * [FAQ](#faq) ## Current status @@ -205,7 +206,7 @@ When you add a `package.json` to dependents of `foo`, you will also need to open If a package was never on Definitely Typed, it does not need to be added to `notNeededPackages.json`. -#### Lint +#### Linter All new packages must be linted. To lint a package, add a `tslint.json` to that package containing ```js @@ -240,8 +241,11 @@ f("one"); For more details, see [dtslint](https://github.com/Microsoft/dtslint#write-tests) readme. -Test by running `npm run lint package-name` where `package-name` is the name of your package. -This script uses [dtslint](https://github.com/Microsoft/dtslint). +## Verifying + +Test your changes by running `npm run lint package-name` where `package-name` is the name of your package. + +This script uses [dtslint](https://github.com/Microsoft/dtslint) to run the TypeScript compiler against your dts files. ## FAQ