@storybook/addon-docs 7.0.0-alpha.45 → 7.0.0-alpha.47

package/README.md

@@ -142,7 +142,7 @@ module.exports = {
       options: {
         configureJSX: true,
         babelOptions: {},
-        sourceLoaderOptions: null,
+        csfPluginOptions: null,
         transcludeMarkdown: true,
       },
     },
@@ -152,7 +152,7 @@ module.exports = {
 
 The `configureJSX` option is useful when you're writing your docs in MDX and your project's babel config isn't already set up to handle JSX files. `babelOptions` is a way to further configure the babel processor when you're using `configureJSX`.
 
-`sourceLoaderOptions` is an object for configuring `@storybook/source-loader`. When set to `null` it tells docs not to run the `source-loader` at all, which can be used as an optimization, or if you're already using `source-loader` in your `main.js`.
+`csfPluginOptions` is an object for configuring `@storybook/csf-plugin`. When set to `null` it tells docs not to run the `csf-plugin` at all, which can be used as an optimization, or if you're already using `csf-plugin` in your `main.js`.
 
 The `transcludeMarkdown` option enables mdx files to import `.md` files and render them as a component.
 

package/dist/cjs/preset.js

@@ -12,7 +12,7 @@ var _remarkSlug = _interopRequireDefault(require("remark-slug"));
 
 var _remarkExternalLinks = _interopRequireDefault(require("remark-external-links"));
 
-var _nodeLogger = require("@storybook/node-logger");
+var _tsDedent = require("ts-dedent");
 
 var _csfTools = require("@storybook/csf-tools");
 
@@ -62,9 +62,8 @@ async function webpack(webpackConfig = {}, options) {
     babelOptions,
     mdxBabelOptions,
     configureJSX = true,
-    sourceLoaderOptions = {
-      injectStoryParameters: true
-    },
+    csfPluginOptions = {},
+    sourceLoaderOptions = null,
     transcludeMarkdown = false
   } = options;
   const mdxLoaderOptions = {
@@ -73,19 +72,18 @@ async function webpack(webpackConfig = {}, options) {
     remarkPlugins: [_remarkSlug.default, _remarkExternalLinks.default]
   };
 
-  _nodeLogger.logger.info(`Addon-docs: using MDX2`);
+  if (sourceLoaderOptions) {
+    throw new Error((0, _tsDedent.dedent)`
+      Addon-docs no longer uses source-loader in 7.0.
 
-  const mdxLoader = require.resolve('@storybook/mdx2-csf/loader'); // set `sourceLoaderOptions` to `null` to disable for manual configuration
+      To update your configuration, please see migration instructions here:
 
+      https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-source-loader--storiesof-static-snippets
+    `);
+  }
+
+  const mdxLoader = require.resolve('@storybook/mdx2-csf/loader');
 
-  const sourceLoader = sourceLoaderOptions ? [{
-    test: /\.(stories|story)\.[tj]sx?$/,
-    loader: require.resolve('@storybook/source-loader'),
-    options: Object.assign({}, sourceLoaderOptions, {
-      inspectLocalDependencies: true
-    }),
-    enforce: 'pre'
-  }] : [];
   let rules = module.rules || [];
 
   if (transcludeMarkdown) {
@@ -110,6 +108,8 @@ async function webpack(webpackConfig = {}, options) {
   }
 
   const result = Object.assign({}, webpackConfig, {
+    plugins: [...(webpackConfig.plugins || []), // eslint-disable-next-line global-require
+    ...(csfPluginOptions ? [require('@storybook/csf-plugin').webpack(csfPluginOptions)] : [])],
     module: Object.assign({}, module, {
       rules: [...rules, {
         test: /(stories|story)\.mdx$/,
@@ -140,7 +140,7 @@ async function webpack(webpackConfig = {}, options) {
           loader: mdxLoader,
           options: mdxLoaderOptions
         }]
-      }, ...sourceLoader]
+      }]
     })
   });
   return result;

package/dist/esm/preset.js

@@ -1,7 +1,7 @@
 import fs from 'fs-extra';
 import remarkSlug from 'remark-slug';
 import remarkExternalLinks from 'remark-external-links';
-import { logger } from '@storybook/node-logger';
+import { dedent } from 'ts-dedent';
 import { loadCsf } from '@storybook/csf-tools'; // for frameworks that are not working with react, we need to configure
 // the jsx to transpile mdx, for now there will be a flag for that
 // for more complex solutions we can find alone that we need to add '@babel/plugin-transform-react-jsx'
