Deprecate immutable options as parameters

#11142

MIGRATION.md

@@ -37,6 +37,7 @@
     - [Deprecated addon-contexts](#deprecated-addon-contexts)
     - [Removed addon-centered](#removed-addon-centered)
     - [Deprecated polymer](#deprecated-polymer)
+    - [Deprecated immutable options parameters](#deprecated-immutable-options-parameters)
 - [From version 5.2.x to 5.3.x](#from-version-52x-to-53x)
   - [To main.js configuration](#to-mainjs-configuration)
     - [Using main.js](#using-mainjs)
@@ -625,6 +626,21 @@ Other possible values are: `padded` (default) and `fullscreen`.
 
 We've deprecated `@storybook/polymer` and are focusing on `@storybook/web-components`. If you use Polymer and are interested in maintaining it, please get in touch on [our Discord](https://discordapp.com/invite/UUt2PJb).
 
+#### Deprecated immutable options parameters
+
+The UI options `sidebarAnimations`, `enableShortcuts`, `theme`, `showRoots` should not be changed on a per-story basis, and as such there is no reason to set them via parameters.
+
+You should use `addon.setConfig` to set them:
+
+```js
+// in .storybook/manager.js
+import addons from '@storybook/addons';
+
+addons.setConfig({
+  showRoots: false,
+});
+```
+
 ## From version 5.2.x to 5.3.x
 
 ### To main.js configuration

lib/api/src/modules/layout.ts

@@ -1,10 +1,8 @@
 import { DOCS_MODE, document } from 'global';
-
 import pick from 'lodash/pick';
-
 import deepEqual from 'fast-deep-equal';
-
 import { themes, ThemeVars } from '@storybook/theming';
+
 import merge from '../lib/merge';
 import { State, ModuleFn } from '../index';
 

lib/api/src/modules/stories.ts

@@ -9,6 +9,7 @@ import {
   SET_STORIES,
   CURRENT_STORY_WAS_SET,
 } from '@storybook/core-events';
+import deprecate from 'util-deprecate';
 
 import { logger } from '@storybook/client-logger';
 import {
@@ -26,7 +27,7 @@ import {
   SetStoriesPayloadV2,
 } from '../lib/stories';
 
-import { Args, ModuleFn } from '../index';
+import { Args, ModuleFn, useAddonState } from '../index';
 import { getSourceType } from './refs';
 
 type Direction = -1 | 1;
@@ -64,6 +65,28 @@ export interface SubAPI {
   findLeafStoryId(StoriesHash: StoriesHash, storyId: StoryId): StoryId;
 }
 
+const deprecatedOptionsParameterWarnings: Record<string, () => void> = [
+  'sidebarAnimations',
+  'enableShortcuts',
+  'theme',
+  'showRoots',
+].reduce((acc, option: string) => {
+  acc[option] = deprecate(
+    () => {},
+    `parameters.options.${option} is deprecated and will be removed in Storybook 7.0.
+To change this setting, use \`addons.setConfig\`. See https://github.com/storybookjs/storybook/MIGRATION.md#deprecated-immutable-options-parameters
+  `
+  );
+  return acc;
+}, {} as Record<string, () => void>);
+function checkDeprecatedOptionParameters(options: Record<string, any>) {
+  Object.keys(options).forEach((option: string) => {
+    if (deprecatedOptionsParameterWarnings[option]) {
+      deprecatedOptionsParameterWarnings[option]();
+    }
+  });
+}
+
 export const init: ModuleFn = ({
   fullAPI,
   store,
@@ -285,6 +308,7 @@ export const init: ModuleFn = ({
         const options = fullAPI.getCurrentParameter('options');
 
         if (options) {
+          checkDeprecatedOptionParameters(options);
           fullAPI.setOptions(options);
         }
       }
@@ -317,7 +341,9 @@ export const init: ModuleFn = ({
 
           fullAPI.setStories(stories, error);
 
-          fullAPI.setOptions((data as SetStoriesPayloadV2).globalParameters.options);
+          const { options } = (data as SetStoriesPayloadV2).globalParameters;
+          checkDeprecatedOptionParameters(options);
+          fullAPI.setOptions(options);
           break;
         }