vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-07-03 16:50:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Orta
2019-09-09 12:51:07 -04:00
committed by GitHub
parent 22bfbf1ce8
commit fcea16ff61
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -16,7 +16,7 @@ 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)
* [Lint / Testing](#lint---testing)
* [FAQ](#faq)
## Current status
@@ -205,7 +205,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
#### Lint / Testing
All new packages must be linted. To lint a package, add a `tslint.json` to that package containing
```js
@@ -240,8 +240,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).
## Running Tests
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