Update StoryIndexGenerator to generate "template" entries

Template (standalone: false) entries are needed for: - Docs Page - *.stories.mdx files that define a docs page and stories. A Template entry expects to be rendered from and against a story file. (A standalone entry expects to be rendered as a MDX file)
storybookjs · Jul 7, 2022 · 0dd08bb · 0dd08bb
1 parent 223bfe6
commit 0dd08bb
Show file tree

Hide file tree

Showing 19 changed files with 718 additions and 121 deletions.
diff --git a/addons/docs/src/preset.ts b/addons/docs/src/preset.ts
@@ -151,6 +151,7 @@ export const storyIndexers = async (indexers: StoryIndexer[] | null) => {
     {
       test: /(stories|story)\.mdx$/,
       indexer: mdxIndexer,
+      addDocsTemplate: true,
     },
     ...(indexers || []),
   ];

diff --git a/lib/addons/src/types.ts b/lib/addons/src/types.ts
@@ -65,8 +65,14 @@ export type StoryIndexEntry = BaseIndexEntry & {
 export type DocsIndexEntry = BaseIndexEntry & {
   storiesImports: Path[];
   type: 'docs';
-  legacy?: boolean;
+  standalone: boolean;
 };
+
+/** A StandaloneDocsIndexExtry represents a file who's default export is directly renderable */
+export type StandaloneDocsIndexEntry = DocsIndexEntry & { standalone: true };
+/** A TemplateDocsIndexEntry represents a stories file that gets rendered in "docs" mode */
+export type TemplateDocsIndexEntry = DocsIndexEntry & { standalone: false };
+
 export type IndexEntry = StoryIndexEntry | DocsIndexEntry;
 
 // The `any` here is the story store's `StoreItem` record. Ideally we should probably only

diff --git a/lib/core-common/src/types.ts b/lib/core-common/src/types.ts
@@ -224,6 +224,7 @@ export interface StoryIndex {
 export interface StoryIndexer {
   test: RegExp;
   indexer: (fileName: string, options: IndexerOptions) => Promise<StoryIndex>;
+  addDocsTemplate?: boolean;
 }
 
 /**

diff --git a/lib/core-server/package.json b/lib/core-server/package.json
@@ -41,7 +41,7 @@
     "@storybook/core-events": "7.0.0-alpha.11",
     "@storybook/csf": "0.0.2--canary.4566f4d.1",
     "@storybook/csf-tools": "7.0.0-alpha.11",
-    "@storybook/docs-mdx": "0.0.1-canary.1.4bea5cc.0",
+    "@storybook/docs-mdx": "0.0.1-canary.12433cf.0",
     "@storybook/node-logger": "7.0.0-alpha.11",
     "@storybook/semver": "^7.3.2",
     "@storybook/store": "7.0.0-alpha.11",