https://github.com/turadg/lazyspec

Slack off and let code write your unit tests
https://github.com/turadg/lazyspec

Last synced: about 2 months ago
JSON representation

Slack off and let code write your unit tests

• Host: GitHub
• URL: https://github.com/turadg/lazyspec
• Owner: turadg
• Created: 2016-05-08T22:45:48.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-04-03T17:48:39.000Z (over 4 years ago)
• Last Synced: 2024-09-15T23:38:19.144Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 974 KB
• Stars: 46
• Watchers: 4
• Forks: 5
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# LazySpec

Automatically generate minimal spec files for Javascript modules. Works well with Jest snapshots to make painless tests. For example, given a test file `src/components/Button.jsx`,

```js

import React from 'react';

class Button extends React.Component {

  static propTypes = {

    level: React.PropTypes.oneOf([

      'primary', 'secondary', 'tertiary', 'quaternary', 'text', 'icon',

    ]),

    disabled: React.PropTypes.bool,

    label: React.PropTypes.string.isRequired,

    height: React.PropTypes.number,

    children: React.PropTypes.element.isRequired,

  };

  render() {

    return (

      

        {this.props.label}

      

    );

  }

}

export default Button;

```

it will generate `src/components/__tests__/Button-test.js`:

```js

/* @lazyspec (remove to manage manually) */

/* eslint-disable */

import Button from '../Button.js';

import React from 'react';

import renderer from 'react-test-renderer';

describe('Button', () => {

  it('exists', () => {

    expect(Button).toBeTruthy();

  });

  it('renders', () => {

    const comp = ;

    const tree = renderer.create(comp).toJSON();

    expect(tree).toMatchSnapshot();

  });

});

```

## Usage

```

npm install -g lazyspec

lazyspec path/to/fileOrDir

```

For every dir in the list, it will glob all the `.js` and `.jsx` `.js` and add them.

For each file, it will generate a spec and the `__tests__` dir if necessary. So far it only supports the Jest style layout but PRs for other test runners and layouts are welcomed!

In dev you can do, `./src/cli.js path/to/fileOrDir`.

## Editor integration

- for Sublime Text, https://github.com/turadg/sublime-react-ide

## Known Issues

- Custom proptypes are never interpreted as required (e.g. `message: MessageInterfacePropType.isRequired`)

- Fails when more than one component is exported from a module. [react-docgen](https://github.com/reactjs/react-docgen) now has `findAllExportedComponentDefinitions`, but we don't use it because modules often export a HOC and its base component so it would be redundant. Eventually this tool could detect which is the HOC and omit it.