redux-devtools/packages/redux-devtools-test-generator
2020-09-10 12:37:19 -04:00
..
demo/src refactor(redux-devtools-inspector-monitor): rename package (#633) 2020-09-10 12:37:19 -04:00
src chore(*): upgrade dependencies (#574) 2020-08-08 21:18:45 -04:00
test chore(*): upgrade prettier (#570) 2020-08-08 16:26:39 -04:00
.babelrc chore(*): add prettier check to CI (#598) 2020-08-19 10:07:30 -04:00
CHANGELOG.md feature(devui): convert to TypeScript (#629) 2020-09-09 10:35:22 -04:00
LICENSE.md Move redux-devtools-test-generator package (#438) 2018-12-23 02:13:56 +02:00
package.json refactor(redux-devtools-inspector-monitor): rename package (#633) 2020-09-10 12:37:19 -04:00
README.md refactor(redux-devtools-inspector-monitor): rename package (#633) 2020-09-10 12:37:19 -04:00
webpack.config.js chore(*): upgrade dependencies (#573) 2020-08-08 18:04:46 -04:00

Redux DevTools Test Generator

Installation

npm install --save-dev redux-devtools-test-generator

Usage

If you use Redux DevTools Extension, Remote Redux DevTools or RemoteDev, it's already there, and no additional actions required.

With redux-devtools and redux-devtools-inspector-monitor:

containers/DevTools.js
import React from 'react';
import { createDevTools } from 'redux-devtools';
import InspectorMonitor from 'redux-devtools-inspector-monitor';
import TestGenerator from 'redux-devtools-test-generator';
import mochaTemplate from 'redux-devtools-test-generator/lib/redux/mocha'; // If using default tests.

const testComponent = (props) => (
  <TestGenerator
    expect={mochaTemplate.expect} wrap={mochaTemplate.wrap} useCodemirror
    {...props}
  />
);

export default createDevTools(
  <Inspector
    tabs: defaultTabs => [...defaultTabs, { name: 'Test', component: testComponent }]
  />
);

Instead of mochaTemplate.expect and mochaTemplate.wrap you can use your function templates.

If useCodemirror specified, include codemirror/lib/codemirror.css style and optionally themes from codemirror/theme/.

Props

Name Description
assertion String template or function with an object argument containing action, prevState, curState keys, which returns a string representing the assertion (see the function or template).
[wrap] Optional string template or function which gets assertions argument and returns a string (see the example function or template).
[useCodemirror] Boolean. If specified will use codemirror styles.
[theme] String. Name of the codemirror theme.

License

MIT