| 1 | # declare-react-module
|
| 2 |
|
| 3 | [![npm][npm-badge]][npm]
|
| 4 | [![build][travis-ci-badge]][travis-ci]
|
| 5 | [![semantic-release][semantic-release-badge]][semantic-release]
|
| 6 |
|
| 7 | Create TypeScript declaration files for React modules written in ES6.
|
| 8 |
|
| 9 | ## Setup
|
| 10 |
|
| 11 | 1. Install `declare-react-module` as a dev dependency:
|
| 12 |
|
| 13 | ```sh
|
| 14 | npm install --save-dev declare-react-module
|
| 15 | ```
|
| 16 |
|
| 17 | 2. Add a new entry to `"scripts"` in your `package.json`:
|
| 18 |
|
| 19 | ```json
|
| 20 | {
|
| 21 | "prepublish": "declare-react-module"
|
| 22 | }
|
| 23 | ```
|
| 24 |
|
| 25 | This will create an `index.d.ts` file in your project root before publishing to npm.
|
| 26 |
|
| 27 | [npm]: https://www.npmjs.com/package/declare-react-module
|
| 28 | [npm-badge]: https://img.shields.io/npm/v/declare-react-module.svg?maxAge=3600
|
| 29 | [semantic-release]: https://github.com/semantic-release/semantic-release
|
| 30 | [semantic-release-badge]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
|
| 31 | [travis-ci]: https://travis-ci.org/KingHenne/declare-react-module
|
| 32 | [travis-ci-badge]: https://travis-ci.org/KingHenne/declare-react-module.svg?branch=master
|