hydrateio / docz-plugin-storybook

Docz plugin that makes migrating from Storybook a breeze.
76 stars 1 forks source link

Joel/separate stories from page #27

Closed jpeters5392 closed 5 years ago

jpeters5392 commented 5 years ago

TL;DR

Each component now gets a page that imports a different MDX file with the story info. The reason for this is Refinitiv wants to render the story list for designers, but then developers will see the story list mixed in with instructions. There are now 2 templates for stories. The plain list and then the mixed-in list.

jpeters5392 commented 5 years ago

See https://github.com/hydrateio/emcm-ui/pull/2 for consuming implementation

transitive-bullshit commented 5 years ago

This looks fine for Refinitiv, but it seems unrelated to the open source version of docz-plugin-storybook. Do you think it makes sense to just use a fork of docz-plugin-storybook for Refinitiv and keep the OSS version agnostic to client-specific changes?

jpeters5392 commented 5 years ago

@transitive-bullshit Take a look at my updates. Now there shouldn't be any Refinitiv specific pieces in here, although returning an array from storiesOfTemplate gives consumers a little extra flexibility

jpeters5392 commented 5 years ago

Apparently it is preferred because it works down into iframes. I ran into a similar issue with react-frame-component I think, where if you attempt to check if something is an instance of HTMLElement inside of the iframe since those browser interfaces are unique per document, so the nodes in the iframe are instances of the iframe's HTMLElement and not the parent document where the code is run.

On Mon, Feb 11, 2019 at 1:53 PM Travis Fischer notifications@github.com wrote:

@transitive-bullshit commented on this pull request.

In src/index.js https://github.com/hydrateio/docz-plugin-storybook/pull/27#discussion_r255688143 :

@@ -13,6 +13,12 @@ const minStorybookSemver = '>=3'

const v3StorybookSemver = '^3'

const v4StorybookSemver = '^4'

+const ensureArray = (value) => {

  • if (value instanceof Array) return value

this should be Array.isArray. don't ask me why it's better as i have no idea haha 😄 i just know it's preferred in the js world from what i've seen

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/hydrateio/docz-plugin-storybook/pull/27#pullrequestreview-202331501, or mute the thread https://github.com/notifications/unsubscribe-auth/ABd6gcy6s_YZ8_UO9ku4PF2UsRfz2Njjks5vMdhLgaJpZM4aoDpY .

transitive-bullshit commented 5 years ago

any idea why CI is failing?

jpeters5392 commented 5 years ago

It looks like it might be failing to build the tests. I'll give that a look

jpeters5392 commented 5 years ago

I had to add @babel/runtime as a dev dependency. It looks like our tests also build the examples so I need to go through those and make sure that they all still work. I'm flying tomorrow so I'll get back to this later in the week.