1 | # declare-react-module
|
2 |
|
3 | [![npm][npm-badge]][npm]
|
4 | [![build][travis-ci-badge]][travis-ci]
|
5 | [![codecov](https://codecov.io/gh/KingHenne/declare-react-module/branch/master/graph/badge.svg)](https://codecov.io/gh/KingHenne/declare-react-module)
|
6 | [![semantic-release][semantic-release-badge]][semantic-release]
|
7 |
|
8 | Create TypeScript declaration files for React modules written in ES6.
|
9 |
|
10 | ## Usage
|
11 |
|
12 | ### Locally
|
13 |
|
14 | 1. Install `declare-react-module` as a dev dependency:
|
15 |
|
16 | ```sh
|
17 | npm install --save-dev declare-react-module
|
18 | ```
|
19 |
|
20 | 2. Add a new entry to `"scripts"` in your `package.json`:
|
21 |
|
22 | ```json
|
23 | {
|
24 | "prepublish": "declare-react-module"
|
25 | }
|
26 | ```
|
27 |
|
28 | This will create an `index.d.ts` file in your project root before publishing to npm.
|
29 |
|
30 | ### As a Global Script
|
31 |
|
32 | 1. Install `declare-react-module` as a global dependency:
|
33 |
|
34 | ```sh
|
35 | npm install --global declare-react-module
|
36 | ```
|
37 |
|
38 | 2. Run `declare-react-module` from the command line:
|
39 |
|
40 | ```sh
|
41 | declare-react-module packages/my-package
|
42 | ```
|
43 |
|
44 | [npm]: https://www.npmjs.com/package/declare-react-module
|
45 | [npm-badge]: https://img.shields.io/npm/v/declare-react-module.svg?maxAge=3600
|
46 | [semantic-release]: https://github.com/semantic-release/semantic-release
|
47 | [semantic-release-badge]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
|
48 | [travis-ci]: https://travis-ci.org/KingHenne/declare-react-module
|
49 | [travis-ci-badge]: https://travis-ci.org/KingHenne/declare-react-module.svg?branch=master
|