@storybook/core-webpack
Advanced tools
Package description
The @storybook/core-webpack package is a part of the Storybook ecosystem, specifically designed to customize and extend Storybook's Webpack configurations. It allows developers to modify the default Webpack configuration used by Storybook to better suit their project's needs, including adding loaders, plugins, and modifying existing configurations. This package is essential for projects that require a high degree of customization for their Storybook setup, enabling seamless integration with a wide range of web development tools and workflows.
Customizing Webpack Config
This feature allows developers to customize the Webpack configuration used by Storybook. The code sample demonstrates how to merge a custom Webpack configuration with Storybook's default configuration, specifically adding support for SCSS files.
const { merge } = require('webpack-merge');
module.exports = ({ config }) => {
return merge(config, {
// Custom Webpack configuration
module: {
rules: [{ test: /\.scss$/, use: ['style-loader', 'css-loader', 'sass-loader'] }]
}
});
};Adding Webpack Plugins
Developers can extend Storybook's Webpack configuration by adding additional Webpack plugins. The code sample shows how to add a custom plugin to the configuration.
const SomeWebpackPlugin = require('some-webpack-plugin');
module.exports = ({ config }) => {
config.plugins.push(new SomeWebpackPlugin());
return config;
};Modifying Existing Loaders
This functionality allows for the modification of existing loaders in the Webpack configuration. The code sample illustrates how to find and modify a specific loader to add an additional 'some-loader' for handling files.
module.exports = ({ config }) => {
const rules = config.module.rules;
const someRuleIndex = rules.findIndex(rule => rule.test.toString() === '/\.somefile$/');
if (someRuleIndex !== -1) {
rules[someRuleIndex].use.push('some-loader');
}
return config;
};While not a Storybook-specific package, webpack-merge is often used in conjunction with @storybook/core-webpack for merging custom Webpack configurations with Storybook's default. It provides a streamlined way to combine configurations, which is essential for complex setups.
customize-cra is designed for overriding Create React App's Webpack configurations without 'ejecting'. It offers a similar value proposition to @storybook/core-webpack but is specifically tailored for CRA projects. Unlike @storybook/core-webpack, it doesn't directly integrate with Storybook but demonstrates the demand for customization in tooling environments.
Changelog
7.0.0-alpha.48 (November 7, 2022)
parameters.docs.autoplay #19659automatic to create docs entries for all components #19713-s flag on sb init #19585Readme
Common utilities used across @storybook/core-server (manager UI configuration) and @storybook/builder-webpack{4,5} (preview configuration).
This is a lot of code extracted for convenience, not because it made sense.
Supporting multiple version of webpack and this duplicating a large portion of code that was never meant to be generic caused this.
At some point we'll refactor this, it's likely a lot of this code is dead or barely used.
FAQs
Storybook framework-agnostic API
We found that @storybook/core-webpack demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 11 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
![Massive Automated Spam Campaign Abuses GitHub to Flood npm Registry with Thousands of Garbage Tea[.]xyz Packages](https://cdn.sanity.io/images/cgdhsj6q/production/a74d1072ff2bb5cb96a404be58a649931ced2ba5-1024x1024.webp?w=400&fit=max&auto=format)
Security News
In a reprisal of their previous Tea[.]xyz spam campaign, a new wave of thousands of garbage packages are hitting npm, to artificially inflate the number of dependents for spammers' projects.
Security News
The maintainer of the node-ip project restored the GitHub repo after disputing an exaggerated CVE rating, highlighting the impact of bogus CVEs on open source projects.
Security News
pnpm 9.5 introduces a Catalogs feature, enabling shareable dependency version specifiers, reducing merge conflicts and improving support for monorepos.