Skip to content

Commit

Permalink
Merge pull request #22 from storybookjs/shilman/add-mdx-tag
Browse files Browse the repository at this point in the history 
Add mdx tag for SB7 support
  • Loading branch information
@shilman
shilman authored Oct 28, 2022
2 parents d3d6bf3 + d64a8c0 commit 706a0bb
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 18 deletions.
71 changes: 53 additions & 18 deletions src/mdx2.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ describe('mdx2', () => {
foo.storyName = 'foo';
foo.parameters = { storySource: { source: '"bar"' } };
const componentMeta = { title: 'foobar', includeStories: ['foo'] };
const componentMeta = { title: 'foobar', tags: ['mdx'], includeStories: ['foo'] };
`);
});

Expand Down Expand Up @@ -95,7 +95,7 @@ describe('mdx2', () => {
foo.storyName = 'foo';
foo.parameters = { storySource: { source: '\\"bar\\"' } };
const componentMeta = { title: 'foobar', includeStories: ["foo"], };
const componentMeta = { title: 'foobar', tags: ['mdx'], includeStories: ["foo"], };
componentMeta.parameters = componentMeta.parameters || {};
componentMeta.parameters.docs = {
Expand Down Expand Up @@ -152,6 +152,7 @@ describe('docs-mdx-compiler-plugin', () => {
name: 'B',
},
},
tags: ['mdx'],
includeStories: ['componentNotes'],
};
`);
Expand All @@ -178,6 +179,7 @@ describe('docs-mdx-compiler-plugin', () => {
title: 'Button',
id: 'button-id',
component: Button,
tags: ['mdx'],
includeStories: ['componentNotes'],
};
`);
Expand Down Expand Up @@ -211,7 +213,11 @@ describe('docs-mdx-compiler-plugin', () => {
export const _Foo_ = MyStories.Foo;
_Foo_.storyName = 'renamed';
const componentMeta = { title: 'MDX/CSF imports', includeStories: ['_Basic_', '_Other_', '_Foo_'] };
const componentMeta = {
title: 'MDX/CSF imports',
tags: ['mdx'],
includeStories: ['_Basic_', '_Other_', '_Foo_'],
};
`);
});

Expand Down Expand Up @@ -251,6 +257,7 @@ describe('docs-mdx-compiler-plugin', () => {
</div>
),
],
tags: ['mdx'],
includeStories: ['one'],
};
`);
Expand All @@ -274,7 +281,7 @@ describe('docs-mdx-compiler-plugin', () => {
__page.parameters = { docsOnly: true };
const componentMeta = { title: 'docs-only', includeStories: ['__page'] };
const componentMeta = { title: 'docs-only', tags: ['mdx'], includeStories: ['__page'] };
`);
});

Expand Down Expand Up @@ -309,6 +316,7 @@ describe('docs-mdx-compiler-plugin', () => {
foo: 1,
}),
],
tags: ['mdx'],
includeStories: ['one'],
};
`);
Expand All @@ -328,7 +336,11 @@ describe('docs-mdx-compiler-plugin', () => {
__page.parameters = { docsOnly: true };
const componentMeta = { title: "Addons/Docs/what's in a title?", includeStories: ['__page'] };
const componentMeta = {
title: "Addons/Docs/what's in a title?",
tags: ['mdx'],
includeStories: ['__page'],
};
`);
});

Expand Down Expand Up @@ -361,7 +373,7 @@ describe('docs-mdx-compiler-plugin', () => {
helloStory.storyName = 'hello story';
helloStory.parameters = { storySource: { source: '<Button>{"Hello button"}</Button>' } };
const componentMeta = { title: 'Button', includeStories: ['one', 'helloStory'] };
const componentMeta = { title: 'Button', tags: ['mdx'], includeStories: ['one', 'helloStory'] };
`);
});

Expand Down Expand Up @@ -401,6 +413,7 @@ describe('docs-mdx-compiler-plugin', () => {
notes: 'component notes',
},
component: Button,
tags: ['mdx'],
includeStories: ['componentNotes', 'storyNotes'],
};
`);
Expand Down Expand Up @@ -450,6 +463,7 @@ describe('docs-mdx-compiler-plugin', () => {
notes: 'component notes',
},
component: Button,
tags: ['mdx'],
includeStories: ['helloButton', 'two'],
};
`);
Expand Down Expand Up @@ -492,7 +506,7 @@ describe('docs-mdx-compiler-plugin', () => {
};
componentNotes.parameters = { storySource: { source: 'args => <Button>Component notes</Button>' } };
const componentMeta = { title: 'Button', includeStories: ['componentNotes'] };
const componentMeta = { title: 'Button', tags: ['mdx'], includeStories: ['componentNotes'] };
`);
});

