Merge pull request #30676 from storybookjs/kasper/internal-react-preview

CSF: Only export definePreview from the framework

Author: kasperpeulen

code/core/src/csf/csf-factories.ts

@@ -1,4 +1,4 @@
-/* eslint-disable no-underscore-dangle */
+/* eslint-disable no-underscore-dangle,@typescript-eslint/naming-convention */
 import type {
   Args,
   ComponentAnnotations,
@@ -20,7 +20,8 @@ export interface Preview<TRenderer extends Renderer = Renderer> {
   meta(input: ComponentAnnotations<TRenderer>): Meta<TRenderer>;
 }
 
-export function definePreview<TRenderer extends Renderer>(
+/** Do not use, use the definePreview exported from the framework instead. */
+export function __definePreview<TRenderer extends Renderer>(
   input: Preview<TRenderer>['input']
 ): Preview<TRenderer> {
   let composed: NormalizedProjectAnnotations<TRenderer>;

code/frameworks/experimental-nextjs-vite/src/index.ts

@@ -1,5 +1,5 @@
 import type { ReactPreview } from '@storybook/react';
-import { definePreview as definePreviewBase } from '@storybook/react';
+import { __definePreview } from '@storybook/react';
 
 import type vitePluginStorybookNextJs from 'vite-plugin-storybook-nextjs';
 
@@ -15,7 +15,7 @@ declare module '@storybook/experimental-nextjs-vite/vite-plugin' {
 }
 
 export function definePreview(preview: NextPreview['input']) {
-  return definePreviewBase({
+  return __definePreview({
     ...preview,
     addons: [nextPreview, ...(preview.addons ?? [])],
   }) as NextPreview;

code/frameworks/nextjs/src/index.ts

@@ -1,13 +1,13 @@
 import type { ReactPreview } from '@storybook/react';
-import { definePreview as definePreviewBase } from '@storybook/react';
+import { __definePreview } from '@storybook/react';
 
 import * as nextPreview from './preview';
 
 export * from './types';
 export * from './portable-stories';
 
 export function definePreview(preview: NextPreview['input']) {
-  return definePreviewBase({
+  return __definePreview({
     ...preview,
     addons: [nextPreview, ...(preview.addons ?? [])],
   }) as NextPreview;

code/frameworks/react-native-web-vite/src/index.ts

@@ -1,3 +1,3 @@
 export type { FrameworkOptions, StorybookConfig } from './types';
 
-export { definePreview } from '@storybook/react';
+export { __definePreview as definePreview } from '@storybook/react';

code/frameworks/react-vite/src/index.ts

@@ -1,3 +1,3 @@
-export { definePreview } from '@storybook/react';
+export { __definePreview as definePreview } from '@storybook/react';
 
 export * from './types';

code/frameworks/react-webpack5/src/index.ts

@@ -1,2 +1,2 @@
 export * from './types';
-export { definePreview } from '@storybook/react';
+export { __definePreview as definePreview } from '@storybook/react';

code/renderers/react/src/__test__/Button.csf4.stories.tsx

@@ -5,10 +5,10 @@ import { expect, fn, mocked, userEvent, within } from '@storybook/test';
 
 import { action } from '@storybook/addon-actions';
 
-import { definePreview } from '../preview';
+import { __definePreview } from '../preview';
 import { Button } from './Button';
 
-const preview = definePreview({});
+const preview = __definePreview({});
 
 const meta = preview.meta({
   id: 'button-component',

code/renderers/react/src/csf-factories.test.tsx

@@ -14,16 +14,16 @@ import { fn } from '@storybook/test';
 
 import { expectTypeOf } from 'expect-type';
 
-import { definePreview } from './preview';
+import { __definePreview } from './preview';
 import type { Decorator } from './public-types';
 
 type ButtonProps = { label: string; disabled: boolean };
 const Button: (props: ButtonProps) => ReactElement = () => <></>;
 
-const preview = definePreview({});
+const preview = __definePreview({});
 
 test('csf factories', () => {
-  const config = definePreview({
+  const config = __definePreview({
     addons: [
       {
         decorators: [],

code/renderers/react/src/preview.tsx

@@ -1,6 +1,7 @@
+/* eslint-disable no-underscore-dangle,@typescript-eslint/naming-convention */
 import type { ComponentType } from 'react';
 
-import { definePreview as definePreviewBase } from 'storybook/internal/csf';
+import { __definePreview as definePreviewBase } from 'storybook/internal/csf';
 import type { Meta, Preview, Story } from 'storybook/internal/csf';
 import type {
   Args,
@@ -18,7 +19,8 @@ import * as reactDocsAnnotations from './entry-preview-docs';
 import type { AddMocks } from './public-types';
 import type { ReactRenderer } from './types';
 
-export function definePreview(preview: ReactPreview['input']) {
+/** Do not use, use the definePreview exported from the framework instead */
+export function __definePreview(preview: ReactPreview['input']) {
   return definePreviewBase({
     ...preview,
     addons: [reactAnnotations, reactDocsAnnotations, ...(preview.addons ?? [])],