@storybook/addon-docs 7.0.0-beta.7 → 7.0.0-beta.9
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 +2 -3
- package/dist/blocks.js +1 -1
- package/dist/index.js +1 -1
- package/dist/preset.js +8 -2
- package/dist/preset.mjs +8 -2
- package/dist/preview.js +1 -1
- package/dist/shims/mdx-react-shim.js +1 -1
- package/package.json +11 -11
- package/postinstall/presets.js +1 -3
package/README.md
CHANGED
|
@@ -140,8 +140,7 @@ module.exports = {
|
|
|
140
140
|
{
|
|
141
141
|
name: '@storybook/addon-docs',
|
|
142
142
|
options: {
|
|
143
|
-
|
|
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
|
-
|
|
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/blocks.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var
|
|
1
|
+
var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty;var __copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to},__reExport=(target,mod,secondTarget)=>(__copyProps(target,mod,"default"),secondTarget&&__copyProps(secondTarget,mod,"default")),__toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var blocks_exports={};module.exports=__toCommonJS(blocks_exports);var import_global=__toESM(require("global"),1),{LOGLEVEL,console}=import_global.default,levels={trace:1,debug:2,info:3,warn:4,error:5,silent:10},currentLogLevelString=LOGLEVEL,currentLogLevelNumber=levels[currentLogLevelString]||levels.info,logger={trace:(message,...rest)=>currentLogLevelNumber<=levels.trace&&console.trace(message,...rest),debug:(message,...rest)=>currentLogLevelNumber<=levels.debug&&console.debug(message,...rest),info:(message,...rest)=>currentLogLevelNumber<=levels.info&&console.info(message,...rest),warn:(message,...rest)=>currentLogLevelNumber<=levels.warn&&console.warn(message,...rest),error:(message,...rest)=>currentLogLevelNumber<=levels.error&&console.error(message,...rest),log:(message,...rest)=>currentLogLevelNumber<levels.silent&&console.log(message,...rest)},logged=new Set,once=type=>(message,...rest)=>{if(!logged.has(message))return logged.add(message),logger[type](message,...rest)};once.clear=()=>logged.clear();once.trace=once("trace");once.debug=once("debug");once.info=once("info");once.warn=once("warn");once.error=once("error");once.log=once("log");var deprecate=once("warn"),pretty=type=>(...args)=>{let argArray=[];if(args.length){let startTagRe=/<span\s+style=(['"])([^'"]*)\1\s*>/gi,endTagRe=/<\/span>/gi,reResultArray;for(argArray.push(args[0].replace(startTagRe,"%c").replace(endTagRe,"%c"));reResultArray=startTagRe.exec(args[0]);)argArray.push(reResultArray[2]),argArray.push("");for(let j=1;j<args.length;j++)argArray.push(args[j])}logger[type].apply(logger,argArray)};pretty.trace=pretty("trace");pretty.debug=pretty("debug");pretty.info=pretty("info");pretty.warn=pretty("warn");pretty.error=pretty("error");__reExport(blocks_exports,require("@storybook/blocks"),module.exports);deprecate("Import from '@storybook/addon-docs/blocks' is deprecated. Please import from '@storybook/blocks' instead.");
|
package/dist/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var
|
|
1
|
+
var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty;var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0})},__copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to},__reExport=(target,mod,secondTarget)=>(__copyProps(target,mod,"default"),secondTarget&&__copyProps(secondTarget,mod,"default")),__toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var src_exports={};__export(src_exports,{DocsRenderer:()=>DocsRenderer});module.exports=__toCommonJS(src_exports);__reExport(src_exports,require("@storybook/blocks"),module.exports);var import_react=__toESM(require("react")),import_react_dom=__toESM(require("react-dom")),import_blocks=require("@storybook/blocks"),defaultComponents={code:import_blocks.CodeOrSourceMdx,a:import_blocks.AnchorMdx,...import_blocks.HeadersMdx},DocsRenderer=class{constructor(){this.render=(context,docsParameter,element,callback)=>{let components={...defaultComponents,...docsParameter==null?void 0:docsParameter.components};import("@mdx-js/react").then(({MDXProvider})=>{import_react_dom.default.render(import_react.default.createElement(MDXProvider,{components},import_react.default.createElement(import_blocks.Docs,{key:Math.random(),context,docsParameter})),element,callback)})},this.unmount=element=>{import_react_dom.default.unmountComponentAtNode(element)}}};0&&(module.exports={DocsRenderer});
|
package/dist/preset.js
CHANGED
|
@@ -1,7 +1,13 @@
|
|
|
1
|
-
var
|
|
1
|
+
var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty;var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0})},__copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to};var __toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var preset_exports={};__export(preset_exports,{docs:()=>docsX,storyIndexers:()=>storyIndexersX,webpack:()=>webpackX});module.exports=__toCommonJS(preset_exports);var import_fs_extra=__toESM(require("fs-extra")),import_remark_slug=__toESM(require("remark-slug")),import_remark_external_links=__toESM(require("remark-external-links")),import_ts_dedent=require("ts-dedent"),import_csf_tools=require("@storybook/csf-tools");async function webpack(webpackConfig={},options){let{module:module2={}}=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:[import_remark_slug.default,import_remark_external_links.default]},jsxOptions});if(sourceLoaderOptions)throw new Error(import_ts_dedent.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
|
-
`);
|
|
7
|
+
`);if(mdxBabelOptions||configureJsx)throw new Error(import_ts_dedent.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=module2.rules||[];return transcludeMarkdown&&(rules=[...rules.filter(rule=>{var _a;return((_a=rule.test)==null?void 0:_a.toString())!=="/\\.md$/"}),{test:/\.md$/,use:[{loader:mdxLoader,options:mdxLoaderOptions}]}]),{...webpackConfig,plugins:[...webpackConfig.plugins||[],...csfPluginOptions?[require("@storybook/csf-plugin").webpack(csfPluginOptions)]:[]],module:{...module2,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 import_fs_extra.default.readFile(fileName,"utf-8")).toString(),{compile}=await import("@storybook/mdx2-csf");return code=await compile(code,{}),(0,import_csf_tools.loadCsf)(code,{...opts,fileName}).parse()}},...indexers||[]],docs=docsOptions=>({...docsOptions,enabled:!0,defaultName:"Docs",docsPage:!0}),webpackX=webpack,storyIndexersX=storyIndexers,docsX=docs;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,{
|
|
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
|
-
`);
|
|
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/dist/preview.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var
|
|
1
|
+
var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty;var __esm=(fn,res)=>function(){return fn&&(res=(0,fn[__getOwnPropNames(fn)[0]])(fn=0)),res};var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0})},__copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to};var __toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var DocsRenderer_exports={};__export(DocsRenderer_exports,{DocsRenderer:()=>DocsRenderer,defaultComponents:()=>defaultComponents});var import_react,import_react_dom,import_blocks,defaultComponents,DocsRenderer,init_DocsRenderer=__esm({"src/DocsRenderer.tsx"(){import_react=__toESM(require("react")),import_react_dom=__toESM(require("react-dom")),import_blocks=require("@storybook/blocks"),defaultComponents={code:import_blocks.CodeOrSourceMdx,a:import_blocks.AnchorMdx,...import_blocks.HeadersMdx},DocsRenderer=class{constructor(){this.render=(context,docsParameter,element,callback)=>{let components={...defaultComponents,...docsParameter==null?void 0:docsParameter.components};import("@mdx-js/react").then(({MDXProvider})=>{import_react_dom.default.render(import_react.default.createElement(MDXProvider,{components},import_react.default.createElement(import_blocks.Docs,{key:Math.random(),context,docsParameter})),element,callback)})},this.unmount=element=>{import_react_dom.default.unmountComponentAtNode(element)}}}}});var preview_exports={};__export(preview_exports,{parameters:()=>parameters});module.exports=__toCommonJS(preview_exports);var parameters={docs:{renderer:async()=>{let{DocsRenderer:DocsRenderer2}=await Promise.resolve().then(()=>(init_DocsRenderer(),DocsRenderer_exports));return new DocsRenderer2}}};0&&(module.exports={parameters});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
var
|
|
1
|
+
var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __hasOwnProp=Object.prototype.hasOwnProperty;var __copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to},__reExport=(target,mod,secondTarget)=>(__copyProps(target,mod,"default"),secondTarget&&__copyProps(secondTarget,mod,"default"));var __toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var mdx_react_shim_exports={};module.exports=__toCommonJS(mdx_react_shim_exports);__reExport(mdx_react_shim_exports,require("@mdx-js/react"),module.exports);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@storybook/addon-docs",
|
|
3
|
-
"version": "7.0.0-beta.
|
|
3
|
+
"version": "7.0.0-beta.9",
|
|
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.
|
|
108
|
-
"@storybook/components": "7.0.0-beta.
|
|
109
|
-
"@storybook/csf-plugin": "7.0.0-beta.
|
|
110
|
-
"@storybook/csf-tools": "7.0.0-beta.
|
|
107
|
+
"@storybook/blocks": "7.0.0-beta.9",
|
|
108
|
+
"@storybook/components": "7.0.0-beta.9",
|
|
109
|
+
"@storybook/csf-plugin": "7.0.0-beta.9",
|
|
110
|
+
"@storybook/csf-tools": "7.0.0-beta.9",
|
|
111
111
|
"@storybook/mdx2-csf": "next",
|
|
112
|
-
"@storybook/node-logger": "7.0.0-beta.
|
|
113
|
-
"@storybook/postinstall": "7.0.0-beta.
|
|
114
|
-
"@storybook/preview-api": "7.0.0-beta.
|
|
115
|
-
"@storybook/theming": "7.0.0-beta.
|
|
116
|
-
"@storybook/types": "7.0.0-beta.
|
|
112
|
+
"@storybook/node-logger": "7.0.0-beta.9",
|
|
113
|
+
"@storybook/postinstall": "7.0.0-beta.9",
|
|
114
|
+
"@storybook/preview-api": "7.0.0-beta.9",
|
|
115
|
+
"@storybook/theming": "7.0.0-beta.9",
|
|
116
|
+
"@storybook/types": "7.0.0-beta.9",
|
|
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": "
|
|
144
|
+
"gitHead": "c466d4f77c3e8b99f28aaf508acdb9fd863550fd",
|
|
145
145
|
"storybook": {
|
|
146
146
|
"displayName": "Docs",
|
|
147
147
|
"icon": "https://user-images.githubusercontent.com/263385/101991672-48355c80-3c7c-11eb-82d9-95fa12438f64.png",
|
package/postinstall/presets.js
CHANGED
|
@@ -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;
|