@@ -46,9 +46,8 @@ export async function webpack(webpackConfig = {}, options) {
     babelOptions,
     mdxBabelOptions,
     configureJSX = true,
-    sourceLoaderOptions = {
-      injectStoryParameters: true
-    },
+    csfPluginOptions = {},
+    sourceLoaderOptions = null,
     transcludeMarkdown = false
   } = options;
   const mdxLoaderOptions = {
@@ -56,19 +55,19 @@ export async function webpack(webpackConfig = {}, options) {
     skipCsf: true,
     remarkPlugins: [remarkSlug, remarkExternalLinks]
   };
-  logger.info(`Addon-docs: using MDX2`);
 
-  const mdxLoader = require.resolve('@storybook/mdx2-csf/loader'); // set `sourceLoaderOptions` to `null` to disable for manual configuration
+  if (sourceLoaderOptions) {
+    throw new Error(dedent`
+      Addon-docs no longer uses source-loader in 7.0.
 
+      To update your configuration, please see migration instructions here:
+
+      https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-source-loader--storiesof-static-snippets
+    `);
+  }
+
+  const mdxLoader = require.resolve('@storybook/mdx2-csf/loader');
 
-  const sourceLoader = sourceLoaderOptions ? [{
-    test: /\.(stories|story)\.[tj]sx?$/,
-    loader: require.resolve('@storybook/source-loader'),
-    options: Object.assign({}, sourceLoaderOptions, {
-      inspectLocalDependencies: true
-    }),
-    enforce: 'pre'
-  }] : [];
   let rules = module.rules || [];
 
   if (transcludeMarkdown) {
@@ -89,6 +88,8 @@ export async function webpack(webpackConfig = {}, options) {
   }
 
   const result = Object.assign({}, webpackConfig, {
+    plugins: [...(webpackConfig.plugins || []), // eslint-disable-next-line global-require
+    ...(csfPluginOptions ? [require('@storybook/csf-plugin').webpack(csfPluginOptions)] : [])],
     module: Object.assign({}, module, {
       rules: [...rules, {
         test: /(stories|story)\.mdx$/,
@@ -119,7 +120,7 @@ export async function webpack(webpackConfig = {}, options) {
           loader: mdxLoader,
           options: mdxLoaderOptions
         }]
-      }, ...sourceLoader]
+      }]
     })
   });
   return result;

package/dist/types/preset.d.ts

@@ -1,11 +1,14 @@
 import type { CoreCommon_StoryIndexer, DocsOptions, Options } from '@storybook/types';
+import type { CsfPluginOptions } from '@storybook/csf-plugin';
 declare type BabelParams = {
     babelOptions?: any;
     mdxBabelOptions?: any;
     configureJSX?: boolean;
 };
 export declare function webpack(webpackConfig: any, options: Options & BabelParams & {
+    /** @deprecated */
     sourceLoaderOptions: any;
+    csfPluginOptions: CsfPluginOptions | null;
     transcludeMarkdown: boolean;
 }): Promise<any>;
 export declare const storyIndexers: (indexers: CoreCommon_StoryIndexer[] | null) => Promise<CoreCommon_StoryIndexer[]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/addon-docs",
-  "version": "7.0.0-alpha.45",
+  "version": "7.0.0-alpha.47",
   "description": "Document component usage and properties in Markdown",
   "keywords": [
     "addon",
@@ -52,22 +52,22 @@
     "@babel/plugin-transform-react-jsx": "^7.12.12",
     "@jest/transform": "^26.6.2",
     "@mdx-js/react": "^2.1.5",
-    "@storybook/addons": "7.0.0-alpha.45",
-    "@storybook/api": "7.0.0-alpha.45",
-    "@storybook/blocks": "7.0.0-alpha.45",
-    "@storybook/components": "7.0.0-alpha.45",
-    "@storybook/core-common": "7.0.0-alpha.45",
-    "@storybook/core-events": "7.0.0-alpha.45",
-    "@storybook/csf-tools": "7.0.0-alpha.45",
-    "@storybook/docs-tools": "7.0.0-alpha.45",
-    "@storybook/mdx2-csf": "0.1.0-next.0",
-    "@storybook/node-logger": "7.0.0-alpha.45",
-    "@storybook/postinstall": "7.0.0-alpha.45",
-    "@storybook/preview-web": "7.0.0-alpha.45",
-    "@storybook/source-loader": "7.0.0-alpha.45",
-    "@storybook/store": "7.0.0-alpha.45",
-    "@storybook/theming": "7.0.0-alpha.45",
-    "@storybook/types": "7.0.0-alpha.45",
+    "@storybook/addons": "7.0.0-alpha.47",
+    "@storybook/api": "7.0.0-alpha.47",
+    "@storybook/blocks": "7.0.0-alpha.47",
+    "@storybook/components": "7.0.0-alpha.47",
+    "@storybook/core-common": "7.0.0-alpha.47",
+    "@storybook/core-events": "7.0.0-alpha.47",
+    "@storybook/csf-plugin": "7.0.0-alpha.47",
+    "@storybook/csf-tools": "7.0.0-alpha.47",
+    "@storybook/docs-tools": "7.0.0-alpha.47",
+    "@storybook/mdx2-csf": "next",
+    "@storybook/node-logger": "7.0.0-alpha.47",
+    "@storybook/postinstall": "7.0.0-alpha.47",
+    "@storybook/preview-web": "7.0.0-alpha.47",
+    "@storybook/store": "7.0.0-alpha.47",
+    "@storybook/theming": "7.0.0-alpha.47",
+    "@storybook/types": "7.0.0-alpha.47",
     "dequal": "^2.0.2",
     "fs-extra": "^9.0.1",
     "global": "^4.4.0",
@@ -94,7 +94,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3ef14366115c56c1d45c0359ff681cc47ed50532",
+  "gitHead": "1c706a4a778831e012343c905f86225fa71491a7",
   "storybook": {
     "displayName": "Docs",
     "icon": "https://user-images.githubusercontent.com/263385/101991672-48355c80-3c7c-11eb-82d9-95fa12438f64.png",

package/mdx-compiler-plugin.js

@@ -1 +0,0 @@
-module.exports = require('@storybook/mdx1-csf').createCompiler;