react-dts-generator
TypeScript icon, indicating that this package has built-in type declarations

0.1.3 • Public • Published

react-dts-generator

Simple .d.ts generator for React components. Try with Repl.

Installation

## npm 
npm install react-dts-generator
## yarn 
yarn add react-dts-generator

Usage

import { generate } from 'react-dts-generator';
const result = generate(options);

Options

input: string

Path of the .js file that contains React Component. react-dts-generator use the react-docgen library to generate props and methods. The input file format guideline:

  • Modules have to export a single component, and only that component is analyzed.
  • When using React.createClass, the component definition (the value passed to it) must resolve to an object literal.
  • When using classes, the class must either extend React.Component or define a render() method.
  • propTypes must be an object literal or resolve to an object literal in the same file.
  • The return statement in getDefaultProps must contain an object literal.

output: string

The .d.ts file that contains typescript definitions. If not specified output file will be exported to the same location of the input file.

isBaseClass?: boolean

If the input component is a base class for another component the type definition could be generated with generic prop types like below. Then, another component could pass own props to the base class definition.

Input

import React from 'react';
import PropTypes from 'prop-types';
 
class BaseClass extends React.Component {
    constructor(props, context) {
        super(props, context);
        this.bar = this.bar.bind(this);
    }
 
    foo = () => { }
    bar() { }
 
    render() {
        return <div>BaseClass</div>;
    }
}
 
BaseClass.propTypes = {
    foo: PropTypes.any,
}
 
export default BaseClass;

Generate

const result = generate({
    input: 'path-to-input',
    isBaseClass: true,
});

Output

import * as React from "react";
 
export interface BaseClassProps {
  foo?: any;
}
 
export default class BaseClass<T = any> extends React.Component<T> {
  foo(): any;
  bar(): any;
}
 

extends?: { includePropsAsGeneric: boolean, import: ImportType }

If the input component inherits from another component, the base class could import from outside.

  • includePropsAsGeneric: boolean Should the props of the input component pass to the base class as generic?

  • import: ImportType Indicates where the base class located.

Input

import * as React from 'react';
import * as PropTypes from 'prop-types';
import BaseClass from './base';
 
class TestClass extends BaseClass {
    render() {
        return <div>TestClass</div>;
    }
}
 
TestClass.propTypes = {
    foo: PropTypes.any,
}
 
export default TestClass;

Generate

const result = generate({
    input: 'path-to-input',
    extends: {
        import: {
            default: 'BaseClass',
            from: './base',
        },
        includePropsAsGeneric: true,
    },
});

Output

import * as React from "react";
import BaseClass from "./base";
 
export interface TestClassProps {
  foo?: any;
}
 
export default class TestClass extends BaseClass<TestClassProps> {}

propTypesComposition: ImportType[]

If the component propTypes has composes by another component's propTypes, and typescript definitions of the other component were already generated they could be imported and generated types extend from them.

TestClass.propTypes = {
    ...BaseClass.propTypes,
    foo: PropTypes.any,
}
const result = generate({
    input: 'path-to-input',
    propTypesComposition: [{
        named: 'BaseClass',
        from: '../base-props-path',
    }],
});

Samples

Checkout the baselines and tests.

Known Issues

  • These propTypes generated as any

    • PropTypes.symbol
    • PropTypes.elementType
    • PropTypes.instanceOf
    • PropTypes.objectOf
    • PropTypes.exact
  • Custom propTypes is not supported.

Package Sidebar

Install

npm i react-dts-generator

Weekly Downloads

3

Version

0.1.3

License

Apache-2.0

Unpacked Size

68.9 kB

Total Files

10

Last publish

Collaborators

  • canpolat
  • ilhanali
  • mozkarakoc
  • mstgms