Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: change state assigment #870

Merged
merged 2 commits into from
Mar 21, 2018

Conversation

nicoffee
Copy link
Contributor

Must solve #864.

@codecov-io
Copy link

codecov-io commented Mar 14, 2018

Codecov Report

Merging #870 into master will increase coverage by 0.2%.
The diff coverage is 100%.

Impacted Files Coverage Δ
src/rsg-components/Preview/Preview.js 90.32% <100%> (+5.07%) ⬆️

@sapegin
Copy link
Member

sapegin commented Mar 15, 2018

Thanks! Would be awesome if you can add some tests for this part of the code.

@nicoffee
Copy link
Contributor Author

Okay, will do.

@nicoffee
Copy link
Contributor Author

nicoffee commented Mar 15, 2018

@sapegin, i need some help testing this case.
Should i export PreviewComponent from Preview.js in order to test his setInitialState() method directly, or should i somehow test it through Preview component, and if so, how exactly?
For now, i did something like this:

it('should synchronously set initialState before first render', () => {
	const actual = mount(<Preview code={code} evalInContext={evalInContext} />, options);
	const testState = {
		error: 'error',
		count: '42',
	};
	actual.setState(testState);
	expect(actual.state()).toEqual(testState);
});

But i am pretty sure it's wrong, because it actually renders element before state is changing.

@sapegin
Copy link
Member

sapegin commented Mar 19, 2018

@nicoffee Sorry for the delay. Ideally we shouldn't call methods directly, but I'm not sure it's possible in that case. I'll try to have a look myself.

@sapegin
Copy link
Member

sapegin commented Mar 19, 2018

It actually doesn't work. I've fixed the implementation and have added couple of tests.

@nicoffee
Copy link
Contributor Author

Thank you!

@sapegin sapegin added this to the 6.3.0 milestone Mar 19, 2018
@sapegin sapegin merged commit 02e13ab into styleguidist:master Mar 21, 2018
sapegin pushed a commit that referenced this pull request Mar 22, 2018
👋 **[Support Styleguidist](https://opencollective.com/styleguidist) on Open Collective** 👋

## New features

### Page per section 🚧

This is a huge improvement for large style guides: now you can show only one component at a page instead of all components.

![](https://d3vv6lp55qjaqc.cloudfront.net/items/0W2q2K2s3n2k311O1J0y/Screen%20Recording%202018-03-22%20at%2010.06%20AM.gif)

To enable:

```js
module.exports = {
  pagePerSection: true
};
```

This is an experimental feature and we need your feedback to make it better and really useful. For example, right now there’s no isolated mode. So feel free to share your ideas [in issues](https://github.com/styleguidist/react-styleguidist/issues).

(#835 by @bitionaire and @stepancar, closes #494 and #768)

### “Fork me” ribbon

One more step to make Styleguidist usable for documenting open source projects:

![](https://d3vv6lp55qjaqc.cloudfront.net/items/1t331n2a3v0F2i290K0Z/Image%202018-03-22%20at%209.13.11%20AM.png)

New config option to enable the ribbon, define the URL and change the label:

```js
module.exports = {
  ribbon: {
    url: 'http://example.com/',
    text: 'Fork me on GitHub'
  }
};
```

And two new [theme variables](https://github.com/styleguidist/react-styleguidist/blob/master/src/styles/theme.js) to change colors: `color.ribbonBackground` and `color.ribbonText`.

(#861 by @glebez and @wkwiatek, part of #195, closes #647)

### Options to change CLI output on server start and build

Two new options, `printServerInstructions` and `printBuildInstructions`:

```js
module.exports = {
  printBuildInstructions(config) {
    console.log(
      `Style guide published to ${
        config.styleguideDir
      }. Something else interesting.`
    );
  }
};
```

(#878 by @roblevintennis, closes #876)

### Option to modify props

A new option, `updateDocs` to modify props before rendering. For example, you can load a component version number from a JSON file:

```js
module.exports = {
  updateDocs(docs) {
    if (docs.doclets.version) {
      const versionFilePath = path.resolve(
        path.dirname(file),
        docs.doclets.version
      );
      const version = require(versionFilePath).version;

      docs.doclets.version = version;
      docs.tags.version[0].description = version;
    }

    return docs;
  }
};
```

(#868 by @ryanoglesby08)

### Limited support for named exports

Styleguidist used to require default exports for components. Now you can use named exports too, though Styleguidist still supports only one component per file. I hope this change will make some users happier, see more details [in the docs](https://react-styleguidist.js.org/docs/components.html#loading-and-exposing-components).

(#825 by @marcdavi-es, closes #820 and #633)

### Allow arrays of component paths in sections

More flexibility in structuring your style guide:

```js
module.exports = {
  sections: [
    {
      name: 'Forms',
      components: [
        'lib/components/ui/Button.js',
        'lib/components/ui/Input.js'
      ]
    }
  ]
};
```

(#794 by @glebez, closes #774)

### Sort properties by `required` and `name` attributes

This change should make props tables more predictable for the users. Instead of relying on developers to sort props in a meaningful way, Styleguidist will show required props first, and sort props in each group alphabetically.

To disable sorting, use the identity function:

```javascript
module.exports = {
  sortProps: props => props
};
```

(#784 by @dotcs)

## Bug fixes

* Allow `Immutable` state in examples (#870 by @nicoffee, closes #864)
* Change template container ID to prevent clashes (#859 by @glebez, closes #753)
* Better props definitions with Flow types (#781 by @nanot1m)
@sapegin
Copy link
Member

sapegin commented Mar 22, 2018

🎉 This PR is included in version 6.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants