Addon-docs: Source loader library #7117

shilman · 2019-06-18T02:52:27Z

What I did

This is the source loader library by @libetl that replaces addon-storysource's loader and extends it in various ways:

storiesOf support
module story format
Typescript support
Flow support

In addition, it can also embed the story source as a story parameter (which is probably how it should be implemented).

I'll leave the refactor of addon-storysource to @libetl for another PR. It might even be worth updating storysource to use the parameter and removing the complicated decorator/event.

This will be integrated into docs in a subsequent PR where the Source doc block consumes the aforementioned story parameter.

How to test

yarn test

vercel · 2019-06-18T02:52:36Z

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

Latest deployment for this branch: https://monorepo-git-7101-source-loader.storybook.now.sh

igor-dv · 2019-06-18T17:12:14Z

@shilman , I don't get why not to reference it in the storysource ? since it looks like a copy paste, hard to understand what exactly changed =) But It looks similar to what I remember it was =)

shilman · 2019-06-18T20:50:10Z

@igor-dv see my comment above:

I'll leave the refactor of addon-storysource to @libetl for another PR. It might even be worth updating storysource to use the parameter and removing the complicated decorator/event.

libetl · 2019-06-19T05:14:14Z

@igor-dv you guessed it, storysource will just require it.
The idea behind it is to share the implementation

igor-dv · 2019-06-19T08:22:53Z

👍

shilman · 2019-06-19T08:41:44Z

@libetl With the latest commit I've updated all the monorepo examples to use source-loader instead of storysource's loader. However, storysource appears to be broken in all of those examples. I'm wondering if you might be able to debug this when you have time. I'll debug the SB Docs side separately, if needed, after this PR is merged. Merci beaucoup! 🙇

Additionally there are a lot of other errors, e.g. for loading MDX. I'm not sure the best way to deal with these.

shilman · 2019-06-24T16:24:19Z

lib/source-loader/src/abstract-syntax-tree/traverse-helpers.js

+          p => p.key.name === 'parameters' && p.value.type === 'ObjectExpression'
+        );
+
+        splicedSource =


@libetl I think the error is here when there are no parameters attached to the default export

shilman · 2019-06-24T16:35:15Z

@libetl I think there's a bug when using the module format when there are no parameters on the default export. I tested this in the release/docs-technical-preview branch and it works on cra-mdx (a test project) but not in official-storybook (I tried commenting out various load lines, but all broke in the same place). Would you mind taking a look at this please?

libetl · 2019-06-24T21:50:03Z

fixed. But there seems to be something wrong after the load. all the stories are displaying errors. Can you help me Michael ?

shilman · 2019-06-25T03:00:53Z

@libetl Your fix worked but there is still a problem with some of the stories. In PropsTable.stories.tsx:

const { row: stringRow } = rowStories.string().props;
const { row: numberRow } = rowStories.number().props;
export const normal = () => <PropsTable rows={[stringRow, numberRow]} />;

When the source loader modifies the stories, the generated code assumes that the story functions are being called with context, and these are not.

Proposed solution:

I will modify the story format per Addon-docs: Support non-story exports in module story format #7071 and modify these stories to export the data directly
Later we could modify the source-loader to use injected story parameters instead of the event

libetl · 2019-06-25T06:52:23Z

Ok, tell me if I can help in any way

shilman · 2019-06-25T10:35:28Z

@libetl I was able to fix the problem as mentioned above.

There are two remaining problems, and I'm going to merge this PR and I've filed a separate issue to track them: #7192

Hypnosphi · 2019-07-20T19:10:30Z

.babelrc.js

