mcwebb / react-fake-props

Automatically generate fake props for your React tests (Jest, Enzyme, ...)

react-fake-props

Automatically generate fake props

react-fake-props parses your Component prop types using react-docgen and generates fake props. Supports PropTypes and Flow. Works great with Jest snapshots and Enzyme.

Install

yarn add react-fake-props --dev

npm install react-fake-props --save-dev

Why?

Assuming the following component definition:

// Component.jsx
class Component extends React.Component {
  // ...
}

Component.propTypes = {
  stringA: PropTypes.string.isRequired,
  stringB: PropTypes.string.isRequired,
  stringC: PropTypes.string.isRequired,
  stringD: PropTypes.string.isRequired,
  stringE: PropTypes.string.isRequired,
}

export default Component

Before

Without react-fake-props, to test your component, you would have to set manually all your props:

const props = {
  stringA: 'some value',
  stringB: 'some value',
  stringC: 'some value',
  stringD: 'some value',
  stringE: 'some value',
}
<Component {...props} />

After

With react-fake-props, you can remove all the previous lines and generate valid props based on your Component prop types:

const props = fakeProps(componentPath)
<Component {...props} />

Usage

import path from 'path'
import fakeProps from 'react-fake-props'

const componentPath = path.join(__dirname, './Component.jsx')
const props = fakeProps(componentPath)

To include optional props, pass { optional: true }.

Please note:

• custom validators and PropTypes.instanceOf aren't supported, you'll still need to set them manually.
• react-fake-props requires the component path to be passed, instead of the component itself, to be able to support PropTypes and Flow.

API

fakeProps(componentPath[, { optional: false } ])

Tip

When checking for a value, use props.A rather than 'A' as react-fake-props output may change.

const wrapper = shallow(<Component {...props} />)

wrapper.text().to.contain('A') // bad
wrapper.text().to.contain(props.A) // good

License

MIT - Typicode 🌵 - Patreon