From aa8a4219076fb0fd1738ac1b05a0a7f693726707 Mon Sep 17 00:00:00 2001
From: Tom Coleman <tom@thesnail.org>
Date: Wed, 4 Jul 2018 15:56:17 +1000
Subject: [PATCH] Added `allowDeprecatedUsage` option to `makeDecorator`

(and enable it for all existing addons)
---
 addons/backgrounds/src/index.js       |  1 +
 addons/info/src/index.js              |  1 +
 addons/knobs/src/index.js             |  1 +
 addons/notes/src/index.js             |  1 +
 lib/addons/src/make-decorator.js      | 17 ++++++++++++-----
 lib/addons/src/make-decorator.test.js | 22 ++++++++++++++++++++--
 6 files changed, 36 insertions(+), 7 deletions(-)

diff --git a/addons/backgrounds/src/index.js b/addons/backgrounds/src/index.js
index 293d82d6106..859375d6607 100644
--- a/addons/backgrounds/src/index.js
+++ b/addons/backgrounds/src/index.js
@@ -15,6 +15,7 @@ export const withBackgrounds = makeDecorator({
   name: 'backgrounds',
   parameterName: 'backgrounds',
   skipIfNoParametersOrOptions: true,
+  allowDeprecatedUsage: true,
   wrapper: (getStory, context, { options, parameters }) => {
     const backgrounds = parameters || options;
 
diff --git a/addons/info/src/index.js b/addons/info/src/index.js
index 3813949ab15..b6abfae8ad9 100644
--- a/addons/info/src/index.js
+++ b/addons/info/src/index.js
@@ -87,6 +87,7 @@ function addInfo(storyFn, context, infoOptions) {
 export const withInfo = makeDecorator({
   name: 'withInfo',
   parameterName: 'info',
+  allowDeprecatedUsage: true,
   wrapper: (getStory, context, { options, parameters }) => {
     const storyOptions = parameters || options;
     const infoOptions = typeof storyOptions === 'string' ? { text: storyOptions } : storyOptions;
diff --git a/addons/knobs/src/index.js b/addons/knobs/src/index.js
index f78acd1dffe..6aec38d440c 100644
--- a/addons/knobs/src/index.js
+++ b/addons/knobs/src/index.js
@@ -77,6 +77,7 @@ export const withKnobs = makeDecorator({
   name: 'withKnobs',
   parameterName: 'knobs',
   skipIfNoParametersOrOptions: false,
+  allowDeprecatedUsage: true,
   wrapper: (getStory, context, { options, parameters }) => {
     const storyOptions = parameters || options;
     const allOptions = { ...defaultOptions, ...storyOptions };
diff --git a/addons/notes/src/index.js b/addons/notes/src/index.js
index 1f983df6da1..0da32aa7871 100644
--- a/addons/notes/src/index.js
+++ b/addons/notes/src/index.js
@@ -10,6 +10,7 @@ export const withNotes = makeDecorator({
   name: 'withNotes',
   parameterName: 'notes',
   skipIfNoParametersOrOptions: true,
+  allowDeprecatedUsage: true,
   wrapper: (getStory, context, { options, parameters }) => {
     const channel = addons.getChannel();
 
diff --git a/lib/addons/src/make-decorator.js b/lib/addons/src/make-decorator.js
index dc2669b3561..e7df28f726f 100644
--- a/lib/addons/src/make-decorator.js
+++ b/lib/addons/src/make-decorator.js
@@ -15,6 +15,7 @@ export const makeDecorator = ({
   parameterName,
   wrapper,
   skipIfNoParametersOrOptions = false,
+  allowDeprecatedUsage = false,
 }) => {
   const decorator = options => (getStory, context) => {
     const parameters = context.parameters && context.parameters[parameterName];
@@ -44,11 +45,17 @@ export const makeDecorator = ({
         return decorator(...args)(...innerArgs);
       }
 
-      // Used to wrap a story directly .add('story', decorator(options)(() => <Story />))
-      //   This is now deprecated:
-      return deprecate(
-        context => decorator(...args)(innerArgs[0], context),
-        `Passing stories directly into ${name}() is deprecated, instead use addDecorator(${name}) and pass options with the '${parameterName}' parameter`
+      if (allowDeprecatedUsage) {
+        // Used to wrap a story directly .add('story', decorator(options)(() => <Story />))
+        //   This is now deprecated:
+        return deprecate(
+          context => decorator(...args)(innerArgs[0], context),
+          `Passing stories directly into ${name}() is deprecated, instead use addDecorator(${name}) and pass options with the '${parameterName}' parameter`
+        );
+      }
+
+      throw new Error(
+        `Passing stories directly into ${name}() is not allowed, instead use addDecorator(${name}) and pass options with the '${parameterName}' parameter`
       );
     };
   };
diff --git a/lib/addons/src/make-decorator.test.js b/lib/addons/src/make-decorator.test.js
index e6e94ae7e74..9beb3a70651 100644
--- a/lib/addons/src/make-decorator.test.js
+++ b/lib/addons/src/make-decorator.test.js
@@ -103,10 +103,15 @@ describe('makeDecorator', () => {
     expect(story).toHaveBeenCalled();
   });
 
-  it('passes options added at story time, but with a deprecation warning', () => {
+  it('passes options added at story time, but with a deprecation warning, if allowed', () => {
     deprecatedFns = [];
     const wrapper = jest.fn();
-    const decorator = makeDecorator({ wrapper, name: 'test', parameterName: 'test' });
+    const decorator = makeDecorator({
+      wrapper,
+      name: 'test',
+      parameterName: 'test',
+      allowDeprecatedUsage: true,
+    });
     const options = 'test-val';
     const story = jest.fn();
     const decoratedStory = decorator(options)(story);
@@ -121,4 +126,17 @@ describe('makeDecorator', () => {
     });
     expect(deprecatedFns[0].deprecatedFn).toHaveBeenCalled();
   });
+
+  it('throws if options are added at storytime, if not allowed', () => {
+    const wrapper = jest.fn();
+    const decorator = makeDecorator({
+      wrapper,
+      name: 'test',
+      parameterName: 'test',
+      allowDeprecatedUsage: false,
+    });
+    const options = 'test-val';
+    const story = jest.fn();
+    expect(() => decorator(options)(story)).toThrow(/not allowed/);
+  });
 });