Skip to content

Commit

Permalink
Experimental Nextjs: Add docgen types to main config
Browse files Browse the repository at this point in the history
  • Loading branch information
yannbf committed Dec 13, 2024
1 parent 6e0da96 commit 9c4d4f0
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions code/frameworks/experimental-nextjs-vite/src/types.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
import type {
CompatibleString,
StorybookConfig as StorybookConfigBase,
TypescriptOptions as TypescriptOptionsBase,
} from 'storybook/internal/types';

import type { BuilderOptions, StorybookConfigVite } from '@storybook/builder-vite';

import type docgenTypescript from '@joshwooding/vite-plugin-react-docgen-typescript';

type FrameworkName = CompatibleString<'@storybook/experimental-nextjs-vite'>;
type BuilderName = CompatibleString<'@storybook/builder-vite'>;

Expand All @@ -31,10 +34,23 @@ type StorybookConfigFramework = {
};
};

type TypescriptOptions = TypescriptOptionsBase & {
/**
* Sets the type of Docgen when working with React and TypeScript
*
* @default `'react-docgen'`
*/
reactDocgen: 'react-docgen-typescript' | 'react-docgen' | false;
/** Configures `@joshwooding/vite-plugin-react-docgen-typescript` */
reactDocgenTypescriptOptions: Parameters<typeof docgenTypescript>[0];
};

/** The interface for Storybook configuration in `main.ts` files. */
export type StorybookConfig = Omit<
StorybookConfigBase,
keyof StorybookConfigVite | keyof StorybookConfigFramework
keyof StorybookConfigVite | keyof StorybookConfigFramework | 'typescript'
> &
StorybookConfigVite &
StorybookConfigFramework & {};
StorybookConfigFramework & {
typescript?: Partial<TypescriptOptions>;
};

0 comments on commit 9c4d4f0

Please sign in to comment.