Skip to content

Commit

Permalink
Merge pull request #12603 from g1eny0ung/fix/doc-disbale-refs
Browse files Browse the repository at this point in the history
Composition: Rename `disabled` parameter => `disable`
  • Loading branch information
shilman committed Sep 30, 2020
2 parents f300975 + d03f3dd commit 4f5ab9f
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
7 changes: 7 additions & 0 deletions MIGRATION.md
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
20 changes: 19 additions & 1 deletion lib/core/src/server/manager/manager-config.js
Expand Up @@ -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';

Expand Down Expand Up @@ -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 });
Expand All @@ -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;
}
Expand All @@ -96,6 +113,7 @@ async function getManagerWebpackConfig(options, presets) {
};
});
}

if (autoRefs || definedRefs) {
entries.push(path.resolve(path.join(options.configDir, `generated-refs.js`)));

Expand Down

0 comments on commit 4f5ab9f

Please sign in to comment.