GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-05 06:41:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

Don't show docspage unless the user opts in

Browse Source
This commit is contained in:
Tom Coleman 2022-10-26 17:32:44 +11:00
parent 3a1a90a98e
commit 880739d940
8 changed files with 33 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
code/addons/docs/template/stories/docspage/basic.stories.ts vendored
View File

@ -2,6 +2,7 @@ import globalThis from 'global';
export default {
component: globalThis.Components.Button,
tags: ['docsPage'],
args: { label: 'Click Me!' },
parameters: { chromatic: { disable: true } },
};

1
code/addons/docs/template/stories/docspage/description.stories.ts vendored
View File

@ -6,6 +6,7 @@ export default {
subcomponents: {
Pre: globalThis.Components.Pre,
},
tags: ['docsPage'],
args: { label: 'Click Me!' },
parameters: {
docs: {

1
code/addons/docs/template/stories/docspage/extract-description.stories.ts vendored
View File

@ -2,6 +2,7 @@ import globalThis from 'global';
export default {
component: globalThis.Components.Button,
tags: ['docsPage'],
args: { label: 'Click Me!' },
parameters: {
docs: {

1
code/addons/docs/template/stories/docspage/iframe.stories.ts vendored
View File

@ -2,6 +2,7 @@ import globalThis from 'global';
export default {
component: globalThis.Components.Button,
tags: ['docsPage'],
args: { label: 'Rendered in iframe' },
parameters: {
chromatic: { disable: true },

1
code/addons/docs/template/stories/docspage/overflow.stories.ts vendored
View File

@ -2,6 +2,7 @@ import globalThis from 'global';
export default {
component: globalThis.Components.Pre,
tags: ['docsPage'],
args: {
text: 'Demonstrates overflow',
style: { width: 2000, height: 500, background: 'hotpink' },

1
code/addons/docs/template/stories/docspage/override.stories.ts vendored
View File

@ -15,6 +15,7 @@ const Override = () => 'overridden';
export default {
component: globalThis.Components.Button,
tags: ['docsPage'],
args: { label: 'Click Me!' },
parameters: {
chromatic: { disable: true },

1
code/addons/docs/template/stories/docspage/source.stories.ts vendored
View File

@ -2,6 +2,7 @@ import globalThis from 'global';
export default {
component: globalThis.Components.Button,
tags: ['docsPage'],
args: { label: 'Click Me!' },
parameters: { chromatic: { disable: true } },
};

49
code/lib/client-api/src/StoryStoreFacade.ts
View File

@ -146,7 +146,7 @@ export class StoryStoreFacade<TFramework extends AnyFramework> {
const { default: defaultExport, __namedExportsOrder, ...namedExports } = fileExports;
// eslint-disable-next-line prefer-const
let { id: componentId, title } = defaultExport || {};
let { id: componentId, title, tags: componentTags = [] } = defaultExport || {};
const specifiers = (global.STORIES || []).map(
(specifier: Store_NormalizedStoriesSpecifier & { importPathMatcher: string }) => ({
@ -188,6 +188,30 @@ export class StoryStoreFacade<TFramework extends AnyFramework> {
isExportStory(key, defaultExport)
);
// NOTE: this logic is equivalent to the `extractStories` function of `StoryIndexGenerator`
const docsOptions = (global.DOCS_OPTIONS || {}) as DocsOptions;
if (docsOptions.enabled && storyExports.length) {
// We will use tags soon and this crappy filename test will go away
if (
fileName.match(/\.mdx$/) ||
(docsOptions.docsPage && componentTags.includes('docsPage'))
) {
const name = docsOptions.defaultName;
const docsId = toId(componentId || title, name);
this.entries[docsId] = {
type: 'docs',
standalone: false,
id: docsId,
title,
name,
importPath: fileName,
componentId,
tags: [...componentTags, 'docs'],
storiesImports: [],
};
}
}
storyExports.forEach(([key, storyExport]: [string, any]) => {
const exportName = storyNameFromExport(key);
const id = storyExport.parameters?.__id || toId(componentId || title, exportName);
@ -205,30 +229,9 @@ export class StoryStoreFacade<TFramework extends AnyFramework> {
title,
importPath: fileName,
componentId,
tags: [...(storyExport.tags || []), ...(defaultExport.tags || []), 'story'],
tags: [...(storyExport.tags || []), ...componentTags, 'story'],
};
}
});
// NOTE: this logic is equivalent to the `extractStories` function of `StoryIndexGenerator`
const docsOptions = (global.DOCS_OPTIONS || {}) as DocsOptions;
if (docsOptions.enabled && storyExports.length) {
// We will use tags soon and this crappy filename test will go away
if (fileName.match(/\.mdx$/) || docsOptions.docsPage) {
const name = docsOptions.defaultName;
const docsId = toId(componentId || title, name);
this.entries[docsId] = {
type: 'docs',
standalone: false,
id: docsId,
title,
name,
importPath: fileName,
componentId,
tags: [...(defaultExport.tags || []), 'docs'],
storiesImports: [],
};
}
}
}
}