Expand Down Expand Up @@ -524,7 +538,7 @@ describe('docs-mdx-compiler-plugin', () => {
text.storyName = 'text';
text.parameters = { storySource: { source: '"Plain text"' } };
const componentMeta = { title: 'Text', includeStories: ['text'] };
const componentMeta = { title: 'Text', tags: ['mdx'], includeStories: ['text'] };
`);
});

Expand Down Expand Up @@ -573,6 +587,7 @@ describe('docs-mdx-compiler-plugin', () => {
const componentMeta = {
title: 'Button',
tags: ['mdx'],
includeStories: ['one', 'helloStory', 'wPunctuation', '_1FineDay'],
};
`);
Expand All @@ -598,7 +613,7 @@ describe('docs-mdx-compiler-plugin', () => {
basic.storyName = 'basic';
basic.parameters = { storySource: { source: 'basicFn' } };
const componentMeta = { title: 'story-function-var', includeStories: ['basic'] };
const componentMeta = { title: 'story-function-var', tags: ['mdx'], includeStories: ['basic'] };
`);
});

Expand Down Expand Up @@ -660,7 +675,7 @@ describe('docs-mdx-compiler-plugin', () => {
storySource: { source: '<p>{"Hello Child #1"}</p>\\n"\\\\n"\\n<p>{"Hello Child #2"}</p>' },
};
const componentMeta = { title: 'Multiple', includeStories: ['multipleChildren'] };
const componentMeta = { title: 'Multiple', tags: ['mdx'], includeStories: ['multipleChildren'] };
`);
});

Expand Down Expand Up @@ -705,7 +720,7 @@ describe('docs-mdx-compiler-plugin', () => {
},
};
const componentMeta = { title: 'MDX|Welcome', includeStories: ['toStorybook'] };
const componentMeta = { title: 'MDX|Welcome', tags: ['mdx'], includeStories: ['toStorybook'] };
`);
});

Expand Down Expand Up @@ -739,7 +754,11 @@ describe('docs-mdx-compiler-plugin', () => {
__page.parameters = { docsOnly: true };
const componentMeta = { title: \`\${titleFunction('template')}\`, includeStories: ['__page'] };
const componentMeta = {
title: \`\${titleFunction('template')}\`,
tags: ['mdx'],
includeStories: ['__page'],
};
`);
});

Expand Down Expand Up @@ -793,7 +812,7 @@ describe('docs-mdx-compiler-plugin', () => {
__page.parameters = { docsOnly: true };
const componentMeta = { includeStories: ['__page'] };
const componentMeta = { tags: ['mdx'], includeStories: ['__page'] };
`);
});

Expand All @@ -814,7 +833,7 @@ describe('docs-mdx-compiler-plugin', () => {
basic.storyName = 'Basic';
basic.parameters = { storySource: { source: '<Button>{"Basic"}</Button>' } };
const componentMeta = { component: Button, includeStories: ['basic'] };
const componentMeta = { component: Button, tags: ['mdx'], includeStories: ['basic'] };
`);
});

Expand All @@ -833,7 +852,12 @@ describe('docs-mdx-compiler-plugin', () => {
basic.storyName = 'Basic';
basic.parameters = { storySource: { source: '{}' } };
const componentMeta = { title: 'Button', component: Button, includeStories: ['basic'] };
const componentMeta = {
title: 'Button',
component: Button,
tags: ['mdx'],
includeStories: ['basic'],
};
`);
});

Expand All @@ -856,6 +880,7 @@ describe('docs-mdx-compiler-plugin', () => {
title: 'Button',
component: Button,
render: (args) => <Button {...args} />,
tags: ['mdx'],
includeStories: ['basic'],
};
`);
Expand All @@ -877,7 +902,12 @@ describe('docs-mdx-compiler-plugin', () => {
basic.parameters = { storySource: { source: '{}' } };
basic.render = (args) => <Button {...args} />;
const componentMeta = { title: 'Button', component: Button, includeStories: ['basic'] };
const componentMeta = {
title: 'Button',
component: Button,
tags: ['mdx'],
includeStories: ['basic'],
};
`);
});

Expand All @@ -897,7 +927,12 @@ describe('docs-mdx-compiler-plugin', () => {
basic.parameters = { storySource: { source: '{}' } };
basic.play = () => console.log('play');
const componentMeta = { title: 'Button', component: Button, includeStories: ['basic'] };
const componentMeta = {
title: 'Button',
component: Button,
tags: ['mdx'],
includeStories: ['basic'],
};
`);
});
});
Expand Down Expand Up @@ -936,7 +971,7 @@ describe('docs-mdx-compiler-plugin', () => {
__page.parameters = { docsOnly: true };
const componentMeta = { title: 'Example/Introduction', includeStories: ['__page'] };
const componentMeta = { title: 'Example/Introduction', tags: ['mdx'], includeStories: ['__page'] };
`);
});
});
1 change: 1 addition & 0 deletions src/sb-mdx-plugin.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,7 @@ export function genMeta(ast: t.JSXElement, options: CompilerOptions) {
args,
argTypes,
render,
tags: "['mdx']",
};
}

Expand Down

0 comments on commit 706a0bb

Please sign in to comment.