diff --git a/MIGRATION.md b/MIGRATION.md index 49708f886919..6da0ab7e8aff 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -4,6 +4,7 @@ - [6.1 deprecations](#61-deprecations) - [Deprecated onBeforeRender](#deprecated-onbeforerender) - [Deprecated grid parameter](#deprecated-grid-parameter) + - [Deprecated package-composition disabled parameter](#deprecated-package-composition-disabled-parameter) - [From version 5.3.x to 6.0.x](#from-version-53x-to-60x) - [Hoisted CSF annotations](#hoisted-csf-annotations) - [Zero config typescript](#zero-config-typescript) @@ -174,6 +175,12 @@ Basic.parameters: { }, ``` +#### Deprecated package-composition disabled parameter + +Like [Deprecated disabled parameter](#deprecated-disabled-parameter). The `disabled` parameter has been deprecated, please use `disable` instead. + +For more information, see the [the related documentation](https://storybook.js.org/docs/react/workflows/package-composition#configuring). + ## From version 5.3.x to 6.0.x ### Hoisted CSF annotations diff --git a/docs/snippets/common/storybook-main-disable-refs.js.mdx b/docs/snippets/common/storybook-main-disable-refs.js.mdx index 8c4a3a8c4488..9c43827348cb 100644 --- a/docs/snippets/common/storybook-main-disable-refs.js.mdx +++ b/docs/snippets/common/storybook-main-disable-refs.js.mdx @@ -4,6 +4,6 @@ module.exports = { // your Storybook configuration refs: { - 'package-name': { disabled: true } + 'package-name': { disable: true } } ``` \ No newline at end of file diff --git a/lib/core/src/server/manager/manager-config.js b/lib/core/src/server/manager/manager-config.js index 389aecec7629..14686cc87162 100644 --- a/lib/core/src/server/manager/manager-config.js +++ b/lib/core/src/server/manager/manager-config.js @@ -3,6 +3,8 @@ import fs from 'fs-extra'; import findUp from 'find-up'; import resolveFrom from 'resolve-from'; import fetch from 'node-fetch'; +import deprecate from 'util-deprecate'; +import dedent from 'ts-dedent'; import { logger } from '@storybook/node-logger'; @@ -55,6 +57,15 @@ const toTitle = (input) => { return `${result.substring(0, 1).toUpperCase()}${result.substring(1)}`.trim(); }; +const deprecatedDefinedRefDisabled = deprecate( + () => {}, + dedent` + Deprecated parameter: disabled => disable + + https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#deprecated-package-composition-disabled-parameter + ` +); + async function getManagerWebpackConfig(options, presets) { const typescriptOptions = await presets.apply('typescript', { ...typeScriptDefaults }, options); const babelOptions = await presets.apply('babel', {}, { ...options, typescriptOptions }); @@ -78,7 +89,13 @@ async function getManagerWebpackConfig(options, presets) { if (definedRefs) { Object.entries(definedRefs).forEach(([key, value]) => { - if (value?.disabled) { + const { disable, disabled } = value; + + if (disable || disabled) { + if (disabled) { + deprecatedDefinedRefDisabled(); + } + delete refs[key.toLowerCase()]; return; } @@ -96,6 +113,7 @@ async function getManagerWebpackConfig(options, presets) { }; }); } + if (autoRefs || definedRefs) { entries.push(path.resolve(path.join(options.configDir, `generated-refs.js`)));