mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-07 05:21:06 +08:00
122 lines
3.0 KiB
Plaintext
122 lines
3.0 KiB
Plaintext
---
|
|
title: 'build'
|
|
sidebar:
|
|
order: 7
|
|
title: build
|
|
---
|
|
|
|
Parent: [main.js|ts configuration](./main-config.mdx)
|
|
|
|
Type: `TestBuildConfig`
|
|
|
|
Provides configuration options to optimize Storybook's production build output.
|
|
|
|
## `test`
|
|
|
|
Type: `TestBuildFlags`
|
|
|
|
```ts
|
|
{
|
|
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](../cli-options.mdx#build).
|
|
|
|
<Callout variant="info" icon="💡">
|
|
|
|
The options documented on this page are automatically enabled when the `--test` flag is provided to the [`storybook build`](../cli-options.mdx#build) 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.
|
|
|
|
</Callout>
|
|
|
|
### `test.disableBlocks`
|
|
|
|
Type: `boolean`
|
|
|
|
Excludes the `@storybook/blocks` package from the build, which generates automatic documentation with [Docs Blocks](../../writing-docs/doc-blocks.mdx).
|
|
|
|
{/* prettier-ignore-start */}
|
|
|
|
<CodeSnippets path="main-config-test-disable-blocks.md" />
|
|
|
|
{/* prettier-ignore-end */}
|
|
|
|
### `test.disabledAddons`
|
|
|
|
Type: `string[]`
|
|
|
|
Sets the list of addons that will disabled in the build output.
|
|
|
|
{/* prettier-ignore-start */}
|
|
|
|
<CodeSnippets path="main-config-test-disable-disableaddons.md" />
|
|
|
|
{/* prettier-ignore-end */}
|
|
|
|
### `test.disableMDXEntries`
|
|
|
|
Type: `boolean`
|
|
|
|
Enabling this option removes user-written documentation entries in MDX format from the build.
|
|
|
|
{/* prettier-ignore-start */}
|
|
|
|
<CodeSnippets path="main-config-test-disable-mdx.md" />
|
|
|
|
{/* prettier-ignore-end */}
|
|
|
|
### `test.disableAutoDocs`
|
|
|
|
Type: `boolean`
|
|
|
|
Prevents automatic documentation generated with the [autodocs](../../writing-docs/autodocs.mdx) feature from being included in the build.
|
|
|
|
{/* prettier-ignore-start */}
|
|
|
|
<CodeSnippets path="main-config-test-disable-autodocs.md" />
|
|
|
|
{/* prettier-ignore-end */}
|
|
|
|
### `test.disableDocgen`
|
|
|
|
Type: `boolean`
|
|
|
|
Disables [automatic argType](../arg-types.mdx#automatic-argtype-inference) and component property inference with any of the supported static analysis tools based on the framework you are using.
|
|
|
|
{/* prettier-ignore-start */}
|
|
|
|
<CodeSnippets path="main-config-test-disable-docgen.md" />
|
|
|
|
{/* prettier-ignore-end */}
|
|
|
|
### `test.disableSourcemaps`
|
|
|
|
Type: `boolean`
|
|
|
|
Overrides the default behavior of generating source maps for the build.
|
|
|
|
{/* prettier-ignore-start */}
|
|
|
|
<CodeSnippets path="main-config-test-disable-sourcemaps.md" />
|
|
|
|
{/* prettier-ignore-end */}
|
|
|
|
### `test.disableTreeShaking`
|
|
|
|
Type: `boolean`
|
|
|
|
Disables [tree shaking](https://developer.mozilla.org/en-US/docs/Glossary/Tree_shaking) in the build.
|
|
|
|
{/* prettier-ignore-start */}
|
|
|
|
<CodeSnippets path="main-config-test-disable-treeshaking.md" />
|
|
|
|
{/* prettier-ignore-end */}
|