@@ -77,6 +78,7 @@ module.exports = {
        './lib/core/src/server',
        './lib/node-logger',
        './lib/codemod',
+        './lib/source-loader/src',


This directory includes client-side files like preview.js, we shouldn't apply node target to them

I'll extract the server part there

Hypnosphi · 2019-07-20T19:28:16Z

lib/source-loader/src/index.js

@@ -0,0 +1,6 @@
+import { transform } from './build';
+
+export { STORY_EVENT_ID } from './events';


@shilman is that export used anywhere? I'm going to remove it from index

Source loader library by @libetl

f081f98

shilman added feature request addon: storysource addon: docs labels Jun 18, 2019

shilman added this to the 5.2.0 milestone Jun 18, 2019

shilman changed the title ~~Source loader library by @libetl~~ Addon-docs: Source loader library Jun 18, 2019

shilman requested review from igor-dv, libetl, ndelangen and tmeasday June 18, 2019 02:53

This was referenced Jun 18, 2019

Addon-docs: Review and merge #7101

Closed

Addon-docs: DocsPage and doc blocks #7119

Merged

Merge branch 'next' into 7101-source-loader

c597ad5

vercel bot requested a deployment to staging June 19, 2019 03:27 Pending

vercel bot requested a deployment to staging June 19, 2019 03:34 Pending

vercel bot requested a deployment to staging June 19, 2019 03:35 Pending

vercel bot temporarily deployed to staging June 19, 2019 03:36 Inactive

Custom babel config for source-loader

1339371

vercel bot deployed to staging June 19, 2019 03:44 View deployment

Upgrade all examples to use source-loader

a70f7d3

shilman requested review from alexandrebodin, alterx, danielduan and naipath as code owners June 19, 2019 08:39

shilman assigned shilman and libetl Jun 19, 2019

Merge branch 'next' into 7101-source-loader

33ea65a

vercel bot had a problem deploying to staging June 22, 2019 02:23 Failure

Merge branch 'next' into 7101-source-loader

bd0c802

vercel bot had a problem deploying to staging June 22, 2019 09:00 Failure

Merge branch 'next' into 7101-source-loader

f77ce4a

shilman commented Jun 24, 2019

View reviewed changes

vercel bot temporarily deployed to staging June 24, 2019 16:27 Inactive

Source-loader: fix official-storybook webpack config

3530366

vercel bot had a problem deploying to staging June 24, 2019 16:28 Failure

handle no parameters case

c9f0978

vercel bot had a problem deploying to staging June 24, 2019 21:47 Failure

shilman mentioned this pull request Jun 24, 2019

addon-storysource: not working without chaining #6136

Closed

Merge branch 'next' into 7101-source-loader

ca2dc93

vercel bot had a problem deploying to staging June 25, 2019 10:02 Failure

shilman mentioned this pull request Jun 25, 2019

Storysource: Use story parameters injected by source-loader #7192

Closed

ndelangen approved these changes Jun 25, 2019

View reviewed changes

shilman merged commit 6668d32 into next Jun 25, 2019

shilman deleted the 7101-source-loader branch June 25, 2019 10:55

This was referenced Jun 26, 2019

Fix source-loader CI errors #7203

Merged

Source-loader: Post-merge fire fighting #7204

Closed

Hypnosphi reviewed Jul 20, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Addon-docs: Source loader library #7117

Addon-docs: Source loader library #7117

shilman commented Jun 18, 2019 •

edited

vercel bot commented Jun 18, 2019 •

edited

igor-dv commented Jun 18, 2019

shilman commented Jun 18, 2019

libetl commented Jun 19, 2019

igor-dv commented Jun 19, 2019

shilman commented Jun 19, 2019 •

edited

shilman Jun 24, 2019

shilman commented Jun 24, 2019

libetl commented Jun 24, 2019

shilman commented Jun 25, 2019 •

edited

libetl commented Jun 25, 2019

shilman commented Jun 25, 2019 •

edited

Hypnosphi Jul 20, 2019

Hypnosphi Jul 20, 2019

Hypnosphi Jul 20, 2019

Hypnosphi Jul 20, 2019 •

edited

		@@ -0,0 +1,6 @@
		import { transform } from './build';

		export { STORY_EVENT_ID } from './events';

Addon-docs: Source loader library #7117

Addon-docs: Source loader library #7117

Conversation

shilman commented Jun 18, 2019 • edited

What I did

How to test

vercel bot commented Jun 18, 2019 • edited

igor-dv commented Jun 18, 2019

shilman commented Jun 18, 2019

libetl commented Jun 19, 2019

igor-dv commented Jun 19, 2019

shilman commented Jun 19, 2019 • edited

shilman Jun 24, 2019

Choose a reason for hiding this comment

shilman commented Jun 24, 2019

libetl commented Jun 24, 2019

shilman commented Jun 25, 2019 • edited

libetl commented Jun 25, 2019

shilman commented Jun 25, 2019 • edited

Hypnosphi Jul 20, 2019

Choose a reason for hiding this comment

Hypnosphi Jul 20, 2019

Choose a reason for hiding this comment

Hypnosphi Jul 20, 2019

Choose a reason for hiding this comment

Hypnosphi Jul 20, 2019 • edited

Choose a reason for hiding this comment

shilman commented Jun 18, 2019 •

edited

vercel bot commented Jun 18, 2019 •

edited

shilman commented Jun 19, 2019 •

edited

shilman commented Jun 25, 2019 •

edited

shilman commented Jun 25, 2019 •

edited

Hypnosphi Jul 20, 2019 •

edited