@storybook/addon-docs 7.0.0-beta.7 → 7.0.0-beta.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -140,8 +140,7 @@ module.exports = {
140
140
  {
141
141
  name: '@storybook/addon-docs',
142
142
  options: {
143
- configureJSX: true,
144
- babelOptions: {},
143
+ jsxOptions: {},
145
144
  csfPluginOptions: null,
146
145
  transcludeMarkdown: true,
147
146
  },
@@ -150,7 +149,7 @@ module.exports = {
150
149
  };
151
150
  ```
152
151
 
153
- 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`.
152
+ `jsxOptions` are options that will be passed to `@babel/preset-react` for `.md` and `.mdx` files.
154
153
 
155
154
  `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`.
156
155
 
package/dist/preset.js CHANGED
@@ -1,7 +1,13 @@
1
- var k=Object.create;var a=Object.defineProperty;var I=Object.getOwnPropertyDescriptor;var w=Object.getOwnPropertyNames;var P=Object.getPrototypeOf,S=Object.prototype.hasOwnProperty;var L=(o,s)=>{for(var e in s)a(o,e,{get:s[e],enumerable:!0})},c=(o,s,e,t)=>{if(s&&typeof s=="object"||typeof s=="function")for(let r of w(s))!S.call(o,r)&&r!==e&&a(o,r,{get:()=>s[r],enumerable:!(t=I(s,r))||t.enumerable});return o};var n=(o,s,e)=>(e=o!=null?k(P(o)):{},c(s||!o||!o.__esModule?a(e,"default",{value:o,enumerable:!0}):e,o)),$=o=>c(a({},"__esModule",{value:!0}),o);var q={};L(q,{docs:()=>M,storyIndexers:()=>D,webpack:()=>X});module.exports=$(q);var m=n(require("fs-extra")),y=n(require("remark-slug")),x=n(require("remark-external-links")),f=require("ts-dedent"),O=require("@storybook/csf-tools");async function h(o={},s){let{module:e={}}=o,{mdxBabelOptions:t,csfPluginOptions:r={},sourceLoaderOptions:i=null,transcludeMarkdown:b=!1}=s,d=await s.presets.apply("mdxLoaderOptions",{skipCsf:!0,mdxCompileOptions:{providerImportSource:"@storybook/addon-docs/mdx-react-shim",remarkPlugins:[y.default,x.default]}});if(i)throw new Error(f.dedent`
1
+ var w=Object.create;var i=Object.defineProperty;var h=Object.getOwnPropertyDescriptor;var S=Object.getOwnPropertyNames;var L=Object.getPrototypeOf,P=Object.prototype.hasOwnProperty;var $=(o,s)=>{for(var e in s)i(o,e,{get:s[e],enumerable:!0})},m=(o,s,e,r)=>{if(s&&typeof s=="object"||typeof s=="function")for(let t of S(s))!P.call(o,t)&&t!==e&&i(o,t,{get:()=>s[t],enumerable:!(r=h(s,t))||r.enumerable});return o};var n=(o,s,e)=>(e=o!=null?w(L(o)):{},m(s||!o||!o.__esModule?i(e,"default",{value:o,enumerable:!0}):e,o)),J=o=>m(i({},"__esModule",{value:!0}),o);var B={};$(B,{docs:()=>T,storyIndexers:()=>M,webpack:()=>C});module.exports=J(B);var x=n(require("fs-extra")),y=n(require("remark-slug")),f=n(require("remark-external-links")),l=require("ts-dedent"),b=require("@storybook/csf-tools");async function X(o={},s){let{module:e={}}=o,{csfPluginOptions:r={},jsxOptions:t={},transcludeMarkdown:d=!1,sourceLoaderOptions:O=null,configureJsx:g,mdxBabelOptions:k}=s,a=await s.presets.apply("mdxLoaderOptions",{skipCsf:!0,mdxCompileOptions:{providerImportSource:"@storybook/addon-docs/mdx-react-shim",remarkPlugins:[y.default,f.default]},jsxOptions:t});if(O)throw new Error(l.dedent`
2
2
  Addon-docs no longer uses source-loader in 7.0.
3
3
 
4
4
  To update your configuration, please see migration instructions here:
5
5
 
6
6
  https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-source-loader--storiesof-static-snippets
7
- `);let p=require.resolve("@storybook/mdx2-csf/loader"),l=e.rules||[];return b&&(l=[...l.filter(g=>{var u;return((u=g.test)==null?void 0:u.toString())!=="/\\.md$/"}),{test:/\.md$/,use:[{loader:p,options:d}]}]),{...o,plugins:[...o.plugins||[],...r?[require("@storybook/csf-plugin").webpack(r)]:[]],module:{...e,rules:[...l,{test:/(stories|story)\.mdx$/,use:[{loader:p,options:{...d,mdxBabelOptions:t,skipCsf:!1}}]},{test:/\.mdx$/,exclude:/(stories|story)\.mdx$/,use:[{loader:p,options:d}]}]}}}var B=o=>[{test:/(stories|story)\.mdx$/,indexer:async(e,t)=>{let r=(await m.default.readFile(e,"utf-8")).toString(),{compile:i}=await import("@storybook/mdx2-csf");return r=await i(r,{}),(0,O.loadCsf)(r,{...t,fileName:e}).parse()}},...o||[]],C=o=>({...o,enabled:!0,defaultName:"Docs",docsPage:!0}),X=h,D=B,M=C;0&&(module.exports={docs,storyIndexers,webpack});
7
+ `);if(k||g)throw new Error(l.dedent`
8
+ Addon-docs no longer uses configureJsx or mdxBabelOptions in 7.0.
9
+
10
+ To update your configuration, please see migration instructions here:
11
+
12
+ https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-addon-docs-manual-babel-configuration
13
+ `);let p=require.resolve("@storybook/mdx2-csf/loader"),u=e.rules||[];return d&&(u=[...u.filter(I=>{var c;return((c=I.test)==null?void 0:c.toString())!=="/\\.md$/"}),{test:/\.md$/,use:[{loader:p,options:a}]}]),{...o,plugins:[...o.plugins||[],...r?[require("@storybook/csf-plugin").webpack(r)]:[]],module:{...e,rules:[...u,{test:/(stories|story)\.mdx$/,use:[{loader:p,options:{...a,skipCsf:!1}}]},{test:/\.mdx$/,exclude:/(stories|story)\.mdx$/,use:[{loader:p,options:a}]}]}}}var j=o=>[{test:/(stories|story)\.mdx$/,indexer:async(e,r)=>{let t=(await x.default.readFile(e,"utf-8")).toString(),{compile:d}=await import("@storybook/mdx2-csf");return t=await d(t,{}),(0,b.loadCsf)(t,{...r,fileName:e}).parse()}},...o||[]],A=o=>({...o,enabled:!0,defaultName:"Docs",docsPage:!0}),C=X,M=j,T=A;0&&(module.exports={docs,storyIndexers,webpack});
package/dist/preset.mjs CHANGED
@@ -1,7 +1,13 @@
1
- import{__require}from"./chunk-R4NKYYJA.mjs";import fs from"fs-extra";import remarkSlug from"remark-slug";import remarkExternalLinks from"remark-external-links";import{dedent}from"ts-dedent";import{loadCsf}from"@storybook/csf-tools";async function webpack(webpackConfig={},options){let{module={}}=webpackConfig,{mdxBabelOptions,csfPluginOptions={},sourceLoaderOptions=null,transcludeMarkdown=!1}=options,mdxLoaderOptions=await options.presets.apply("mdxLoaderOptions",{skipCsf:!0,mdxCompileOptions:{providerImportSource:"@storybook/addon-docs/mdx-react-shim",remarkPlugins:[remarkSlug,remarkExternalLinks]}});if(sourceLoaderOptions)throw new Error(dedent`
1
+ import{__require}from"./chunk-R4NKYYJA.mjs";import fs from"fs-extra";import remarkSlug from"remark-slug";import remarkExternalLinks from"remark-external-links";import{dedent}from"ts-dedent";import{loadCsf}from"@storybook/csf-tools";async function webpack(webpackConfig={},options){let{module={}}=webpackConfig,{csfPluginOptions={},jsxOptions={},transcludeMarkdown=!1,sourceLoaderOptions=null,configureJsx,mdxBabelOptions}=options,mdxLoaderOptions=await options.presets.apply("mdxLoaderOptions",{skipCsf:!0,mdxCompileOptions:{providerImportSource:"@storybook/addon-docs/mdx-react-shim",remarkPlugins:[remarkSlug,remarkExternalLinks]},jsxOptions});if(sourceLoaderOptions)throw new Error(dedent`
2
2
  Addon-docs no longer uses source-loader in 7.0.
3
3
 
4
4
  To update your configuration, please see migration instructions here:
5
5
 
6
6
  https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-source-loader--storiesof-static-snippets
7
- `);let mdxLoader=__require.resolve("@storybook/mdx2-csf/loader"),rules=module.rules||[];return transcludeMarkdown&&(rules=[...rules.filter(rule=>rule.test?.toString()!=="/\\.md$/"),{test:/\.md$/,use:[{loader:mdxLoader,options:mdxLoaderOptions}]}]),{...webpackConfig,plugins:[...webpackConfig.plugins||[],...csfPluginOptions?[__require("@storybook/csf-plugin").webpack(csfPluginOptions)]:[]],module:{...module,rules:[...rules,{test:/(stories|story)\.mdx$/,use:[{loader:mdxLoader,options:{...mdxLoaderOptions,mdxBabelOptions,skipCsf:!1}}]},{test:/\.mdx$/,exclude:/(stories|story)\.mdx$/,use:[{loader:mdxLoader,options:mdxLoaderOptions}]}]}}}var storyIndexers=indexers=>[{test:/(stories|story)\.mdx$/,indexer:async(fileName,opts)=>{let code=(await fs.readFile(fileName,"utf-8")).toString(),{compile}=await import("@storybook/mdx2-csf");return code=await compile(code,{}),loadCsf(code,{...opts,fileName}).parse()}},...indexers||[]],docs=docsOptions=>({...docsOptions,enabled:!0,defaultName:"Docs",docsPage:!0}),webpackX=webpack,storyIndexersX=storyIndexers,docsX=docs;export{docsX as docs,storyIndexersX as storyIndexers,webpackX as webpack};
7
+ `);if(mdxBabelOptions||configureJsx)throw new Error(dedent`
8
+ Addon-docs no longer uses configureJsx or mdxBabelOptions in 7.0.
9
+
10
+ To update your configuration, please see migration instructions here:
11
+
12
+ https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-addon-docs-manual-babel-configuration
13
+ `);let mdxLoader=__require.resolve("@storybook/mdx2-csf/loader"),rules=module.rules||[];return transcludeMarkdown&&(rules=[...rules.filter(rule=>rule.test?.toString()!=="/\\.md$/"),{test:/\.md$/,use:[{loader:mdxLoader,options:mdxLoaderOptions}]}]),{...webpackConfig,plugins:[...webpackConfig.plugins||[],...csfPluginOptions?[__require("@storybook/csf-plugin").webpack(csfPluginOptions)]:[]],module:{...module,rules:[...rules,{test:/(stories|story)\.mdx$/,use:[{loader:mdxLoader,options:{...mdxLoaderOptions,skipCsf:!1}}]},{test:/\.mdx$/,exclude:/(stories|story)\.mdx$/,use:[{loader:mdxLoader,options:mdxLoaderOptions}]}]}}}var storyIndexers=indexers=>[{test:/(stories|story)\.mdx$/,indexer:async(fileName,opts)=>{let code=(await fs.readFile(fileName,"utf-8")).toString(),{compile}=await import("@storybook/mdx2-csf");return code=await compile(code,{}),loadCsf(code,{...opts,fileName}).parse()}},...indexers||[]],docs=docsOptions=>({...docsOptions,enabled:!0,defaultName:"Docs",docsPage:!0}),webpackX=webpack,storyIndexersX=storyIndexers,docsX=docs;export{docsX as docs,storyIndexersX as storyIndexers,webpackX as webpack};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@storybook/addon-docs",
3
- "version": "7.0.0-beta.7",
3
+ "version": "7.0.0-beta.8",
4
4
  "description": "Document component usage and properties in Markdown",
5
5
  "keywords": [
6
6
  "addon",
@@ -104,16 +104,16 @@
104
104
  "@babel/plugin-transform-react-jsx": "^7.19.0",
105
105
  "@jest/transform": "^29.3.1",
106
106
  "@mdx-js/react": "^2.1.5",
107
- "@storybook/blocks": "7.0.0-beta.7",
108
- "@storybook/components": "7.0.0-beta.7",
109
- "@storybook/csf-plugin": "7.0.0-beta.7",
110
- "@storybook/csf-tools": "7.0.0-beta.7",
107
+ "@storybook/blocks": "7.0.0-beta.8",
108
+ "@storybook/components": "7.0.0-beta.8",
109
+ "@storybook/csf-plugin": "7.0.0-beta.8",
110
+ "@storybook/csf-tools": "7.0.0-beta.8",
111
111
  "@storybook/mdx2-csf": "next",
112
- "@storybook/node-logger": "7.0.0-beta.7",
113
- "@storybook/postinstall": "7.0.0-beta.7",
114
- "@storybook/preview-api": "7.0.0-beta.7",
115
- "@storybook/theming": "7.0.0-beta.7",
116
- "@storybook/types": "7.0.0-beta.7",
112
+ "@storybook/node-logger": "7.0.0-beta.8",
113
+ "@storybook/postinstall": "7.0.0-beta.8",
114
+ "@storybook/preview-api": "7.0.0-beta.8",
115
+ "@storybook/theming": "7.0.0-beta.8",
116
+ "@storybook/types": "7.0.0-beta.8",
117
117
  "fs-extra": "^9.0.1",
118
118
  "global": "^4.4.0",
119
119
  "remark-external-links": "^8.0.0",
@@ -141,7 +141,7 @@
141
141
  "./src/shims/mdx-react-shim.ts"
142
142
  ]
143
143
  },
144
- "gitHead": "e16a8c685e22121683ac00b1bc53dbf5aa587f88",
144
+ "gitHead": "5340574d89a799ec10959edc16ca140852cf355c",
145
145
  "storybook": {
146
146
  "displayName": "Docs",
147
147
  "icon": "https://user-images.githubusercontent.com/263385/101991672-48355c80-3c7c-11eb-82d9-95fa12438f64.png",
@@ -24,9 +24,7 @@ export default function transformer(file, api) {
24
24
  ((dependencies && dependencies['react-scripts']) ||
25
25
  (devDependencies && devDependencies['react-scripts']))
26
26
  ) {
27
- presetOptions = {
28
- configureJSX: true,
29
- };
27
+ presetOptions = {};
30
28
  }
31
29
 
32
30
  const j = api.jscodeshift;