react-generate-props

generateProps({ name: PropTypes.string, number: PropTypes.number })
// => { name: 'name', number: 1 }

Installation

$ npm install --save-dev react-generate-props

Usage

// test-helper.js
import { init } from 'react-generate-props'
init()

const Counter = ({ count }) => <div>{count}</div>
Counter.propTypes = { count: PropTypes.number.isRequired }
export default Counter

import generateProps from 'react-generate-props'
import Counter from './counter'
generateProps(Counter)
// => { count: 1 }

Example

// component.jsx
class Component extends React.Component {
 static propTypes = {
 title: PropTypes.string.isRequired,
 followers: PropTypes.number.isRequired,
 user: PropTypes.shape({
 loggedIn: PropTypes.bool.isRequired,
 name: PropTypes.string.isRequired
 }).isRequired
 }
 render() {
 <div>
 <h1>{this.props.title}</h1>
 <small>{this.props.followers}</small>
 {this.props.user.loggedIn && <p>Hello, {this.props.user.name}.</p>}
 </div>
 }
}
export default Component

// component-test.js
import generateProps from 'react-generate-props'
import Component from './component.jsx'
const props = generateProps(Component)
// => { title: 'title', followers: 1, user: { loggedIn: true, name: 'name' }}
render(<Component {...props} />)
/* =>
<div>
 <h1>title</h1>
 <small>1</small>
 <p>Hello, name.</p>
</div>
*/

API

generateProps(schema, opts)

schema: An Object, Function, or Class containing a PropTypes definition, or a single PropType. All of the following are valid:

const Counter = { count: PropTypes.number.isRequired }

const Counter = { propTypes: { count: PropTypes.number.isRequired } }

const Counter = ({ counter }) => {/* ... */}
Counter.propTypes = { count: PropTypes.number.isRequired }

class Counter extends React.Component {
 static propTypes = { count: PropTypes.number.isRequired }
}

const Counter = PropTypes.shape({ count: PropTypes.number.isRequired }).isRequired

generateProps(Counter)
// => { count: 1 }

opts: An Object which may contain the following:

{
 required: true,
 // default: true. When true, props marked as .isRequired will be generated.
 optional: false,
 // default: false. When true, props *not* marked as .isRequired will be generated.
 generators: {
 // Can be used to override this lib's default generators.
 // Each key is a prop type, each value is a function.
 // Each function receives the propName as its first argument,
 // followed by that prop type's argument, if it takes one.
 bool: (propName) => false,
 function: (propName) => spy(),
 number: (propName) => propName.length,
 instanceOf: (propName, klass) => new klass(),
 oneOf: (propName, values) => values[values.length - 1]
 }
}

One More Example

const propTypes = {
 name: PropTypes.string.isRequired,
 loggedIn: PropTypes.bool,
 userType: PropTypes.oneOf(['admin', 'user']).isRequired
}
generateProps(propTypes)
// => { name: 'string', userType: 'admin' }
generateProps(propTypes, { optional: true })
// => { name: 'string', loggedIn: true, userType: 'admin' }
generateProps(propTypes, {
 optional: true,
 generators: {
 string: (propName) => 'Alice',
 bool: (propName) => propName === 'loggedIn',
 oneOf: (propName, values) => values[values.length - 1]
 }
})
// => { name: 'Alice', loggedIn: true, userType: 'user' }