main-config-build.md

title
build

Parent: main.js|ts configuration

Type: TestBuildConfig

Provides configuration options to optimize Storybook's production build output.

test

Type: TestBuildFlags

{
  disableBlocks?: boolean;
  disabledAddons?: string[];
  disableMDXEntries?: boolean;
  disableAutoDocs?: boolean;
  disableDocgen?: boolean;
  disableSourcemaps?: boolean;
  disableTreeShaking?: boolean;

}

Configures Storybook's production builds for performance testing purposes by disabling certain features from the build. When running build-storybook, this feature is enabled by setting the --test flag.

The options documented on this page are automatically enabled when the --test flag is provided to the build-storybook command. We encourage you to override these options only if you need to disable a specific feature for your project or if you are debugging a build issue.

test.disableBlocks

Type: boolean

Excludes the @storybook/blocks package from the build, which generates automatic documentation with Docs Blocks.

<CodeSnippets paths={[ 'common/main-config-test-disable-blocks.js.mdx', 'common/main-config-test-disable-blocks.ts.mdx', ]} />

test.disabledAddons

Type: string[]

Sets the list of addons that will disabled in the build output.

<CodeSnippets paths={[ 'common/main-config-test-disable-disableaddons.js.mdx', 'common/main-config-test-disable-disableaddons.ts.mdx', ]} />

test.disableMDXEntries

Type: boolean

Enabling this option removes user-written documentation entries in MDX format from the build.

<CodeSnippets paths={[ 'common/main-config-test-disable-mdx.js.mdx', 'common/main-config-test-disable-mdx.ts.mdx', ]} />

test.disableAutoDocs

Type: boolean

Prevents automatic documentation generated with the autodocs feature from being included in the build.

<CodeSnippets paths={[ 'common/main-config-test-disable-autodocs.js.mdx', 'common/main-config-test-disable-autodocs.ts.mdx', ]} />

test.disableDocgen

Type: boolean

Disables automatic argType and component property inference with any of the supported static analysis tools based on the framework you are using.

<CodeSnippets paths={[ 'common/main-config-test-disable-docgen.js.mdx', 'common/main-config-test-disable-docgen.ts.mdx', ]} />

test.disableSourcemaps

Type: boolean

Overrides the default behavior of generating source maps for the build.

<CodeSnippets paths={[ 'common/main-config-test-disable-sourcemaps.js.mdx', 'common/main-config-test-disable-sourcemaps.ts.mdx', ]} />

test.disableTreeShaking

Type: boolean

Disables tree shaking in the build.

<CodeSnippets paths={[ 'common/main-config-test-disable-treeshaking.js.mdx', 'common/main-config-test-disable-treeshaking.ts.mdx', ]} />