@storybook/cli 7.1.0-alpha.19 → 7.1.0-alpha.20
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/dist/chunk-PCH7PW5F.mjs +48 -0
- package/dist/generate.js +85 -76
- package/dist/generate.mjs +46 -45
- package/dist/index.d.ts +44 -1
- package/dist/index.js +13 -4
- package/dist/index.mjs +1 -1
- package/package.json +11 -10
- package/dist/chunk-OZ5KSS27.mjs +0 -38
package/dist/generate.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { versions_default, parseList, getEnvConfig, JsPackageManagerFactory, useNpmWarning, getStorybookVersionSpecifier, commandLog, installableProjectTypes, paddedLog, HandledError, codeLog, __require, getBowerJson, isNxProject, getPackageDetails, supportedTemplates, unsupportedTemplate, getCliDir, copyTemplate, getBabelDependencies, copyTemplateFiles, externalFrameworks } from './chunk-
|
|
1
|
+
import { versions_default, parseList, getEnvConfig, JsPackageManagerFactory, useNpmWarning, getStorybookVersionSpecifier, commandLog, installableProjectTypes, paddedLog, HandledError, codeLog, __require, getBowerJson, isNxProject, getPackageDetails, supportedTemplates, unsupportedTemplate, getCliDir, copyTemplate, getBabelDependencies, copyTemplateFiles, externalFrameworks } from './chunk-PCH7PW5F.mjs';
|
|
2
2
|
import program from 'commander';
|
|
3
3
|
import path9, { join, resolve, basename } from 'path';
|
|
4
4
|
import chalk13 from 'chalk';
|
|
@@ -15,6 +15,7 @@ import findUp from 'find-up';
|
|
|
15
15
|
import semver from 'semver';
|
|
16
16
|
import * as fse from 'fs-extra';
|
|
17
17
|
import fse__default, { pathExists, move, remove, writeFile, existsSync, readdir, createWriteStream, stat, pathExistsSync, readFile, readJson, writeJson } from 'fs-extra';
|
|
18
|
+
import ora from 'ora';
|
|
18
19
|
import detectIndent from 'detect-indent';
|
|
19
20
|
import { readConfig, writeConfig } from '@storybook/csf-tools';
|
|
20
21
|
import { sync as sync$1 } from 'cross-spawn';
|
|
@@ -58,14 +59,14 @@ var viteConfigFiles=["vite.config.ts","vite.config.js","vite.config.mjs"],webpac
|
|
|
58
59
|
We have detected that you're using ESLint. Storybook provides a plugin that gives the best experience with Storybook and helps follow best practices: ${chalk13.yellow("https://github.com/storybookjs/eslint-plugin-storybook#readme")}
|
|
59
60
|
|
|
60
61
|
Would you like to install it?
|
|
61
|
-
`,initial:!0});return shouldInstall};var defaultOptions={extraPackages:[],extraAddons:[],staticDir:void 0,addScripts:!0,addMainFile:!0,addComponents:!0,skipBabel:!1,extraMain:void 0,framework:void 0,extensions:void 0,componentsDestinationPath:void 0,storybookConfigFolder:".storybook"},getBuilderDetails=builder=>{let map=versions_default;if(map[builder])return builder;let builderPackage=`@storybook/${builder}`;return map[builderPackage]?builderPackage:builder},getExternalFramework=framework=>externalFrameworks.find(exFramework=>framework!==void 0&&(exFramework.name===framework||exFramework.packageName===framework||exFramework?.frameworks?.some?.(item=>item===framework))),getFrameworkPackage=(framework,renderer,builder)=>{let externalFramework=getExternalFramework(framework),storybookBuilder=builder?.replace(/^@storybook\/builder-/,""),storybookFramework=framework?.replace(/^@storybook\//,"");if(externalFramework===void 0){let frameworkPackage=framework?`@storybook/${storybookFramework}`:`@storybook/${renderer}-${storybookBuilder}`;if(versions_default[frameworkPackage])return frameworkPackage;throw new Error(dedent`
|
|
62
|
+
`,initial:!0});return shouldInstall};var logger4=console,defaultOptions={extraPackages:[],extraAddons:[],staticDir:void 0,addScripts:!0,addMainFile:!0,addComponents:!0,skipBabel:!1,extraMain:void 0,framework:void 0,extensions:void 0,componentsDestinationPath:void 0,storybookConfigFolder:".storybook"},getBuilderDetails=builder=>{let map=versions_default;if(map[builder])return builder;let builderPackage=`@storybook/${builder}`;return map[builderPackage]?builderPackage:builder},getExternalFramework=framework=>externalFrameworks.find(exFramework=>framework!==void 0&&(exFramework.name===framework||exFramework.packageName===framework||exFramework?.frameworks?.some?.(item=>item===framework))),getFrameworkPackage=(framework,renderer,builder)=>{let externalFramework=getExternalFramework(framework),storybookBuilder=builder?.replace(/^@storybook\/builder-/,""),storybookFramework=framework?.replace(/^@storybook\//,"");if(externalFramework===void 0){let frameworkPackage=framework?`@storybook/${storybookFramework}`:`@storybook/${renderer}-${storybookBuilder}`;if(versions_default[frameworkPackage])return frameworkPackage;throw new Error(dedent`
|
|
62
63
|
Could not find framework package: ${frameworkPackage}.
|
|
63
64
|
Make sure this package exists, and if it does, please file an issue as this might be a bug in Storybook.
|
|
64
|
-
`)}return externalFramework.frameworks!==void 0?externalFramework.frameworks.find(item=>item.match(new RegExp(`-${storybookBuilder}`))):externalFramework.packageName},getRendererPackage=(framework,renderer)=>{let externalFramework=getExternalFramework(framework);return externalFramework!==void 0?externalFramework.renderer||externalFramework.packageName:`@storybook/${renderer}`},wrapForPnp=packageName=>`%%path.dirname(require.resolve(path.join('${packageName}', 'package.json')))%%`,getFrameworkDetails=(renderer,builder,pnp,framework)=>{let frameworkPackage=getFrameworkPackage(framework,renderer,builder),frameworkPackagePath=pnp?wrapForPnp(frameworkPackage):frameworkPackage,rendererPackage=getRendererPackage(framework,renderer),rendererPackagePath=pnp?wrapForPnp(rendererPackage):rendererPackage,builderPackage=getBuilderDetails(builder),builderPackagePath=pnp?wrapForPnp(builderPackage):builderPackage,isKnownFramework=!!getExternalFramework(frameworkPackage)||!!versions_default[frameworkPackage],isKnownRenderer=!!versions_default[rendererPackage];if(isKnownFramework)return {packages:[rendererPackage,frameworkPackage],framework:frameworkPackagePath,rendererId:renderer,type:"framework"};if(isKnownRenderer)return {packages:[rendererPackage,builderPackage],builder:builderPackagePath,renderer:rendererPackagePath,rendererId:renderer,type:"renderer"};throw new Error(`Could not find the framework (${frameworkPackage}) or renderer (${rendererPackage}) package`)},stripVersions=addons=>addons.map(addon=>getPackageDetails(addon)[0]),hasInteractiveStories=rendererId=>["react","angular","preact","svelte","vue","vue3","html","solid","qwik"].includes(rendererId),hasFrameworkTemplates=framework=>["angular","nextjs"].includes(framework);async function baseGenerator(packageManager,npmOptions,{language,builder="webpack5",pnp,frameworkPreviewParts},renderer,options=defaultOptions,framework){let{extraAddons:extraAddonPackages,extraPackages,staticDir,addScripts,addMainFile,addComponents,skipBabel,extraMain,extensions,storybookConfigFolder,componentsDestinationPath}={...defaultOptions,...options},{packages:frameworkPackages4,type,rendererId,framework:frameworkInclude,builder:builderInclude}=getFrameworkDetails(renderer,builder,pnp,framework),addons=["@storybook/addon-links","@storybook/addon-essentials",...stripVersions(extraAddonPackages)],addonPackages=["@storybook/addon-links","@storybook/addon-essentials","@storybook/blocks",...extraAddonPackages];hasInteractiveStories(rendererId)&&(addons.push("@storybook/addon-interactions"),addonPackages.push("@storybook/addon-interactions","@storybook/testing-library@^0.0.14-next.1"));let files=await fse__default.readdir(process.cwd()),packageJson=await packageManager.retrievePackageJson(),installedDependencies=new Set(Object.keys({...packageJson.dependencies,...packageJson.devDependencies}));if(installedDependencies.has("react")||addonPackages.push("react"),installedDependencies.has("react-dom")||addonPackages.push("react-dom"),type==="renderer")throw new Error(dedent`
|
|
65
|
+
`)}return externalFramework.frameworks!==void 0?externalFramework.frameworks.find(item=>item.match(new RegExp(`-${storybookBuilder}`))):externalFramework.packageName},getRendererPackage=(framework,renderer)=>{let externalFramework=getExternalFramework(framework);return externalFramework!==void 0?externalFramework.renderer||externalFramework.packageName:`@storybook/${renderer}`},wrapForPnp=packageName=>`%%path.dirname(require.resolve(path.join('${packageName}', 'package.json')))%%`,getFrameworkDetails=(renderer,builder,pnp,framework)=>{let frameworkPackage=getFrameworkPackage(framework,renderer,builder),frameworkPackagePath=pnp?wrapForPnp(frameworkPackage):frameworkPackage,rendererPackage=getRendererPackage(framework,renderer),rendererPackagePath=pnp?wrapForPnp(rendererPackage):rendererPackage,builderPackage=getBuilderDetails(builder),builderPackagePath=pnp?wrapForPnp(builderPackage):builderPackage,isKnownFramework=!!getExternalFramework(frameworkPackage)||!!versions_default[frameworkPackage],isKnownRenderer=!!versions_default[rendererPackage];if(isKnownFramework)return {packages:[rendererPackage,frameworkPackage],framework:frameworkPackagePath,rendererId:renderer,type:"framework"};if(isKnownRenderer)return {packages:[rendererPackage,builderPackage],builder:builderPackagePath,renderer:rendererPackagePath,rendererId:renderer,type:"renderer"};throw new Error(`Could not find the framework (${frameworkPackage}) or renderer (${rendererPackage}) package`)},stripVersions=addons=>addons.map(addon=>getPackageDetails(addon)[0]),hasInteractiveStories=rendererId=>["react","angular","preact","svelte","vue","vue3","html","solid","qwik"].includes(rendererId),hasFrameworkTemplates=framework=>["angular","nextjs"].includes(framework);async function baseGenerator(packageManager,npmOptions,{language,builder="webpack5",pnp,frameworkPreviewParts},renderer,options=defaultOptions,framework){let isNodeProcessExiting=!1,setNodeProcessExiting=()=>{isNodeProcessExiting=!0;};process.on("SIGINT",setNodeProcessExiting);let stopIfExiting=async callback=>{if(isNodeProcessExiting)throw new HandledError("Canceled by the user");try{return await callback()}catch(error){throw isNodeProcessExiting?new HandledError("Canceled by the user"):error}},{extraAddons:extraAddonPackages,extraPackages,staticDir,addScripts,addMainFile,addComponents,skipBabel,extraMain,extensions,storybookConfigFolder,componentsDestinationPath}={...defaultOptions,...options},{packages:frameworkPackages4,type,rendererId,framework:frameworkInclude,builder:builderInclude}=getFrameworkDetails(renderer,builder,pnp,framework),addons=["@storybook/addon-links","@storybook/addon-essentials",...stripVersions(extraAddonPackages)],addonPackages=["@storybook/addon-links","@storybook/addon-essentials","@storybook/blocks",...extraAddonPackages];hasInteractiveStories(rendererId)&&(addons.push("@storybook/addon-interactions"),addonPackages.push("@storybook/addon-interactions","@storybook/testing-library@^0.0.14-next.1"));let files=await fse__default.readdir(process.cwd()),packageJson=await packageManager.retrievePackageJson(),installedDependencies=new Set(Object.keys({...packageJson.dependencies,...packageJson.devDependencies}));if(installedDependencies.has("react")||addonPackages.push("react"),installedDependencies.has("react-dom")||addonPackages.push("react-dom"),type==="renderer")throw new Error(dedent`
|
|
65
66
|
Sorry, for now, you can not do this, please use a framework such as @storybook/react-webpack5
|
|
66
67
|
|
|
67
68
|
https://github.com/storybookjs/storybook/issues/18360
|
|
68
|
-
`);let packages=["storybook",getExternalFramework(rendererId)?void 0:`@storybook/${rendererId}`,...frameworkPackages4,...addonPackages,...extraPackages].filter(Boolean).filter(packageToInstall=>!installedDependencies.has(getPackageDetails(packageToInstall)[0])),versionedPackages=await packageManager.getVersionedPackages(packages);await fse__default.ensureDir(`./${storybookConfigFolder}`),addMainFile&&await configureMain({framework:{name:frameworkInclude,options:options.framework||{}},storybookConfigFolder,docs:{autodocs:"tag"},addons:pnp?addons.map(wrapForPnp):addons,extensions,language,...staticDir?{staticDirs:[path9.join("..",staticDir)]}:null,...extraMain,...type!=="framework"?{core:{builder:builderInclude}}:{}}),await configurePreview({frameworkPreviewParts,storybookConfigFolder,language,rendererId});let depsToInstall=[...versionedPackages];if(builder!=="vite"&&!skipBabel){let frameworksThatNeedBabelConfig2=["@storybook/react-webpack5","@storybook/vue-webpack5","@storybook/vue3-webpack5","@storybook/html-webpack5","@storybook/web-components-webpack5"],needsBabelConfig=frameworkPackages4.find(pkg2=>frameworksThatNeedBabelConfig2.includes(pkg2));if(!files.some(fname=>fname.startsWith(".babel")||fname.startsWith("babel"))&&needsBabelConfig){let isTypescript=language!=="javascript",isReact=rendererId==="react";depsToInstall.push(...getBabelPresets({typescript:isTypescript,jsx:isReact})),await writeBabelConfigFile({typescript:isTypescript,jsx:isReact});}}try{if(process.env.CI!=="true"){let{hasEslint,isStorybookPluginInstalled,eslintConfigFile}=await extractEslintInfo(packageManager);hasEslint&&!isStorybookPluginInstalled&&await suggestESLintPlugin()&&(depsToInstall.push("eslint-plugin-storybook"),await configureEslintPlugin(eslintConfigFile,packageManager));}}catch{}if(depsToInstall.length>0
|
|
69
|
+
`);let packages=["storybook",getExternalFramework(rendererId)?void 0:`@storybook/${rendererId}`,...frameworkPackages4,...addonPackages,...extraPackages].filter(Boolean).filter(packageToInstall=>!installedDependencies.has(getPackageDetails(packageToInstall)[0]));logger4.log();let versionedPackagesSpinner=ora({indent:2,text:`Getting the correct version of ${packages.length} packages`}).start(),versionedPackages=await stopIfExiting(async()=>packageManager.getVersionedPackages(packages));versionedPackagesSpinner.succeed(),await fse__default.ensureDir(`./${storybookConfigFolder}`),addMainFile&&await configureMain({framework:{name:frameworkInclude,options:options.framework||{}},storybookConfigFolder,docs:{autodocs:"tag"},addons:pnp?addons.map(wrapForPnp):addons,extensions,language,...staticDir?{staticDirs:[path9.join("..",staticDir)]}:null,...extraMain,...type!=="framework"?{core:{builder:builderInclude}}:{}}),await configurePreview({frameworkPreviewParts,storybookConfigFolder,language,rendererId});let depsToInstall=[...versionedPackages];if(builder!=="vite"&&!skipBabel){let frameworksThatNeedBabelConfig2=["@storybook/react-webpack5","@storybook/vue-webpack5","@storybook/vue3-webpack5","@storybook/html-webpack5","@storybook/web-components-webpack5"],needsBabelConfig=frameworkPackages4.find(pkg2=>frameworksThatNeedBabelConfig2.includes(pkg2));if(!files.some(fname=>fname.startsWith(".babel")||fname.startsWith("babel"))&&needsBabelConfig){let isTypescript=language!=="javascript",isReact=rendererId==="react";depsToInstall.push(...getBabelPresets({typescript:isTypescript,jsx:isReact})),await writeBabelConfigFile({typescript:isTypescript,jsx:isReact});}}try{if(process.env.CI!=="true"){let{hasEslint,isStorybookPluginInstalled,eslintConfigFile}=await extractEslintInfo(packageManager);hasEslint&&!isStorybookPluginInstalled&&await suggestESLintPlugin()&&(depsToInstall.push("eslint-plugin-storybook"),await configureEslintPlugin(eslintConfigFile,packageManager));}}catch{}if(depsToInstall.length>0){let addDependenciesSpinner=ora({indent:2,text:"Installing Storybook dependencies"}).start();await stopIfExiting(async()=>packageManager.addDependencies({...npmOptions,packageJson},depsToInstall)),addDependenciesSpinner.succeed();}if(addScripts&&await stopIfExiting(async()=>packageManager.addStorybookCommandInScripts({port:6006})),addComponents){let templateLocation=hasFrameworkTemplates(framework)?framework:rendererId;await stopIfExiting(async()=>copyTemplateFiles({renderer:templateLocation,packageManager,language,destination:componentsDestinationPath}));}process.off("SIGINT",setNodeProcessExiting);}var ANGULAR_JSON_PATH="angular.json",compoDocPreviewPrefix=dedent18`
|
|
69
70
|
import { setCompodocJson } from "@storybook/addon-docs/angular";
|
|
70
71
|
import docJson from "../documentation.json";
|
|
71
72
|
setCompodocJson(docJson);
|
|
@@ -82,29 +83,29 @@ var viteConfigFiles=["vite.config.ts","vite.config.js","vite.config.mjs"],webpac
|
|
|
82
83
|
Storybook 7.0+ doesn't support react-scripts@<5.0.0.
|
|
83
84
|
|
|
84
85
|
https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#create-react-app-dropped-cra4-support
|
|
85
|
-
`);await baseGenerator(packageManager,npmOptions,updatedOptions,"react",{extraAddons,extraPackages,staticDir:fs4.existsSync(path9.resolve("./public"))?"public":void 0,skipBabel:!0,extraMain});},REACT_SCRIPTS_default=generator5;var generator6=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"react",void 0,"nextjs");},NEXTJS_default=generator6;var generator7=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"vue");},SFC_VUE_default=generator7;var generator8=async(packageManager,npmOptions,options)=>{let extraPackages=options.builder==="webpack5"?["vue-loader@^15.7.0"]:[];await baseGenerator(packageManager,npmOptions,options,"vue",{extraPackages});},VUE_default=generator8;var generator9=async(packageManager,npmOptions,options)=>{let extraPackages=options.builder==="webpack5"?["vue-loader@^17.0.0","@vue/compiler-sfc@^3.2.0"]:[];await baseGenerator(packageManager,npmOptions,options,"vue3",{extraPackages});},VUE3_default=generator9;var generator10=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"react");},WEBPACK_REACT_default=generator10;var generator11=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"html");},HTML_default=generator11;var generator12=async(packageManager,npmOptions,options)=>baseGenerator(packageManager,npmOptions,options,"web-components",{extraPackages:["lit"]}),WEB_COMPONENTS_default=generator12;var generator13=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"preact");},PREACT_default=generator13;var generator14=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"svelte",{extensions:["js","jsx","ts","tsx","svelte"]});},SVELTE_default=generator14;var generator15=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"qwik",{},"qwik");},QWIK_default=generator15;var generator16=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"svelte",void 0,"sveltekit");},SVELTEKIT_default=generator16;var generator17=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"solid",{},"solid");},SOLID_default=generator17;var generator18=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"server",{extensions:["json"]});},SERVER_default=generator18;var
|
|
86
|
+
`);await baseGenerator(packageManager,npmOptions,updatedOptions,"react",{extraAddons,extraPackages,staticDir:fs4.existsSync(path9.resolve("./public"))?"public":void 0,skipBabel:!0,extraMain});},REACT_SCRIPTS_default=generator5;var generator6=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"react",void 0,"nextjs");},NEXTJS_default=generator6;var generator7=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"vue");},SFC_VUE_default=generator7;var generator8=async(packageManager,npmOptions,options)=>{let extraPackages=options.builder==="webpack5"?["vue-loader@^15.7.0"]:[];await baseGenerator(packageManager,npmOptions,options,"vue",{extraPackages});},VUE_default=generator8;var generator9=async(packageManager,npmOptions,options)=>{let extraPackages=options.builder==="webpack5"?["vue-loader@^17.0.0","@vue/compiler-sfc@^3.2.0"]:[];await baseGenerator(packageManager,npmOptions,options,"vue3",{extraPackages});},VUE3_default=generator9;var generator10=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"react");},WEBPACK_REACT_default=generator10;var generator11=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"html");},HTML_default=generator11;var generator12=async(packageManager,npmOptions,options)=>baseGenerator(packageManager,npmOptions,options,"web-components",{extraPackages:["lit"]}),WEB_COMPONENTS_default=generator12;var generator13=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"preact");},PREACT_default=generator13;var generator14=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"svelte",{extensions:["js","jsx","ts","tsx","svelte"]});},SVELTE_default=generator14;var generator15=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"qwik",{},"qwik");},QWIK_default=generator15;var generator16=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"svelte",void 0,"sveltekit");},SVELTEKIT_default=generator16;var generator17=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"solid",{},"solid");},SOLID_default=generator17;var generator18=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"server",{extensions:["json"]});},SERVER_default=generator18;var logger5=console,installStorybook=async(projectType,packageManager,options)=>{let npmOptions={installAsDevDependencies:!0,skipInstall:options.skipInstall},packageJson;try{packageJson=await packageManager.readPackageJson();}catch{}let language=detectLanguage(packageJson),pnp=detectPnp(),generatorOptions={language,builder:options.builder||await detectBuilder(packageManager,projectType),linkable:!!options.linkable,pnp:pnp||options.usePnp},runGenerator=async()=>{switch(projectType){case"REACT_SCRIPTS":return REACT_SCRIPTS_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "Create React App" based project'));case"REACT":return REACT_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "React" app'));case"REACT_NATIVE":return REACT_NATIVE_default(packageManager,npmOptions).then(commandLog('Adding Storybook support to your "React Native" app'));case"QWIK":return QWIK_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "Qwik" app'));case"WEBPACK_REACT":return WEBPACK_REACT_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "Webpack React" app'));case"REACT_PROJECT":return REACT_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "React" library'));case"NEXTJS":return NEXTJS_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "Next" app'));case"SFC_VUE":return SFC_VUE_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "Single File Components Vue" app'));case"VUE":return VUE_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "Vue" app'));case"VUE3":return VUE3_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "Vue 3" app'));case"ANGULAR":return commandLog('Adding Storybook support to your "Angular" app'),ANGULAR_default(packageManager,npmOptions,generatorOptions,options);case"EMBER":return EMBER_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "Ember" app'));case"HTML":return HTML_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "HTML" app'));case"WEB_COMPONENTS":return WEB_COMPONENTS_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "web components" app'));case"PREACT":return PREACT_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "Preact" app'));case"SVELTE":return SVELTE_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "Svelte" app'));case"SVELTEKIT":return SVELTEKIT_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "SvelteKit" app'));case"SERVER":return SERVER_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "Server" app'));case"NX":throw new Error(dedent18`
|
|
86
87
|
We have detected Nx in your project. Please use "nx g @nrwl/storybook:configuration" to add Storybook to your project.
|
|
87
88
|
|
|
88
89
|
For more information, please see https://nx.dev/packages/storybook
|
|
89
|
-
`);case"SOLID":return SOLID_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "SolidJS" app'));case"UNSUPPORTED":return paddedLog("We detected a project type that we don't support yet."),paddedLog("If you'd like your framework to be supported, please let use know about it at https://github.com/storybookjs/storybook/issues"),
|
|
90
|
-
${chalk13.red(err.stack)}`),new HandledError(err)}},projectTypeInquirer=async(options,packageManager)=>{let manualAnswer=options.yes?!0:await prompts5([{type:"confirm",name:"manual",message:"Do you want to manually choose a Storybook project type to install?"}]);if(manualAnswer!==!0&&manualAnswer.manual){let frameworkAnswer=await prompts5([{type:"select",name:"manualFramework",message:"Please choose a project type from the following list:",choices:installableProjectTypes.map(type=>({title:type,value:type.toUpperCase()}))}]);return installStorybook(frameworkAnswer.manualFramework,packageManager,options)}return Promise.resolve()};async function doInitiate(options,pkg2){let{packageManager:pkgMgr}=options;options.useNpm&&(useNpmWarning(),pkgMgr="npm");let packageManager=JsPackageManagerFactory.getPackageManager({force:pkgMgr}),welcomeMessage="storybook init - the simplest way to add a Storybook to your project.";
|
|
90
|
+
`);case"SOLID":return SOLID_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "SolidJS" app'));case"UNSUPPORTED":return paddedLog("We detected a project type that we don't support yet."),paddedLog("If you'd like your framework to be supported, please let use know about it at https://github.com/storybookjs/storybook/issues"),logger5.log(),Promise.resolve();default:return paddedLog(`We couldn't detect your project type. (code: ${projectType})`),paddedLog("You can specify a project type explicitly via `storybook init --type <type>`, see our docs on how to configure Storybook for your framework: https://storybook.js.org/docs/react/get-started/install"),logger5.log(),projectTypeInquirer(options,packageManager)}};try{return await runGenerator()}catch(err){throw err?.message!=="Canceled by the user"&&err?.stack&&logger5.error(`
|
|
91
|
+
${chalk13.red(err.stack)}`),new HandledError(err)}},projectTypeInquirer=async(options,packageManager)=>{let manualAnswer=options.yes?!0:await prompts5([{type:"confirm",name:"manual",message:"Do you want to manually choose a Storybook project type to install?"}]);if(manualAnswer!==!0&&manualAnswer.manual){let frameworkAnswer=await prompts5([{type:"select",name:"manualFramework",message:"Please choose a project type from the following list:",choices:installableProjectTypes.map(type=>({title:type,value:type.toUpperCase()}))}]);return installStorybook(frameworkAnswer.manualFramework,packageManager,options)}return Promise.resolve()};async function doInitiate(options,pkg2){let{packageManager:pkgMgr}=options;options.useNpm&&(useNpmWarning(),pkgMgr="npm");let packageManager=JsPackageManagerFactory.getPackageManager({force:pkgMgr}),welcomeMessage="storybook init - the simplest way to add a Storybook to your project.";logger5.log(chalk13.inverse(`
|
|
91
92
|
${welcomeMessage}
|
|
92
|
-
`));let{default:updateNotifier}=await import('simple-update-notifier');await updateNotifier({pkg:pkg2,updateCheckInterval:1e3*60*60});let projectType,projectTypeProvided=options.type,infoText=projectTypeProvided?`Installing Storybook for user specified project type: ${projectTypeProvided}`:"Detecting project type",done=commandLog(infoText),packageJson=await packageManager.retrievePackageJson();if(projectTypeProvided)if(installableProjectTypes.includes(projectTypeProvided))projectType=projectTypeProvided.toUpperCase();else throw done(`The provided project type was not recognized by Storybook: ${projectTypeProvided}`),
|
|
93
|
+
`));let{default:updateNotifier}=await import('simple-update-notifier');await updateNotifier({pkg:pkg2,updateCheckInterval:1e3*60*60});let projectType,projectTypeProvided=options.type,infoText=projectTypeProvided?`Installing Storybook for user specified project type: ${projectTypeProvided}`:"Detecting project type",done=commandLog(infoText),packageJson=await packageManager.retrievePackageJson();if(projectTypeProvided)if(installableProjectTypes.includes(projectTypeProvided))projectType=projectTypeProvided.toUpperCase();else throw done(`The provided project type was not recognized by Storybook: ${projectTypeProvided}`),logger5.log(`
|
|
93
94
|
The project types currently supported by Storybook are:
|
|
94
|
-
`),installableProjectTypes.sort().forEach(framework=>paddedLog(`- ${framework}`)),
|
|
95
|
-
For more information visit:`,chalk13.cyan("https://storybook.js.org")),projectType==="ANGULAR"?(
|
|
95
|
+
`),installableProjectTypes.sort().forEach(framework=>paddedLog(`- ${framework}`)),logger5.log(),new HandledError(`Unknown project type supplied: ${projectTypeProvided}`);else try{projectType=detect(packageJson,options);}catch(err){throw done(err.message),new HandledError(err)}done();let storybookInstantiated=isStorybookInstantiated();if(options.force===!1&&storybookInstantiated&&projectType!=="ANGULAR"){logger5.log();let{force}=await prompts5([{type:"confirm",name:"force",message:"We found a .storybook config directory in your project. Therefore we assume that Storybook is already instantiated for your project. Do you still want to continue and force the initialization?"}]);logger5.log(),force?options.force=!0:process.exit(0);}let installResult=await installStorybook(projectType,packageManager,options);options.skipInstall||await packageManager.installDependencies(),options.disableTelemetry||telemetry("init",{projectType}),logger5.log(`
|
|
96
|
+
For more information visit:`,chalk13.cyan("https://storybook.js.org")),projectType==="ANGULAR"?(logger5.log(`
|
|
96
97
|
To run your Storybook, type:
|
|
97
|
-
`),codeLog([`ng run ${installResult.projectName}:storybook`])):projectType==="REACT_NATIVE"?(
|
|
98
|
-
`)),
|
|
99
|
-
`),codeLog(["export {default} from './.storybook';"]),
|
|
98
|
+
`),codeLog([`ng run ${installResult.projectName}:storybook`])):projectType==="REACT_NATIVE"?(logger5.log(),logger5.log(chalk13.yellow(`NOTE: installation is not 100% automated.
|
|
99
|
+
`)),logger5.log(`To quickly run Storybook, replace contents of your app entry with:
|
|
100
|
+
`),codeLog(["export {default} from './.storybook';"]),logger5.log(`
|
|
100
101
|
Then to run your Storybook, type:
|
|
101
|
-
`),codeLog([packageManager.getRunCommand("start")]),
|
|
102
|
+
`),codeLog([packageManager.getRunCommand("start")]),logger5.log(`
|
|
102
103
|
For more in information, see the github readme:
|
|
103
|
-
`),
|
|
104
|
+
`),logger5.log(chalk13.cyan("https://github.com/storybookjs/react-native")),logger5.log()):(logger5.log(`
|
|
104
105
|
To run your Storybook, type:
|
|
105
|
-
`),codeLog([packageManager.getRunStorybookCommand()])),
|
|
106
|
+
`),codeLog([packageManager.getRunStorybookCommand()])),logger5.log();}async function initiate(options,pkg2){await withTelemetry("init",{cliOptions:options,printError:err=>!err.handled&&logger5.error(err)},()=>doInitiate(options,pkg2));}var logger6=console,LEGACY_CONFIGS=["addons","config","presets"],postinstallAddon=async(addonName,isOfficialAddon)=>{let skipMsg=null;isOfficialAddon?fs4.existsSync(".storybook")?(skipMsg="no codmods found",LEGACY_CONFIGS.forEach(config=>{try{let codemod=__require.resolve(`${getPackageName(addonName,isOfficialAddon)}/postinstall/${config}.js`);commandLog(`Running postinstall script for ${addonName}`)();let configFile=path9.join(".storybook",`${config}.ts`);fs4.existsSync(configFile)||(configFile=path9.join(".storybook",`${config}.js`),fs4.existsSync(configFile)||fs4.writeFileSync(configFile,"","utf8")),sync$1("npx",["jscodeshift","-t",codemod,configFile],{stdio:"inherit",shell:!0}),skipMsg=null;}catch{}})):skipMsg="no .storybook config":skipMsg="unofficial addon",skipMsg&&commandLog(`Skipping postinstall for ${addonName}, ${skipMsg}`)();},getVersionSpecifier=addon=>{let groups=/^(...*)@(.*)$/.exec(addon);return groups?[groups[1],groups[2]]:[addon,void 0]};async function add(addon,options){let{packageManager:pkgMgr}=options;options.useNpm&&(useNpmWarning(),pkgMgr="npm");let packageManager=JsPackageManagerFactory.getPackageManager({force:pkgMgr}),packageJson=await packageManager.retrievePackageJson(),[addonName,versionSpecifier]=getVersionSpecifier(addon),{mainConfig,version:storybookVersion}=getStorybookInfo(packageJson);if(!mainConfig){logger6.error("Unable to find storybook main.js config");return}let main=await readConfig(mainConfig);logger6.log(`Verifying ${addonName}`);let latestVersion=await packageManager.latestVersion(addonName);latestVersion||logger6.error(`Unknown addon ${addonName}`);let isStorybookAddon=addonName.startsWith("@storybook/"),addonWithVersion=`${addonName}@${versionSpecifier||(isStorybookAddon?storybookVersion:latestVersion)}`;logger6.log(`Installing ${addonWithVersion}`),await packageManager.addDependencies({installAsDevDependencies:!0},[addonWithVersion]),logger6.log(`Adding '${addon}' to main.js addons field.`),main.appendValueToArray(["addons"],addonName),await writeConfig(main),options.skipPostinstall||await postinstallAddon(addon,isStorybookAddon);}var logger7=console,getStorybookData=async({packageManager,configDir:userDefinedConfigDir})=>{let packageJson=await packageManager.retrievePackageJson(),{mainConfig:mainConfigPath,version:storybookVersionSpecifier,configDir:configDirFromScript,previewConfig:previewConfigPath}=getStorybookInfo(packageJson,userDefinedConfigDir),storybookVersion=storybookVersionSpecifier&&semver.coerce(storybookVersionSpecifier)?.version,configDir=userDefinedConfigDir||configDirFromScript||".storybook",mainConfig;try{mainConfig=await loadMainConfig({configDir,noCache:!0});}catch(err){throw new Error(dedent18`Unable to find or evaluate ${chalk13.blue(mainConfigPath)}: ${err.message}`)}return {configDir,mainConfig,storybookVersionSpecifier,storybookVersion,mainConfigPath,previewConfigPath}},updateMainConfig=async({mainConfigPath,dryRun},callback)=>{try{let main=await readConfig(mainConfigPath);await callback(main),dryRun||await writeConfig(main);}catch(e){logger7.info(`\u274C The migration failed to update your ${chalk13.blue(mainConfigPath)} on your behalf because of the following error:
|
|
106
107
|
${e}
|
|
107
|
-
`),
|
|
108
|
+
`),logger7.info(`\u26A0\uFE0F Storybook automigrations are based on AST parsing and it's possible that your ${chalk13.blue(mainConfigPath)} file contains a non-standard format (e.g. your export is not an object) or that there was an error when parsing dynamic values (e.g. "require" calls, or usage of environment variables). When your main config is non-standard, automigrations are unfortunately not possible. Please follow the instructions given previously and follow the documentation to make the updates manually.`);}},getAddonNames=mainConfig=>(mainConfig.addons||[]).map(addon=>{let name="";if(typeof addon=="string"?name=addon:typeof addon=="object"&&(name=addon.name),!name.startsWith("."))return name.replace(/\/dist\/.*/,"").replace(/\.[mc]?[tj]?s[x]?$/,"").replace(/\/register$/,"").replace(/\/manager$/,"").replace(/\/preset$/,"")}).filter(Boolean);var logger8=console,checkWebpack5Builder=async({configDir,packageManager})=>{let{mainConfig,storybookVersion}=await getStorybookData({configDir,packageManager});if(semver.lt(storybookVersion,"6.3.0"))return logger8.warn(dedent18`
|
|
108
109
|
Detected SB 6.3 or below, please upgrade storybook to use webpack5.
|
|
109
110
|
|
|
110
111
|
To upgrade to the latest stable release, run this from your project directory:
|
|
@@ -112,14 +113,14 @@ To run your Storybook, type:
|
|
|
112
113
|
${chalk13.cyan("npx storybook upgrade")}
|
|
113
114
|
|
|
114
115
|
Add the ${chalk13.cyan("--prerelease")} flag to get the latest prerelease.
|
|
115
|
-
`.trim()),null;if(semver.gte(storybookVersion,"7.0.0"))return null;if(!mainConfig)return
|
|
116
|
+
`.trim()),null;if(semver.gte(storybookVersion,"7.0.0"))return null;if(!mainConfig)return logger8.warn("Unable to find storybook main.js config"),null;let builder=mainConfig.core?.builder;return builder&&builder!=="webpack4"?(logger8.info(`Found builder ${builder}, skipping`),null):{storybookVersion}};var logger9=console,webpack5={id:"webpack5",async check({configDir,packageManager}){let webpackVersion=(await packageManager.retrievePackageJson()).dependencies.webpack,webpackCoerced=semver.coerce(webpackVersion)?.version;if(!webpackCoerced||semver.lt(webpackCoerced,"5.0.0")||semver.gte(webpackCoerced,"6.0.0"))return null;let builderInfo=await checkWebpack5Builder({configDir,packageManager});return builderInfo?{webpackVersion,...builderInfo}:null},prompt({webpackVersion}){let webpackFormatted=chalk13.cyan(`webpack ${webpackVersion}`);return dedent`
|
|
116
117
|
We've detected you're running ${webpackFormatted}.
|
|
117
118
|
Your Storybook's main.js files specifies webpack4, which is incompatible.
|
|
118
119
|
|
|
119
120
|
To run Storybook in webpack5-mode, we can install Storybook's ${chalk13.cyan("@storybook/builder-webpack5")} for you.
|
|
120
121
|
|
|
121
122
|
More info: ${chalk13.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#webpack-5-manager-build")}
|
|
122
|
-
`},async run({result:{storybookVersion,webpackVersion},packageManager,dryRun,mainConfigPath}){let deps=[`@storybook/builder-webpack5@${storybookVersion}`];webpackVersion||deps.push("webpack@5"),
|
|
123
|
+
`},async run({result:{storybookVersion,webpackVersion},packageManager,dryRun,mainConfigPath}){let deps=[`@storybook/builder-webpack5@${storybookVersion}`];webpackVersion||deps.push("webpack@5"),logger9.info(`\u2705 Adding dependencies: ${deps}`),dryRun||await packageManager.addDependencies({installAsDevDependencies:!0},deps),logger9.info("\u2705 Setting `core.builder` to `@storybook/builder-webpack5` in main.js"),dryRun||await updateMainConfig({mainConfigPath,dryRun},async main=>{main.setFieldValue(["core","builder"],"@storybook/builder-webpack5");});}};var cra5={id:"cra5",async check({packageManager,configDir}){let craVersion=(await packageManager.getAllDependencies())["react-scripts"],craCoerced=semver.coerce(craVersion)?.version;if(!craCoerced||semver.lt(craCoerced,"5.0.0"))return null;let builderInfo=await checkWebpack5Builder({configDir,packageManager});return builderInfo?{craVersion,...builderInfo}:null},prompt({craVersion}){let craFormatted=chalk13.cyan(`Create React App (CRA) ${craVersion}`);return dedent`
|
|
123
124
|
We've detected you are running ${craFormatted} which is powered by webpack5.
|
|
124
125
|
Your Storybook's main.js files specifies webpack4, which is incompatible.
|
|
125
126
|
|
|
@@ -140,7 +141,7 @@ To run your Storybook, type:
|
|
|
140
141
|
In order to work with your version of Vue, we need to install Storybook's ${chalk13.cyan("webpack5 builder")}.
|
|
141
142
|
|
|
142
143
|
More info: ${chalk13.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#vue3-upgrade")}
|
|
143
|
-
`},async run(options){return webpack5.run({...options,result:{webpackVersion:null,...options.result}})}};function slash(path11){return /^\\\\\?\\/.test(path11)?path11:path11.replace(/\\/g,"/")}var
|
|
144
|
+
`},async run(options){return webpack5.run({...options,result:{webpackVersion:null,...options.result}})}};function slash(path11){return /^\\\\\?\\/.test(path11)?path11:path11.replace(/\\/g,"/")}var logger10=console,mdxgfm={id:"github-flavored-markdown-mdx",async check({configDir,packageManager}){let{mainConfig,storybookVersion}=await getStorybookData({packageManager,configDir});if(!semver.gte(storybookVersion,"7.0.0"))return null;let hasMDXFiles=await mainConfig?.stories?.reduce(async(acc,item)=>{if(await acc===!0)return !0;let pattern=typeof item=="string"?slash(join(configDir,item)):slash(join(configDir,item.directory,item.files));return (await glob(pattern)).some(f=>f.endsWith(".mdx"))},Promise.resolve(!1));return mainConfig?.features?.legacyMdx1===!0||!1||!hasMDXFiles||!!mainConfig.addons?.find(item=>item==="@storybook/addon-mdx-gfm"?!0:typeof item=="string"?!1:item.name==="@storybook/addon-docs"?item.options?.mdxPluginOptions?.mdxCompileOptions?.remarkPlugins?.length>0:!1)?null:{}},prompt(){return dedent`
|
|
144
145
|
In MDX1 you had the option of using GitHub flavored markdown.
|
|
145
146
|
|
|
146
147
|
Storybook 7.0 uses MDX2 for compiling MDX, and thus no longer supports GFM out of the box.
|
|
@@ -149,20 +150,20 @@ To run your Storybook, type:
|
|
|
149
150
|
|
|
150
151
|
We recommend you follow the guide on the link above, however we can add a temporary storybook addon that helps make this migration easier.
|
|
151
152
|
We'll install the addon and add it to your storybook config.
|
|
152
|
-
`},async run({packageManager,dryRun,mainConfigPath,skipInstall}){if(!dryRun){let packageJson=await packageManager.retrievePackageJson(),versionToInstall=getStorybookVersionSpecifier(await packageManager.retrievePackageJson());await packageManager.addDependencies({installAsDevDependencies:!0,skipInstall,packageJson},[`@storybook/addon-mdx-gfm@${versionToInstall}`]),await updateMainConfig({mainConfigPath,dryRun},async main=>{
|
|
153
|
+
`},async run({packageManager,dryRun,mainConfigPath,skipInstall}){if(!dryRun){let packageJson=await packageManager.retrievePackageJson(),versionToInstall=getStorybookVersionSpecifier(await packageManager.retrievePackageJson());await packageManager.addDependencies({installAsDevDependencies:!0,skipInstall,packageJson},[`@storybook/addon-mdx-gfm@${versionToInstall}`]),await updateMainConfig({mainConfigPath,dryRun},async main=>{logger10.info('\u2705 Adding "@storybook/addon-mdx-gfm" addon'),dryRun||main.appendValueToArray(["addons"],"@storybook/addon-mdx-gfm");});}}};var logger11=console,eslintPlugin={id:"eslintPlugin",async check({packageManager}){let{hasEslint,isStorybookPluginInstalled}=await extractEslintInfo(packageManager);if(isStorybookPluginInstalled||!hasEslint)return null;let eslintFile,unsupportedExtension;try{eslintFile=findEslintFile();}catch(err){unsupportedExtension=err.message;}return !eslintFile&&!unsupportedExtension?(logger11.warn("Unable to find .eslintrc config file, skipping"),null):{eslintFile,unsupportedExtension}},prompt(){return dedent`
|
|
153
154
|
We've detected you are not using our eslint-plugin.
|
|
154
155
|
|
|
155
156
|
In order to have the best experience with Storybook and follow best practices, we advise you to install eslint-plugin-storybook.
|
|
156
157
|
|
|
157
158
|
More info: ${chalk13.yellow("https://github.com/storybookjs/eslint-plugin-storybook#readme")}
|
|
158
|
-
`},async run({result:{eslintFile,unsupportedExtension},packageManager,dryRun,skipInstall}){let deps=["eslint-plugin-storybook"];if(
|
|
159
|
+
`},async run({result:{eslintFile,unsupportedExtension},packageManager,dryRun,skipInstall}){let deps=["eslint-plugin-storybook"];if(logger11.info(`\u2705 Adding dependencies: ${deps}`),dryRun||await packageManager.addDependencies({installAsDevDependencies:!0,skipInstall},deps),!dryRun&&unsupportedExtension){logger11.info(dedent`
|
|
159
160
|
⚠️ The plugin was successfully installed but failed to configure.
|
|
160
161
|
|
|
161
162
|
Found an eslint config file with an unsupported automigration format: .eslintrc.${unsupportedExtension}.
|
|
162
163
|
The supported formats for this automigration are: ${SUPPORTED_ESLINT_EXTENSIONS.join(", ")}.
|
|
163
164
|
|
|
164
165
|
Please refer to https://github.com/storybookjs/eslint-plugin-storybook#usage to finish setting up the plugin manually.
|
|
165
|
-
`);return}dryRun||await configureEslintPlugin(eslintFile,packageManager);}};var
|
|
166
|
+
`);return}dryRun||await configureEslintPlugin(eslintFile,packageManager);}};var logger12=console,builderVite={id:"builder-vite",async check({configDir,packageManager}){let packageJson=await packageManager.retrievePackageJson(),{mainConfig}=await getStorybookData({configDir,packageManager}),builder=mainConfig.core?.builder;return (typeof builder=="string"?builder:builder?.name)!=="storybook-builder-vite"?null:{builder,packageJson}},prompt({builder}){let builderFormatted=chalk13.cyan(JSON.stringify(builder,null,2));return dedent`
|
|
166
167
|
We've detected you're using the community vite builder: ${builderFormatted}
|
|
167
168
|
|
|
168
169
|
'storybook-builder-vite' is deprecated and now located at ${chalk13.cyan("@storybook/builder-vite")}.
|
|
@@ -170,7 +171,7 @@ To run your Storybook, type:
|
|
|
170
171
|
We can upgrade your project to use the new builder automatically.
|
|
171
172
|
|
|
172
173
|
More info: ${chalk13.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#vite-builder-renamed")}
|
|
173
|
-
`},async run({result:{builder,packageJson},packageManager,dryRun,mainConfigPath}){let{dependencies={},devDependencies={}}=packageJson;
|
|
174
|
+
`},async run({result:{builder,packageJson},packageManager,dryRun,mainConfigPath}){let{dependencies={},devDependencies={}}=packageJson;logger12.info("\u2705 Removing existing 'storybook-builder-vite' dependency"),dryRun||(delete dependencies["storybook-builder-vite"],delete devDependencies["storybook-builder-vite"],await packageManager.writePackageJson(packageJson)),logger12.info("\u2705 Adding '@storybook/builder-vite' as dev dependency"),dryRun||await packageManager.addDependencies({installAsDevDependencies:!0},["@storybook/builder-vite"]),logger12.info("\u2705 Updating main.js to use vite builder"),dryRun||await updateMainConfig({dryRun,mainConfigPath},async main=>{let updatedBuilder=typeof builder=="string"?"@storybook/builder-vite":{name:"@storybook/builder-vite",options:builder.options};main.setFieldValue(["core","builder"],updatedBuilder),await writeConfig(main);});}};var logger13=console,getStorybookScripts=allScripts=>Object.keys(allScripts).reduce((acc,key)=>{let isStorybookScript=!1,allWordsFromScript=allScripts[key].split(" "),newScript=allWordsFromScript.map((currentWord,index)=>{let previousWord=allWordsFromScript[index-1],isSbBinary=currentWord==="build-storybook"||currentWord==="start-storybook"||currentWord==="sb",isPrependedByPkgManager=previousWord&&["npx","run","yarn","pnpx","pnpm dlx"].some(cmd=>previousWord.includes(cmd));return isSbBinary&&!isPrependedByPkgManager?(isStorybookScript=!0,currentWord.replace("sb","storybook").replace("start-storybook","storybook dev").replace("build-storybook","storybook build")):currentWord}).join(" ");return isStorybookScript&&(acc[key]={before:allScripts[key],after:newScript}),acc},{}),sbScripts={id:"sb-scripts",async check({packageManager,configDir}){let packageJson=await packageManager.retrievePackageJson(),{scripts={}}=packageJson,{storybookVersion}=await getStorybookData({packageManager,configDir});if(semver.lt(storybookVersion,"7.0.0"))return null;let storybookScripts=getStorybookScripts(scripts);return Object.keys(storybookScripts).length===0?null:{packageJson,storybookScripts,storybookVersion}},prompt({storybookVersion,storybookScripts}){let sbFormatted=chalk13.cyan(`Storybook ${storybookVersion}`),newScriptsMessage=Object.keys(storybookScripts).reduce((acc,scriptKey)=>(acc.push([chalk13.bold(scriptKey),"from:",chalk13.cyan(storybookScripts[scriptKey].before),"to:",chalk13.cyan(storybookScripts[scriptKey].after)].join(`
|
|
174
175
|
`)),acc),[]);return dedent`
|
|
175
176
|
We've detected you are using ${sbFormatted} with scripts from previous versions of Storybook.
|
|
176
177
|
Starting in Storybook 7, the ${chalk13.yellow("start-storybook")} and ${chalk13.yellow("build-storybook")} binaries have changed to ${chalk13.magenta("storybook dev")} and ${chalk13.magenta("storybook build")} respectively.
|
|
@@ -181,13 +182,13 @@ To run your Storybook, type:
|
|
|
181
182
|
`)}
|
|
182
183
|
|
|
183
184
|
In case this migration did not cover all of your scripts, or you'd like more info: ${chalk13.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#start-storybook--build-storybook-binaries-removed")}
|
|
184
|
-
`},async run({result:{storybookScripts},packageManager,dryRun}){if(
|
|
185
|
+
`},async run({result:{storybookScripts},packageManager,dryRun}){if(logger13.info("\u2705 Updating scripts in package.json"),logger13.log(),!dryRun){let newScripts=Object.keys(storybookScripts).reduce((acc,scriptKey)=>(acc[scriptKey]=storybookScripts[scriptKey].after,acc),{});logger13.log(),await packageManager.addScripts(newScripts);}}};var logger14=console,sbBinary={id:"storybook-binary",async check({packageManager,configDir}){let packageJson=await packageManager.retrievePackageJson(),allDependencies=await packageManager.getAllDependencies(),{storybookVersion}=await getStorybookData({packageManager,configDir});if(allDependencies["@nrwl/storybook"]||semver.lt(storybookVersion,"7.0.0"))return null;let hasSbBinary=!!allDependencies.sb,hasStorybookBinary=!!allDependencies.storybook;return !hasSbBinary&&hasStorybookBinary?null:{hasSbBinary,hasStorybookBinary,storybookVersion,packageJson}},prompt({storybookVersion,hasSbBinary,hasStorybookBinary}){let sbFormatted=chalk13.cyan(`Storybook ${storybookVersion}`),storybookBinaryMessage=hasStorybookBinary?"":`We've detected you are using ${sbFormatted} without Storybook's ${chalk13.magenta("storybook")} binary. Starting in Storybook 7.0, it has to be installed.`;return dedent`
|
|
185
186
|
${storybookBinaryMessage}
|
|
186
187
|
${hasSbBinary?`You're using the 'sb' binary and it should be replaced, as 'storybook' is the recommended way to run Storybook.
|
|
187
188
|
`:""}
|
|
188
189
|
|
|
189
190
|
More info: ${chalk13.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#start-storybook--build-storybook-binaries-removed")}
|
|
190
|
-
`},async run({result:{packageJson,hasSbBinary,hasStorybookBinary},packageManager,dryRun,skipInstall}){if(hasSbBinary&&(
|
|
191
|
+
`},async run({result:{packageJson,hasSbBinary,hasStorybookBinary},packageManager,dryRun,skipInstall}){if(hasSbBinary&&(logger14.info("\u2705 Removing 'sb' dependency"),dryRun||await packageManager.removeDependencies({skipInstall:skipInstall||!hasStorybookBinary,packageJson},["sb"])),!hasStorybookBinary&&(logger14.log(),logger14.info("\u2705 Adding 'storybook' as dev dependency"),logger14.log(),!dryRun)){let versionToInstall=getStorybookVersionSpecifier(packageJson);await packageManager.addDependencies({installAsDevDependencies:!0,packageJson,skipInstall},[`storybook@${versionToInstall}`]);}}};var detectRenderer=async packageJson=>{let allDependencies={...packageJson.dependencies,...packageJson.devDependencies,...packageJson.peerDependencies},matches=Object.keys(rendererPackages).filter(pkg2=>!!allDependencies[pkg2]),[rendererPackage]=matches;return matches.length>1&&(rendererPackage=(await prompts5([{type:"select",name:"rendererPackage",hint:"> - Use arrow-keys. Return to submit. To automate this next time, you can pass the renderer to the CLI via the --renderer flag",message:"Tried to detect a Storybook renderer in your project but found multiple. This could happen in monorepos, when projects contain multiple Storybook packages in package.json. Please select the correct one:",choices:matches.map(type=>({title:type,value:type}))}])).rendererPackage),rendererPackage};var logger15=console,packagesMap={"@storybook/react":{webpack5:"@storybook/react-webpack5",vite:"@storybook/react-vite"},"@storybook/preact":{webpack5:"@storybook/preact-webpack5",vite:"@storybook/preact-vite"},"@storybook/server":{webpack5:"@storybook/server-webpack5"},"@storybook/ember":{webpack5:"@storybook/ember"},"@storybook/angular":{webpack5:"@storybook/angular"},"@storybook/vue":{webpack5:"@storybook/vue-webpack5",vite:"@storybook/vue-vite"},"@storybook/vue3":{webpack5:"@storybook/vue3-webpack5",vite:"@storybook/vue3-vite"},"@storybook/svelte":{webpack5:"@storybook/svelte-webpack5",vite:"@storybook/svelte-vite"},"@storybook/web-components":{webpack5:"@storybook/web-components-webpack5",vite:"@storybook/web-components-vite"},"@storybook/html":{webpack5:"@storybook/html-webpack5",vite:"@storybook/html-vite"}},communityFrameworks={vite:["storybook-framework-qwik","storybook-solidjs-vite"],webpack5:[]},viteConfigFiles2=["vite.config.js","vite.config.cjs","vite.config.mjs","vite.config.ts"],webpackConfigFiles2=["webpack.config.js","webpack.config.cjs","webpack.config.mjs","webpack.config.ts"],detectBuilderInfo=async({mainConfig,configDir,packageDependencies})=>{let builderOptions={},builderName,builderOrFrameworkName,{core={},framework}=mainConfig,{builder}=core;if(builder)typeof builder=="string"?builderOrFrameworkName=builder:(builderOrFrameworkName=builder.name,builderOptions=builder.options||{});else if(framework){let frameworkName=typeof framework=="string"?framework:framework.name;Object.keys(frameworkPackages).includes(frameworkName)&&(builderOrFrameworkName=frameworkName,builderOptions=typeof framework=="object"?framework.options?.builder:{});}if(!builderOrFrameworkName){let viteConfigFile=await findUp(viteConfigFiles2,{cwd:configDir});if(viteConfigFile)logger15.info(`No builder or framework field, detected Storybook builder via: ${viteConfigFile}`),builderOrFrameworkName="vite";else {let webpackConfigFile=await findUp(webpackConfigFiles2,{cwd:configDir});webpackConfigFile&&(logger15.info(`No builder or framework field, detected Storybook builder via: ${webpackConfigFile}`),builderOrFrameworkName="webpack5");}}return builderOrFrameworkName||(packageDependencies["@storybook/builder-vite"]||packageDependencies["storybook-builder-vite"]?builderOrFrameworkName="vite":(packageDependencies["@storybook/builder-webpack5"]||packageDependencies["@storybook/manager-webpack5"])&&(builderOrFrameworkName="webpack5")),builderOrFrameworkName?.includes("vite")||communityFrameworks.vite.includes(builderOrFrameworkName)?builderName="vite":(builderOrFrameworkName?.includes("webpack")||communityFrameworks.webpack5.includes(builderOrFrameworkName),builderName="webpack5"),{name:builderName,options:builderOptions}},getNextjsAddonOptions=addons=>{let nextjsAddon=addons?.find(addon=>typeof addon=="string"?addon==="storybook-addon-next":addon.name==="storybook-addon-next");return !nextjsAddon||typeof nextjsAddon=="string"?{}:nextjsAddon.options||{}};var logger16=console,nextJsConfigFiles=["next.config.js","next.config.cjs","next.config.mjs","next.config.ts"],newFrameworks={id:"new-frameworks",async check({rendererPackage:userDefinedRendererPackage,configDir:userDefinedConfigDir,packageManager}){let packageJson=await packageManager.retrievePackageJson(),{storybookVersion,mainConfig,mainConfigPath,configDir}=await getStorybookData({packageManager,configDir:userDefinedConfigDir});if(!semver.gte(storybookVersion,"7.0.0"))return null;let frameworkPackage=typeof mainConfig.framework=="string"?mainConfig.framework:mainConfig.framework?.name,hasFrameworkInMainConfig=!!frameworkPackage,rendererPackage=userDefinedRendererPackage;rendererPackage||(frameworkPackage&&Object.keys(rendererPackages).includes(frameworkPackage)?rendererPackage=frameworkPackage:frameworkPackage&&Object.values(rendererPackages).includes(frameworkPackage)?(rendererPackage=Object.keys(rendererPackages).find(k=>rendererPackages[k]===frameworkPackage),hasFrameworkInMainConfig=!1):rendererPackage=await detectRenderer(packageJson));let builderConfig=mainConfig.core?.builder;if(!Object.keys(packagesMap).includes(rendererPackage))return null;let allDependencies=await packageManager.getAllDependencies(),builderInfo=await detectBuilderInfo({mainConfig,configDir,packageDependencies:allDependencies}),newFrameworkPackage=Object.keys(frameworkPackages).find(pkg2=>pkg2===frameworkPackage);if(newFrameworkPackage||(newFrameworkPackage=packagesMap[rendererPackage]&&packagesMap[rendererPackage][builderInfo.name]),!newFrameworkPackage)return null;let renderer=rendererPackages[rendererPackage],rendererOptions=mainConfig[`${renderer}Options`]||{},frameworkOptions=typeof mainConfig.framework=="string"?{}:mainConfig.framework?.options,dependenciesToRemove=["@storybook/builder-webpack5","@storybook/manager-webpack5","@storybook/builder-webpack4","@storybook/manager-webpack4","@storybook/builder-vite","storybook-builder-vite"],addonsToRemove=[],addonOptions={},metaFramework;if(rendererPackage==="@storybook/react"&&allDependencies.next){let nextConfigFile=await findUp(nextJsConfigFiles,{cwd:configDir}),nextAddonOptions=getNextjsAddonOptions(mainConfig.addons);(semver.gte(semver.coerce(allDependencies.next).version,"12.0.0")&&nextConfigFile||Object.keys(nextAddonOptions).length>0)&&(metaFramework="nextjs",(newFrameworkPackage==="@storybook/react-webpack5"||newFrameworkPackage==="@storybook/nextjs")&&(newFrameworkPackage="@storybook/nextjs",addonsToRemove=["storybook-addon-next","storybook-addon-next-router"].filter(dep=>allDependencies[dep]||mainConfig.addons?.find(addon=>typeof addon=="string"?dep===addon:dep===addon.name)),addonOptions=nextAddonOptions,dependenciesToRemove.push("@storybook/react-webpack5","storybook-addon-next","storybook-addon-next-router")));}else rendererPackage==="@storybook/svelte"&&allDependencies["@sveltejs/kit"]&&semver.gte(semver.coerce(allDependencies["@sveltejs/kit"]).version,"1.0.0")&&(metaFramework="sveltekit",newFrameworkPackage==="@storybook/svelte-vite"&&(newFrameworkPackage="@storybook/sveltekit",rendererOptions={},dependenciesToRemove.push("@storybook/svelte-vite")));let dependenciesToAdd=[newFrameworkPackage].filter(dep=>!allDependencies[dep]).filter(Boolean);if(dependenciesToRemove=dependenciesToRemove.filter(dep=>allDependencies[dep]).filter(Boolean),hasFrameworkInMainConfig&&!builderConfig&&!Object.keys(rendererOptions).length&&!Object.keys(addonOptions).length&&!dependenciesToRemove.length&&!dependenciesToAdd.length)return null;if(allDependencies.vite&&semver.lt(semver.coerce(allDependencies.vite).version,"3.0.0"))throw new Error(dedent18`
|
|
191
192
|
❌ Your project should be upgraded to use the framework package ${chalk13.bold(newFrameworkPackage)}, but we detected that you are using Vite ${chalk13.bold(allDependencies.vite)}, which is unsupported in ${chalk13.bold("Storybook 7.0")}. Please upgrade Vite to ${chalk13.bold("3.0.0 or higher")} and rerun this migration.
|
|
192
193
|
`);return {mainConfigPath,dependenciesToAdd,dependenciesToRemove,frameworkPackage:newFrameworkPackage,hasFrameworkInMainConfig,frameworkOptions:{...frameworkOptions,...rendererOptions,...addonOptions},rendererOptions,addonOptions,addonsToRemove,builderInfo,packageJson,renderer,builderConfig,metaFramework}},prompt({dependenciesToRemove,dependenciesToAdd,hasFrameworkInMainConfig,mainConfigPath,frameworkPackage,addonOptions,renderer,rendererOptions,builderConfig,addonsToRemove,metaFramework}){let disclaimer="",migrationSteps="";return dependenciesToRemove.length>0&&(migrationSteps+=`- Remove the following dependencies:
|
|
193
194
|
${dependenciesToRemove.map(dep=>`- * ${chalk13.cyan(dep)}`).join(`
|
|
@@ -244,7 +245,7 @@ To run your Storybook, type:
|
|
|
244
245
|
${migrationSteps}
|
|
245
246
|
|
|
246
247
|
To learn more about the new framework format, see: ${chalk13.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#new-framework-api")}${disclaimer}
|
|
247
|
-
`},async run({result:{dependenciesToAdd,dependenciesToRemove,frameworkPackage,frameworkOptions,builderInfo,packageJson,renderer,addonsToRemove},packageManager,dryRun,mainConfigPath,skipInstall}){if(dependenciesToRemove.length>0&&(
|
|
248
|
+
`},async run({result:{dependenciesToAdd,dependenciesToRemove,frameworkPackage,frameworkOptions,builderInfo,packageJson,renderer,addonsToRemove},packageManager,dryRun,mainConfigPath,skipInstall}){if(dependenciesToRemove.length>0&&(logger16.info(`\u2705 Removing dependencies: ${dependenciesToRemove.join(", ")}`),dryRun||await packageManager.removeDependencies({skipInstall:skipInstall||dependenciesToAdd.length>0,packageJson},dependenciesToRemove)),dependenciesToAdd.length>0&&(logger16.info(`\u2705 Installing new dependencies: ${dependenciesToAdd.join(", ")}`),!dryRun)){let versionToInstall=getStorybookVersionSpecifier(packageJson),depsToAdd=dependenciesToAdd.map(dep=>`${dep}@${versionToInstall}`);await packageManager.addDependencies({installAsDevDependencies:!0,skipInstall,packageJson},depsToAdd);}await updateMainConfig({mainConfigPath,dryRun},async main=>{logger16.info("\u2705 Updating main.js"),logger16.info('\u2705 Updating "framework" field'),dryRun||main.setFieldValue(["framework","name"],frameworkPackage),dryRun||main.setFieldValue(["framework","options"],frameworkOptions),main.getFieldNode([`${renderer}Options`])&&(logger16.info(`\u2705 Moving "${renderer}Options" to "framework.options"`),dryRun||main.removeField([`${renderer}Options`])),main.getFieldNode(["core","builder"])&&(logger16.info('\u2705 Removing "core.builder" field'),dryRun||main.removeField(["core","builder"])),Object.keys(builderInfo.options).length>0&&(logger16.info('\u2705 Moving "core.builder.options" into "framework.options.builder"'),dryRun||main.setFieldValue(["framework","options","builder"],builderInfo.options));let currentCore=main.getFieldValue(["core"]);if(currentCore&&Object.keys(currentCore).length===0&&(logger16.info('\u2705 Removing "core" field'),dryRun||main.removeField(["core"])),addonsToRemove.length>0){let updatedAddons=main.getFieldValue(["addons"]).filter(addon=>typeof addon=="string"?!addonsToRemove.includes(addon):addon.name?!addonsToRemove.includes(addon.name):!1);logger16.info("\u2705 Removing unnecessary addons"),dryRun||main.setFieldValue(["addons"],updatedAddons);}});}};var RemovedAPIs=(RemovedAPIs2=>(RemovedAPIs2.addDecorator="addDecorator",RemovedAPIs2.addParameters="addParameters",RemovedAPIs2.addLoader="addLoader",RemovedAPIs2.getStorybook="getStorybook",RemovedAPIs2.setAddon="setAddon",RemovedAPIs2.clearDecorators="clearDecorators",RemovedAPIs2))(RemovedAPIs||{}),removedGlobalClientAPIs={id:"removedglobalclientapis",promptOnly:!0,async check({packageManager,configDir}){let packageJson=await packageManager.retrievePackageJson(),{previewConfig}=getStorybookInfo(packageJson,configDir);if(previewConfig){let contents=await readFile(previewConfig,"utf8"),usedAPIs=Object.values(RemovedAPIs).reduce((acc,item)=>(contents.includes(item)&&acc.push(item),acc),[]);if(usedAPIs.length)return {usedAPIs,previewPath:previewConfig}}return null},prompt({usedAPIs,previewPath}){return dedent18`
|
|
248
249
|
${chalk13.bold(chalk13.red("Attention"))}: We could not automatically make this change. You'll need to do it manually.
|
|
249
250
|
|
|
250
251
|
The following APIs (used in "${chalk13.yellow(previewPath)}") have been removed from Storybook:
|
|
@@ -254,7 +255,7 @@ To run your Storybook, type:
|
|
|
254
255
|
|
|
255
256
|
Please see the migration guide for more information:
|
|
256
257
|
${chalk13.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#removed-global-client-apis")}
|
|
257
|
-
`}};var MDX1_STYLE_START=/<style>{`/g,MDX1_STYLE_END=/`}<\/style>/g,MDX1_COMMENT=/<!--(.+)-->/g,MDX1_CODEBLOCK=/(?:\n~~~(?:\n|.)*?\n~~~)|(?:\n```(?:\n|.)*?\n```)/g,fixMdxStyleTags=mdx=>mdx.replace(MDX1_STYLE_START,"<style>\n {`").replace(MDX1_STYLE_END," `}\n</style>"),fixMdxComments=mdx=>{let codeblocks=mdx.matchAll(MDX1_CODEBLOCK);return mdx.split(MDX1_CODEBLOCK).map(v=>v.replace(MDX1_COMMENT,(original,group)=>`{/*${group}*/}`)).reduce((acc,item,i)=>{let next=codeblocks.next();return next.done?acc+item:acc+item+next.value[0]},"")},
|
|
258
|
+
`}};var MDX1_STYLE_START=/<style>{`/g,MDX1_STYLE_END=/`}<\/style>/g,MDX1_COMMENT=/<!--(.+)-->/g,MDX1_CODEBLOCK=/(?:\n~~~(?:\n|.)*?\n~~~)|(?:\n```(?:\n|.)*?\n```)/g,fixMdxStyleTags=mdx=>mdx.replace(MDX1_STYLE_START,"<style>\n {`").replace(MDX1_STYLE_END," `}\n</style>"),fixMdxComments=mdx=>{let codeblocks=mdx.matchAll(MDX1_CODEBLOCK);return mdx.split(MDX1_CODEBLOCK).map(v=>v.replace(MDX1_COMMENT,(original,group)=>`{/*${group}*/}`)).reduce((acc,item,i)=>{let next=codeblocks.next();return next.done?acc+item:acc+item+next.value[0]},"")},logger17=console,mdx1to2={id:"mdx1to2",async check(){let storiesMdxFiles=await glob("./!(node_modules)**/*.(story|stories).mdx");return storiesMdxFiles.length?{storiesMdxFiles}:void 0},prompt({storiesMdxFiles}){return dedent`
|
|
258
259
|
We've found ${chalk13.yellow(storiesMdxFiles.length)} '.stories.mdx' files in your project.
|
|
259
260
|
|
|
260
261
|
Storybook has upgraded to MDX2 (https://mdxjs.com/blog/v2/), which contains breaking changes from MDX1.
|
|
@@ -264,7 +265,7 @@ To run your Storybook, type:
|
|
|
264
265
|
of the 7.0 migration guide. It contains useful tools for detecting and fixing any remaining issues.
|
|
265
266
|
|
|
266
267
|
${chalk13.cyan("https://storybook.js.org/migration-guides/7.0")}
|
|
267
|
-
`},async run({result:{storiesMdxFiles},dryRun}){await Promise.all([...storiesMdxFiles.map(async fname=>{let contents=await fse__default.readFile(fname,"utf-8"),updated=fixMdxComments(fixMdxStyleTags(contents));updated===contents?
|
|
268
|
+
`},async run({result:{storiesMdxFiles},dryRun}){await Promise.all([...storiesMdxFiles.map(async fname=>{let contents=await fse__default.readFile(fname,"utf-8"),updated=fixMdxComments(fixMdxStyleTags(contents));updated===contents?logger17.info(`\u{1F197} Unmodified ${basename(fname)}`):(logger17.info(`\u2705 Modified ${basename(fname)}`),dryRun||await fse__default.writeFile(fname,updated));})]);}};var logger18=console,autodocsTrue={id:"autodocsTrue",async check({packageManager,configDir}){let{mainConfig}=await getStorybookData({packageManager,configDir}),{docs}=mainConfig,docsPageToAutodocsMapping={true:"tag",automatic:!0,false:!1};if(docs?.docsPage){let oldValue=docs?.docsPage.toString();if(!(oldValue in docsPageToAutodocsMapping))throw new Error(`Unexpected value for docs.docsPage: ${oldValue}`);return {value:docsPageToAutodocsMapping[oldValue]}}return docs?.autodocs===void 0?{value:!0}:null},prompt({value}){let autodocsFormatted=chalk13.cyan(`docs: { autodocs: ${JSON.stringify(value??!0)} }`),tagWarning=dedent`
|
|
268
269
|
NOTE: if you're upgrading from an older 7.0-beta using the 'docsPage' tag,
|
|
269
270
|
please update your story files to use the 'autodocs' tag instead.
|
|
270
271
|
`;return value?dedent`
|
|
@@ -286,7 +287,7 @@ To run your Storybook, type:
|
|
|
286
287
|
${autodocsFormatted}
|
|
287
288
|
|
|
288
289
|
More info: ${chalk13.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#autodocs-changes")}
|
|
289
|
-
`},async run({result:{value},dryRun,mainConfigPath}){
|
|
290
|
+
`},async run({result:{value},dryRun,mainConfigPath}){logger18.info("\u2705 Setting 'docs.autodocs' to true in main.js"),dryRun||await updateMainConfig({mainConfigPath,dryRun},async main=>{main.removeField(["docs","docsPage"]),main.setFieldValue(["docs","autodocs"],value??!0);});}};var addReact={id:"addReact",async check({packageManager}){let packageJson=await packageManager.retrievePackageJson(),installedDependencies=new Set(Object.keys({...packageJson.dependencies,...packageJson.devDependencies})),dependents=["@storybook/addon-essentials","@storybook/addon-docs"].filter(pkg2=>installedDependencies.has(pkg2)),additionalDependencies=[];return dependents.length>0&&(installedDependencies.has("react")||additionalDependencies.push("react"),installedDependencies.has("react-dom")||additionalDependencies.push("react-dom")),additionalDependencies.length>0?{dependents,additionalDependencies}:null},prompt({dependents,additionalDependencies}){let dependentsFormatted=dependents.map(pkg2=>chalk13.cyan(pkg2)).join(" & "),additionalDependenciesFormatted=additionalDependencies.map(pkg2=>`- ${chalk13.cyan(pkg2)}`).join(`
|
|
290
291
|
`);return dedent`
|
|
291
292
|
We've detected that you're using ${dependentsFormatted}.
|
|
292
293
|
|
|
@@ -304,7 +305,7 @@ To run your Storybook, type:
|
|
|
304
305
|
|
|
305
306
|
Please see the migration guide for more information:
|
|
306
307
|
${chalk13.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-support-for-node-15-and-below")}
|
|
307
|
-
`}};var
|
|
308
|
+
`}};var logger19=console,frameworksThatNeedBabelConfig=["@storybook/react-webpack5","@storybook/vue-webpack5","@storybook/vue3-webpack5","@storybook/html-webpack5","@storybook/web-components-webpack5"],missingBabelRc={id:"missing-babelrc",async check({configDir,packageManager}){let packageJson=await packageManager.retrievePackageJson(),{mainConfig,storybookVersion}=await getStorybookData({configDir,packageManager});if(!semver.gte(storybookVersion,"7.0.0"))return null;let{framework,addons}=mainConfig,frameworkPackage=typeof framework=="string"?framework:framework.name,hasCraPreset=addons&&addons.find(addon=>addon==="@storybook/preset-create-react-app");if(frameworkPackage&&frameworksThatNeedBabelConfig.includes(frameworkPackage)&&!hasCraPreset){let config=await loadPartialConfigAsync({babelrc:!0,filename:"__fake__.js"});if(!config.config&&!config.babelrc&&!packageJson.babel)return {needsBabelRc:!0}}return null},prompt(){return dedent18`
|
|
308
309
|
We detected that your project does not have a babel configuration (.babelrc, babel.config.js, etc.).
|
|
309
310
|
|
|
310
311
|
In version 6.x, Storybook provided its own babel settings out of the box. Now, Storybook re-uses ${chalk13.bold("your project's babel configuration")}, with small, incremental updates from Storybook addons.
|
|
@@ -318,7 +319,7 @@ To run your Storybook, type:
|
|
|
318
319
|
|
|
319
320
|
Please see the migration guide for more information:
|
|
320
321
|
${chalk13.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#babel-mode-v7-exclusively")}
|
|
321
|
-
`},async run(){
|
|
322
|
+
`},async run(){logger19.info(),await generateStorybookBabelConfigInCWD();}};var angularBuilders={id:"angular-builders",async check({packageManager,configDir}){let packageJSON=await packageManager.retrievePackageJson();if(isNxProject(packageJSON))return null;let angularVersion=(await packageManager.getAllDependencies())["@angular/core"],angularCoerced=semver.coerce(angularVersion)?.version;if(!angularCoerced)return null;if(semver.lt(angularCoerced,"14.0.0"))throw new Error(dedent`
|
|
322
323
|
❌ Your project uses Angular < 14.0.0. Storybook 7.0 for Angular requires Angular 14.0.0 or higher.
|
|
323
324
|
Please upgrade your Angular version to at least version 14.0.0 to use Storybook 7.0 in your project.
|
|
324
325
|
`);let angularJSON=new AngularJSON,{hasStorybookBuilder}=angularJSON;if(hasStorybookBuilder||!angularJSON.rootProject&&Object.keys(angularJSON.projects).length>1)return null;let{mainConfig}=await getStorybookData({configDir,packageManager});return {mainConfig,packageManager}},prompt(){return dedent`
|
|
@@ -360,13 +361,13 @@ ${error}`).join(`
|
|
|
360
361
|
And reach out on Discord if you need help: ${chalk13.yellow("https://discord.gg/storybook")}
|
|
361
362
|
`),installationMetadata?.duplicatedDependencies&&Object.keys(installationMetadata.duplicatedDependencies).length>0&&messages.push(getWarnings(installationMetadata).join(messageDivider));let hasNoFixes=Object.values(fixResults).every(r=>r==="unnecessary"),hasFailures=Object.values(fixResults).some(r=>r==="failed"||r==="check_failed"),title=hasNoFixes?"No migrations were applicable to your project":hasFailures?"Migration check ran with failures":"Migration check ran successfully";return boxen3(messages.filter(Boolean).join(segmentDivider),{borderStyle:"round",padding:1,title,borderColor:hasFailures?"red":"green"})}var allowList=["@storybook/csf","@storybook/addons","@storybook/channel-postmessage","@storybook/channel-websocket","@storybook/channels","@storybook/client-api","@storybook/client-logger","@storybook/core-client","@storybook/core-events","@storybook/preview-web","@storybook/preview-api","@storybook/store","@storybook/components","@storybook/router","@storybook/theming","@storybook/api","@storybook/manager-api"],disallowList=[Object.keys(rendererPackages),Object.keys(frameworkPackages),"@storybook/instrumenter"];function getWarnings(installationMetadata){let messages=[],{critical,trivial}=Object.entries(installationMetadata?.duplicatedDependencies).reduce((acc,[dep,versions])=>{if(allowList.includes(dep))return acc;let hasMultipleMajorVersions=hasMultipleVersions(versions);return disallowList.includes(dep)&&hasMultipleMajorVersions?acc.critical.push(`${chalk13.redBright(dep)}:
|
|
362
363
|
${versions.join(", ")}`):acc.trivial.push(`${chalk13.hex("#ff9800")(dep)}:
|
|
363
|
-
${versions.join(", ")}`),acc},{critical:[],trivial:[]});return critical.length>0&&(messages.push(`${chalk13.bold("Critical:")} The following dependencies are duplicated and WILL cause unexpected behavior:`),messages.push(critical.join(messageDivider))),trivial.length>0&&(messages.push(`${chalk13.bold("Attention:")} The following dependencies are duplicated which might cause unexpected behavior:`),messages.push(trivial.join(messageDivider))),messages.push(`You can find more information for a given dependency by running ${chalk13.cyan(`${installationMetadata.infoCommand} <package-name>`)}`),messages}var
|
|
364
|
-
The following migrations are available: ${availableFixes}`);},automigrate=async({fixId,fixes:inputFixes,dryRun,yes,useNpm,packageManager:pkgMgr,list,configDir:userSpecifiedConfigDir,renderer:rendererPackage,skipInstall,hideMigrationSummary=!1}={})=>{if(list)return logAvailableMigrations(),null;let selectedFixes=inputFixes||allFixes,fixes=fixId?selectedFixes.filter(f=>f.id===fixId):selectedFixes;if(fixId&&fixes.length===0)return
|
|
364
|
+
${versions.join(", ")}`),acc},{critical:[],trivial:[]});return critical.length>0&&(messages.push(`${chalk13.bold("Critical:")} The following dependencies are duplicated and WILL cause unexpected behavior:`),messages.push(critical.join(messageDivider))),trivial.length>0&&(messages.push(`${chalk13.bold("Attention:")} The following dependencies are duplicated which might cause unexpected behavior:`),messages.push(trivial.join(messageDivider))),messages.push(`You can find more information for a given dependency by running ${chalk13.cyan(`${installationMetadata.infoCommand} <package-name>`)}`),messages}var logger20=console,LOG_FILE_NAME="migration-storybook.log",LOG_FILE_PATH=join(process.cwd(),LOG_FILE_NAME),TEMP_LOG_FILE_PATH="",originalStdOutWrite=process.stdout.write.bind(process.stdout),originalStdErrWrite=process.stderr.write.bind(process.stdout),augmentLogsToFile=()=>{TEMP_LOG_FILE_PATH=tempy.file({name:LOG_FILE_NAME});let logStream=createWriteStream(TEMP_LOG_FILE_PATH);process.stdout.write=d=>(originalStdOutWrite(d),logStream.write(cleanLog(d))),process.stderr.write=d=>logStream.write(cleanLog(d));},cleanup=()=>{process.stdout.write=originalStdOutWrite,process.stderr.write=originalStdErrWrite;},logAvailableMigrations=()=>{let availableFixes=allFixes.map(f=>chalk13.yellow(f.id)).join(", ");logger20.info(`
|
|
365
|
+
The following migrations are available: ${availableFixes}`);},automigrate=async({fixId,fixes:inputFixes,dryRun,yes,useNpm,packageManager:pkgMgr,list,configDir:userSpecifiedConfigDir,renderer:rendererPackage,skipInstall,hideMigrationSummary=!1}={})=>{if(list)return logAvailableMigrations(),null;let selectedFixes=inputFixes||allFixes,fixes=fixId?selectedFixes.filter(f=>f.id===fixId):selectedFixes;if(fixId&&fixes.length===0)return logger20.info(`\u{1F4ED} No migrations found for ${chalk13.magenta(fixId)}.`),logAvailableMigrations(),null;augmentLogsToFile(),logger20.info("\u{1F50E} checking possible migrations..");let{fixResults,fixSummary,preCheckFailure}=await runFixes({fixes,useNpm,pkgMgr,userSpecifiedConfigDir,rendererPackage,skipInstall,dryRun,yes});if(Object.values(fixResults).some(r=>r==="failed"||r==="check_failed")?await move(TEMP_LOG_FILE_PATH,join(process.cwd(),LOG_FILE_NAME),{overwrite:!0}):await remove(TEMP_LOG_FILE_PATH),!hideMigrationSummary){let installationMetadata=await JsPackageManagerFactory.getPackageManager({force:pkgMgr}).findInstallations(["@storybook/*","storybook"]);logger20.info(),logger20.info(getMigrationSummary({fixResults,fixSummary,logFile:LOG_FILE_PATH,installationMetadata})),logger20.info();}return cleanup(),{fixResults,preCheckFailure}};async function runFixes({fixes,dryRun,yes,useNpm,pkgMgr,userSpecifiedConfigDir,rendererPackage,skipInstall}){useNpm&&(useNpmWarning(),pkgMgr="npm");let packageManager=JsPackageManagerFactory.getPackageManager({force:pkgMgr}),fixResults={},fixSummary={succeeded:[],failed:{},manual:[],skipped:[]},{configDir:inferredConfigDir,mainConfig:mainConfigPath,version:storybookVersion}=getStorybookInfo(await packageManager.retrievePackageJson(),userSpecifiedConfigDir);if(!(storybookVersion&&semver.coerce(storybookVersion)?.version))return logger20.info(dedent18`
|
|
365
366
|
[Storybook automigrate] ❌ Unable to determine storybook version so the automigrations will be skipped.
|
|
366
367
|
🤔 Are you running automigrate from your project directory? Please specify your Storybook config directory with the --config-dir flag.
|
|
367
|
-
`),{fixResults,fixSummary,preCheckFailure:"undetected_sb_version"};let configDir=userSpecifiedConfigDir||inferredConfigDir||".storybook";try{await loadMainConfig({configDir});}catch(err){return err.message.includes("No configuration files have been found")?(
|
|
368
|
-
${error.stack}`),fixSummary.failed[f.id]=error.message,fixResults[f.id]="check_failed";}if(result){
|
|
369
|
-
\u{1F50E} found a '${chalk13.cyan(f.id)}' migration:`);let message=f.prompt(result);
|
|
368
|
+
`),{fixResults,fixSummary,preCheckFailure:"undetected_sb_version"};let configDir=userSpecifiedConfigDir||inferredConfigDir||".storybook";try{await loadMainConfig({configDir});}catch(err){return err.message.includes("No configuration files have been found")?(logger20.info(dedent18`[Storybook automigrate] Could not find or evaluate your Storybook main.js config directory at ${chalk13.blue(configDir)} so the automigrations will be skipped. You might be running this command in a monorepo or a non-standard project structure. If that is the case, please rerun this command by specifying the path to your Storybook config directory via the --config-dir option.`),{fixResults,fixSummary,preCheckFailure:"mainjs_not_found"}):(logger20.info(dedent18`[Storybook automigrate] ❌ Failed trying to evaluate ${chalk13.blue(mainConfigPath)} with the following error: ${err.message}`),logger20.info("Please fix the error and try again."),{fixResults,fixSummary,preCheckFailure:"mainjs_evaluation_error"})}for(let i=0;i<fixes.length;i+=1){let f=fixes[i],result;try{result=await f.check({packageManager,configDir,rendererPackage});}catch(error){logger20.info(`\u26A0\uFE0F failed to check fix ${chalk13.bold(f.id)}`),logger20.error(`
|
|
369
|
+
${error.stack}`),fixSummary.failed[f.id]=error.message,fixResults[f.id]="check_failed";}if(result){logger20.info(`
|
|
370
|
+
\u{1F50E} found a '${chalk13.cyan(f.id)}' migration:`);let message=f.prompt(result);logger20.info(boxen3(message,{borderStyle:"round",padding:1,borderColor:"#F1618C",title:f.promptOnly?"Manual migration detected":"Automigration detected"}));let runAnswer;try{if(dryRun)runAnswer={fix:!1};else if(yes)runAnswer={fix:!0},f.promptOnly&&(fixResults[f.id]="manual_succeeded",fixSummary.manual.push(f.id));else if(f.promptOnly){fixResults[f.id]="manual_succeeded",fixSummary.manual.push(f.id),logger20.info();let{shouldContinue}=await prompts5({type:"toggle",name:"shouldContinue",message:"Select continue once you have made the required changes, or quit to exit the migration process",initial:!0,active:"continue",inactive:"quit"},{onCancel:()=>{throw new Error}});if(!shouldContinue){fixResults[f.id]="manual_skipped";break}}else runAnswer=await prompts5({type:"confirm",name:"fix",message:`Do you want to run the '${chalk13.cyan(f.id)}' migration on your project?`,initial:!0},{onCancel:()=>{throw new Error}});}catch{break}if(!f.promptOnly)if(runAnswer.fix)try{await f.run({result,packageManager,dryRun,mainConfigPath,skipInstall}),logger20.info(`\u2705 ran ${chalk13.cyan(f.id)} migration`),fixResults[f.id]="succeeded",fixSummary.succeeded.push(f.id);}catch(error){fixResults[f.id]="failed",fixSummary.failed[f.id]=error.message,logger20.info(`\u274C error when running ${chalk13.cyan(f.id)} migration`),logger20.info(error),logger20.info();}else fixResults[f.id]="skipped",fixSummary.skipped.push(f.id);}else fixResults[f.id]=fixResults[f.id]||"unnecessary";}return {fixResults,fixSummary}}var logger21=console,getNextGlob=glob2=>{let extGlobsRegex=new RegExp(/(.*\.)(stories\.@.*)(\|mdx|mdx\|)(.*)$/i);if(glob2.match(extGlobsRegex))return glob2.replace(extGlobsRegex,"$1@(mdx|$2$4)");let allStoriesExtensionsRegex=new RegExp(/(.*\.)(stories\.\*)$/i);return glob2.match(allStoriesExtensionsRegex)?glob2.replace(allStoriesExtensionsRegex,"$1@(mdx|$2)"):glob2.replaceAll(".stories.mdx",".mdx")},bareMdxStoriesGlob={id:"bare-mdx-stories-glob",async check({packageManager,configDir}){let{storybookVersion,mainConfig}=await getStorybookData({configDir,packageManager});if(!semver.gte(storybookVersion,"7.0.0"))return null;let existingStoriesEntries=mainConfig.stories;if(!existingStoriesEntries)throw new Error(dedent18`
|
|
370
371
|
❌ Unable to determine Storybook stories globs in ${chalk13.blue(mainConfig)}, skipping ${chalk13.cyan(this.id)} fix.
|
|
371
372
|
|
|
372
373
|
In Storybook 7, we have deprecated defining stories in MDX files, and consequently have changed the suffix to simply .mdx.
|
|
@@ -388,12 +389,12 @@ ${error.stack}`),fixSummary.failed[f.id]=error.message,fixResults[f.id]="check_f
|
|
|
388
389
|
${chalk13.cyan(prettyNextStoriesEntries)}
|
|
389
390
|
|
|
390
391
|
To learn more about this change, see: ${chalk13.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#mdx-docs-files")}
|
|
391
|
-
`},async run({dryRun,mainConfigPath,result:{nextStoriesEntries}}){
|
|
392
|
-
${JSON.stringify(nextStoriesEntries,null,2)}`),dryRun||await updateMainConfig({mainConfigPath,dryRun},async main=>{main.setFieldValue(["stories"],nextStoriesEntries);});}};var
|
|
392
|
+
`},async run({dryRun,mainConfigPath,result:{nextStoriesEntries}}){logger21.info(dedent18`✅ Setting 'stories' config:
|
|
393
|
+
${JSON.stringify(nextStoriesEntries,null,2)}`),dryRun||await updateMainConfig({mainConfigPath,dryRun},async main=>{main.setFieldValue(["stories"],nextStoriesEntries);});}};var logger22=console;async function migrate(migration,{glob:glob2,dryRun,list,rename,parser}){if(list)listCodemods().forEach(key=>logger22.log(key));else if(migration)migration==="mdx-to-csf"&&!dryRun&&(await runFixes({fixes:[bareMdxStoriesGlob]}),await addStorybookBlocksPackage()),await runCodemod(migration,{glob:glob2,dryRun,logger:logger22,rename,parser});else throw new Error("Migrate: please specify a migration name or --list")}async function addStorybookBlocksPackage(){let packageManager=JsPackageManagerFactory.getPackageManager(),packageJson=await packageManager.retrievePackageJson(),versionToInstall=getStorybookVersionSpecifier(await packageManager.retrievePackageJson());logger22.info('\u2705 Adding "@storybook/blocks" package'),await packageManager.addDependencies({installAsDevDependencies:!0,packageJson},[`@storybook/blocks@${versionToInstall}`]);}var read=async url=>{let browser=await usePuppeteerBrowser(),page=await browser.newPage();await page.goto(url),await page.waitForFunction(`
|
|
393
394
|
(window.__STORYBOOK_PREVIEW__ && window.__STORYBOOK_PREVIEW__.extract && window.__STORYBOOK_PREVIEW__.extract()) ||
|
|
394
395
|
(window.__STORYBOOK_STORY_STORE__ && window.__STORYBOOK_STORY_STORE__.extract && window.__STORYBOOK_STORY_STORE__.extract())
|
|
395
396
|
`);let data=JSON.parse(await page.evaluate(async()=>JSON.stringify(window.__STORYBOOK_STORY_STORE__.getStoriesJsonData(),null,2)));return setImmediate(()=>{browser.close();}),data},useLocation=async input=>{if(await stat(path9.resolve(input)),input.match(/^http/))return [input,async()=>{}];let app=express();app.use(express.static(input));let port=await getPort();return new Promise(resolve2=>{let server=app.listen(port,()=>{let result=`http://localhost:${port}/iframe.html`;logger.info(`connecting to: ${result}`),resolve2([result,server.close.bind(server)]);});})},usePuppeteerBrowser=async()=>{let args=["--no-sandbox ","--disable-setuid-sandbox"];try{return await puppeteerCore.launch({args,executablePath:process.env.SB_CHROMIUM_PATH})}catch{return logger.info("installing puppeteer..."),new Promise((resolve2,reject)=>{__require("child_process").exec(`node ${__require.resolve(path9.join("puppeteer-core","install.js"))}`,error=>error?reject(error):resolve2(puppeteerCore.launch({args})));})}};async function extract(input,targetPath){if(input&&targetPath){let[location,exit]=await useLocation(input),data=await read(location);await writeFile(targetPath,JSON.stringify(data,null,2)),await exit();}else throw new Error("Extract: please specify a path where your built-storybook is (can be a public url) and a target directory")}var versionRegex=/(@storybook\/[^@]+)@(\S+)/,getStorybookVersion=line=>{if(line.startsWith("npm "))return null;let match=versionRegex.exec(line);return !match||!semver.clean(match[2])?null:{package:match[1],version:match[2]}},excludeList=["@storybook/addon-bench","@storybook/addon-console","@storybook/addon-postcss","@storybook/babel-plugin-require-context-hook","@storybook/bench","@storybook/builder-vite","@storybook/csf","@storybook/design-system","@storybook/ember-cli-storybook","@storybook/eslint-config-storybook","@storybook/expect","@storybook/jest","@storybook/linter-config","@storybook/mdx1-csf","@storybook/mdx2-csf","@storybook/react-docgen-typescript-plugin","@storybook/storybook-deployer","@storybook/test-runner","@storybook/testing-library","@storybook/testing-react"],isCorePackage=pkg2=>pkg2.startsWith("@storybook/")&&!pkg2.startsWith("@storybook/preset-")&&!excludeList.includes(pkg2),deprecatedPackages=[{minVersion:"6.0.0-alpha.0",url:"https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#60-deprecations",deprecations:["@storybook/addon-notes","@storybook/addon-info","@storybook/addon-contexts","@storybook/addon-options","@storybook/addon-centered"]}],formatPackage=pkg2=>`${pkg2.package}@${pkg2.version}`,warnPackages=pkgs=>pkgs.forEach(pkg2=>logger.warn(`- ${formatPackage(pkg2)}`)),checkVersionConsistency=()=>{let storybookPackages=sync$1("npm",["ls"],{stdio:"pipe",shell:!0}).output.toString().split(`
|
|
396
|
-
`).map(getStorybookVersion).filter(Boolean).filter(pkg2=>isCorePackage(pkg2.package));if(!storybookPackages.length){logger.warn("No storybook core packages found."),logger.warn("'npm ls | grep storybook' can show if multiple versions are installed.");return}storybookPackages.sort((a,b)=>semver.rcompare(a.version,b.version));let latestVersion=storybookPackages[0].version,outdated=storybookPackages.filter(pkg2=>pkg2.version!==latestVersion);outdated.length>0&&(logger.warn(`Found ${outdated.length} outdated packages (relative to '${formatPackage(storybookPackages[0])}')`),logger.warn("Please make sure your packages are updated to ensure a consistent experience."),warnPackages(outdated)),deprecatedPackages.forEach(({minVersion,url,deprecations})=>{if(semver.gte(latestVersion,minVersion)){let deprecated=storybookPackages.filter(pkg2=>deprecations.includes(pkg2.package));deprecated.length>0&&(logger.warn(`Found ${deprecated.length} deprecated packages since ${minVersion}`),logger.warn(`See ${url}`),warnPackages(deprecated));}});},EXTRA_FLAGS={"react-scripts@<5":["--reject","/preset-create-react-app/"]},addExtraFlags=(extraFlags,flags,{dependencies,devDependencies})=>Object.entries(extraFlags).reduce((acc,entry)=>{let[pattern,extra]=entry,[pkg2,specifier]=getPackageDetails(pattern),pkgVersion=dependencies[pkg2]||devDependencies[pkg2];return pkgVersion&&semver.satisfies(semver.coerce(pkgVersion),specifier)?[...acc,...extra]:acc},[...flags]),doUpgrade=async({tag,prerelease,skipCheck,useNpm,packageManager:pkgMgr,dryRun,configDir,yes,...options})=>{useNpm&&(useNpmWarning(),pkgMgr="npm");let packageManager=JsPackageManagerFactory.getPackageManager({force:pkgMgr}),beforeVersion=await getStorybookCoreVersion();if(commandLog("Checking for latest versions of '@storybook/*' packages"),tag&&prerelease)throw new Error("Cannot set both --tag and --prerelease. Use --tag next to get the latest prereleae");let target="latest";prerelease?target="@next":tag&&(target=`@${tag}`);let flags=[];dryRun||flags.push("--upgrade"),flags.push("--target"),flags.push(target),flags=addExtraFlags(EXTRA_FLAGS,flags,await packageManager.retrievePackageJson());let check=sync$1("npx",["npm-check-updates@latest","/storybook/",...flags],{stdio:"pipe",shell:!0}).output.toString();logger.info(check);let checkSb=sync$1("npx",["npm-check-updates@latest","sb",...flags],{stdio:"pipe",shell:!0}).output.toString();logger.info(checkSb),dryRun||(commandLog("Installing upgrades"),await packageManager.installDependencies());let automigrationResults;if(skipCheck||(checkVersionConsistency(),automigrationResults=await automigrate({dryRun,yes,packageManager:pkgMgr,configDir})),!options.disableTelemetry){let afterVersion=await getStorybookCoreVersion(),{preCheckFailure,fixResults}=automigrationResults||{};telemetry("upgrade",{prerelease,tag,beforeVersion,afterVersion,...{automigrationResults:preCheckFailure?null:fixResults,automigrationPreCheckFailure:preCheckFailure||null}});}};async function upgrade(options){await withTelemetry("upgrade",{cliOptions:options},()=>doUpgrade(options));}var baseTemplates={"cra/default-js":{name:"Create React App (Javascript)",script:"npx create-react-app .",expected:{framework:"@storybook/react-webpack5",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"cra/default-ts":{name:"Create React App (Typescript)",script:"npx create-react-app . --template typescript",skipTasks:["smoke-test"],expected:{framework:"@storybook/react-webpack5",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"}},"nextjs/12-js":{name:"Next.js v12 (JavaScript)",script:'yarn create next-app {{beforeDir}} -e https://github.com/vercel/next.js/tree/next-12-3-2/examples/hello-world && cd {{beforeDir}} && npm pkg set "dependencies.next"="^12.2.0" && yarn && git add . && git commit --amend --no-edit && cd ..',expected:{framework:"@storybook/nextjs",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"nextjs/default-js":{name:"Next.js (JavaScript)",script:"yarn create next-app {{beforeDir}} --javascript --eslint",expected:{framework:"@storybook/nextjs",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"nextjs/default-ts":{name:"Next.js (TypeScript)",script:"yarn create next-app {{beforeDir}} --typescript --eslint",expected:{framework:"@storybook/nextjs",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"react-vite/default-js":{name:"React Vite (JS)",script:"npm create vite@latest --yes . -- --template react",expected:{framework:"@storybook/react-vite",renderer:"@storybook/react",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"react-vite/default-ts":{name:"React Vite (TS)",script:"npm create vite@latest --yes . -- --template react-ts",expected:{framework:"@storybook/react-vite",renderer:"@storybook/react",builder:"@storybook/builder-vite"}},"react-webpack/18-ts":{name:"React 18 Webpack5 (TS)",script:"yarn create webpack5-react .",expected:{framework:"@storybook/react-webpack5",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"react-webpack/17-ts":{name:"React 17 Webpack5 (TS)",script:'yarn create webpack5-react . --version-react="17" --version-react-dom="17"',expected:{framework:"@storybook/react-webpack5",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"solid-vite/default-js":{name:"SolidJS Vite (JS)",script:"npx degit solidjs/templates/js .",expected:{framework:"storybook-solidjs-vite",renderer:"storybook-solidjs",builder:"@storybook/builder-vite"},inDevelopment:!0,skipTasks:["e2e-tests-dev"]},"solid-vite/default-ts":{name:"SolidJS Vite (TS)",script:"npx degit solidjs/templates/ts .",expected:{framework:"storybook-solidjs-vite",renderer:"storybook-solidjs",builder:"@storybook/builder-vite"},inDevelopment:!0,skipTasks:["e2e-tests-dev"]},"vue3-vite/default-js":{name:"Vue3 Vite (JS)",script:"npm create vite@latest --yes . -- --template vue",expected:{framework:"@storybook/vue3-vite",renderer:"@storybook/vue3",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"vue3-vite/default-ts":{name:"Vue3 Vite (TS)",script:"npm create vite@latest --yes . -- --template vue-ts",expected:{framework:"@storybook/vue3-vite",renderer:"@storybook/vue3",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"vue2-vite/2.7-js":{name:"Vue2 Vite (vue 2.7 JS)",script:"npx create-vue@2 {{beforeDir}} --default",expected:{framework:"@storybook/vue-vite",renderer:"@storybook/vue",builder:"@storybook/builder-vite"},skipTasks:["smoke-test","e2e-tests-dev"]},"html-webpack/default":{name:"HTML Webpack5",script:"yarn create webpack5-html .",expected:{framework:"@storybook/html-webpack5",renderer:"@storybook/html",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"html-vite/default-js":{name:"HTML Vite JS",script:'npm create vite@latest --yes . -- --template vanilla && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/html-vite",renderer:"@storybook/html",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"html-vite/default-ts":{name:"HTML Vite TS",script:'npm create vite@latest --yes . -- --template vanilla-ts && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/html-vite",renderer:"@storybook/html",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"svelte-vite/default-js":{name:"Svelte Vite (JS)",script:"npm create vite@latest --yes . -- --template svelte",expected:{framework:"@storybook/svelte-vite",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"svelte-vite/default-ts":{name:"Svelte Vite (TS)",script:"npm create vite@latest --yes . -- --template svelte-ts",expected:{framework:"@storybook/svelte-vite",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"},skipTasks:["smoke-test","e2e-tests-dev"]},"angular-cli/prerelease":{name:"Angular CLI (Prerelease)",script:"npx -p @angular/cli@next ng new angular-v16 --directory . --routing=true --minimal=true --style=scss --strict --skip-git --skip-install --package-manager=yarn",expected:{framework:"@storybook/angular",renderer:"@storybook/angular",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"angular-cli/default-ts":{name:"Angular CLI (latest)",script:"npx -p @angular/cli ng new angular-latest --directory . --routing=true --minimal=true --style=scss --strict --skip-git --skip-install --package-manager=yarn",expected:{framework:"@storybook/angular",renderer:"@storybook/angular",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"angular-cli/14-ts":{name:"Angular CLI (Version 14)",script:"npx -p @angular/cli@14 ng new angular-v14 --directory . --routing=true --minimal=true --style=scss --strict --skip-git --skip-install --package-manager=yarn",expected:{framework:"@storybook/angular",renderer:"@storybook/angular",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"svelte-kit/skeleton-js":{name:"Svelte Kit (JS)",script:"yarn create svelte-with-args --name=svelte-kit/skeleton-js --directory=. --template=skeleton --types=null --no-prettier --no-eslint --no-playwright --no-vitest",expected:{framework:"@storybook/sveltekit",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"svelte-kit/skeleton-ts":{name:"Svelte Kit (TS)",script:"yarn create svelte-with-args --name=svelte-kit/skeleton-ts --directory=. --template=skeleton --types=typescript --no-prettier --no-eslint --no-playwright --no-vitest",expected:{framework:"@storybook/sveltekit",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"lit-vite/default-js":{name:"Lit Vite (JS)",script:'npm create vite@latest --yes . -- --template lit && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/web-components-vite",renderer:"@storybook/web-components",builder:"@storybook/builder-vite"},skipTasks:["smoke-test","e2e-tests-dev"]},"lit-vite/default-ts":{name:"Lit Vite (TS)",script:'npm create vite@latest --yes . -- --template lit-ts && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/web-components-vite",renderer:"@storybook/web-components",builder:"@storybook/builder-vite"},skipTasks:["smoke-test","e2e-tests-dev"]},"vue-cli/default-js":{name:"Vue-CLI (Default JS)",script:'npx -p @vue/cli vue create . --default --packageManager=yarn --force --merge && echo "module.exports = {}" > webpack.config.js',expected:{framework:"@storybook/vue3-webpack5",renderer:"@storybook/vue3",builder:"@storybook/builder-webpack5"},skipTasks:["smoke-test","e2e-tests-dev"]},"vue-cli/vue2-default-js":{name:"Vue-CLI (Vue2 JS)",script:'npx -p @vue/cli vue create . --default --packageManager=yarn --force --merge --preset="Default (Vue 2)" && echo "module.exports = {}" > webpack.config.js',expected:{framework:"@storybook/vue-webpack5",renderer:"@storybook/vue",builder:"@storybook/builder-webpack5"},skipTasks:["smoke-test","e2e-tests-dev"]},"preact-webpack5/default-js":{name:"Preact CLI (Default JS)",script:'npx preact-cli create default {{beforeDir}} --name preact-app --yarn --no-install && echo "module.exports = {}" > webpack.config.js',expected:{framework:"@storybook/preact-webpack5",renderer:"@storybook/preact",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"preact-webpack5/default-ts":{name:"Preact CLI (Default TS)",script:'npx preact-cli create typescript {{beforeDir}} --name preact-app --yarn --no-install && echo "module.exports = {}" > webpack.config.js',expected:{framework:"@storybook/preact-webpack5",renderer:"@storybook/preact",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"preact-vite/default-js":{name:"Preact Vite (JS)",script:"npm create vite@latest --yes . -- --template preact",expected:{framework:"@storybook/preact-vite",renderer:"@storybook/preact",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"preact-vite/default-ts":{name:"Preact Vite (TS)",script:"npm create vite@latest --yes . -- --template preact-ts",expected:{framework:"@storybook/preact-vite",renderer:"@storybook/preact",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"qwik-vite/default-ts":{name:"Qwik CLI (Default TS)",script:"yarn create qwik basic {{beforeDir}} --no-install",inDevelopment:!0,expected:{framework:"storybook-framework-qwik",renderer:"storybook-framework-qwik",builder:"storybook-framework-qwik"},skipTasks:["e2e-tests","e2e-tests-dev"]}},internalTemplates={"internal/ssv6-vite":{...baseTemplates["react-vite/default-ts"],name:"StoryStore v6 (react-vite/default-ts)",isInternal:!0,modifications:{mainConfig:{features:{storyStoreV7:!1,storyStoreV7MdxErrors:!1}}}},"internal/ssv6-webpack":{...baseTemplates["cra/default-ts"],name:"StoryStore v6 (cra/default-ts)",isInternal:!0,modifications:{mainConfig:{features:{storyStoreV7:!1,storyStoreV7MdxErrors:!1}}}},"internal/server-webpack5":{name:"Server Webpack5",script:"yarn init -y",expected:{framework:"@storybook/server-webpack5",renderer:"@storybook/server",builder:"@storybook/builder-webpack5"},isInternal:!0,inDevelopment:!0}},allTemplates={...baseTemplates,...internalTemplates};var logger24=console,toChoices=c=>({title:allTemplates[c].name,value:c}),sandbox=async({output:outputDirectory,filterValue,branch,init})=>{let selectedConfig=allTemplates[filterValue],selectedTemplate=selectedConfig?filterValue:null;if(!selectedConfig){let filterRegex=new RegExp(`^${filterValue||""}`,"i"),keys=Object.keys(allTemplates),choices=keys.reduce((acc,group)=>{let current=allTemplates[group];return (!filterValue||current.name.match(filterRegex)||group.match(filterRegex)||current.expected.builder.match(filterRegex)||current.expected.framework.match(filterRegex)||current.expected.renderer.match(filterRegex))&&acc.push(group),acc},[]);if(choices.length===0&&(logger24.info(boxen3(dedent`
|
|
397
|
+
`).map(getStorybookVersion).filter(Boolean).filter(pkg2=>isCorePackage(pkg2.package));if(!storybookPackages.length){logger.warn("No storybook core packages found."),logger.warn("'npm ls | grep storybook' can show if multiple versions are installed.");return}storybookPackages.sort((a,b)=>semver.rcompare(a.version,b.version));let latestVersion=storybookPackages[0].version,outdated=storybookPackages.filter(pkg2=>pkg2.version!==latestVersion);outdated.length>0&&(logger.warn(`Found ${outdated.length} outdated packages (relative to '${formatPackage(storybookPackages[0])}')`),logger.warn("Please make sure your packages are updated to ensure a consistent experience."),warnPackages(outdated)),deprecatedPackages.forEach(({minVersion,url,deprecations})=>{if(semver.gte(latestVersion,minVersion)){let deprecated=storybookPackages.filter(pkg2=>deprecations.includes(pkg2.package));deprecated.length>0&&(logger.warn(`Found ${deprecated.length} deprecated packages since ${minVersion}`),logger.warn(`See ${url}`),warnPackages(deprecated));}});},EXTRA_FLAGS={"react-scripts@<5":["--reject","/preset-create-react-app/"]},addExtraFlags=(extraFlags,flags,{dependencies,devDependencies})=>Object.entries(extraFlags).reduce((acc,entry)=>{let[pattern,extra]=entry,[pkg2,specifier]=getPackageDetails(pattern),pkgVersion=dependencies[pkg2]||devDependencies[pkg2];return pkgVersion&&semver.satisfies(semver.coerce(pkgVersion),specifier)?[...acc,...extra]:acc},[...flags]),doUpgrade=async({tag,prerelease,skipCheck,useNpm,packageManager:pkgMgr,dryRun,configDir,yes,...options})=>{useNpm&&(useNpmWarning(),pkgMgr="npm");let packageManager=JsPackageManagerFactory.getPackageManager({force:pkgMgr}),beforeVersion=await getStorybookCoreVersion();if(commandLog("Checking for latest versions of '@storybook/*' packages"),tag&&prerelease)throw new Error("Cannot set both --tag and --prerelease. Use --tag next to get the latest prereleae");let target="latest";prerelease?target="@next":tag&&(target=`@${tag}`);let flags=[];dryRun||flags.push("--upgrade"),flags.push("--target"),flags.push(target),flags=addExtraFlags(EXTRA_FLAGS,flags,await packageManager.retrievePackageJson());let check=sync$1("npx",["npm-check-updates@latest","/storybook/",...flags],{stdio:"pipe",shell:!0}).output.toString();logger.info(check);let checkSb=sync$1("npx",["npm-check-updates@latest","sb",...flags],{stdio:"pipe",shell:!0}).output.toString();logger.info(checkSb),dryRun||(commandLog("Installing upgrades"),await packageManager.installDependencies());let automigrationResults;if(skipCheck||(checkVersionConsistency(),automigrationResults=await automigrate({dryRun,yes,packageManager:pkgMgr,configDir})),!options.disableTelemetry){let afterVersion=await getStorybookCoreVersion(),{preCheckFailure,fixResults}=automigrationResults||{};telemetry("upgrade",{prerelease,tag,beforeVersion,afterVersion,...{automigrationResults:preCheckFailure?null:fixResults,automigrationPreCheckFailure:preCheckFailure||null}});}};async function upgrade(options){await withTelemetry("upgrade",{cliOptions:options},()=>doUpgrade(options));}var baseTemplates={"cra/default-js":{name:"Create React App (Javascript)",script:"npx create-react-app {{beforeDir}}",expected:{framework:"@storybook/react-webpack5",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"cra/default-ts":{name:"Create React App (Typescript)",script:"npx create-react-app {{beforeDir}} --template typescript",skipTasks:["smoke-test"],expected:{framework:"@storybook/react-webpack5",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"}},"nextjs/12-js":{name:"Next.js v12 (JavaScript)",script:'yarn create next-app {{beforeDir}} -e https://github.com/vercel/next.js/tree/next-12-3-2/examples/hello-world && cd {{beforeDir}} && npm pkg set "dependencies.next"="^12.2.0" && yarn && git add . && git commit --amend --no-edit && cd ..',expected:{framework:"@storybook/nextjs",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"nextjs/default-js":{name:"Next.js (JavaScript)",script:"yarn create next-app {{beforeDir}} --javascript --eslint",expected:{framework:"@storybook/nextjs",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"nextjs/default-ts":{name:"Next.js (TypeScript)",script:"yarn create next-app {{beforeDir}} --typescript --eslint",expected:{framework:"@storybook/nextjs",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"react-vite/default-js":{name:"React Vite (JS)",script:"npm create vite@latest --yes {{beforeDir}} -- --template react",expected:{framework:"@storybook/react-vite",renderer:"@storybook/react",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"react-vite/default-ts":{name:"React Vite (TS)",script:"npm create vite@latest --yes {{beforeDir}} -- --template react-ts",expected:{framework:"@storybook/react-vite",renderer:"@storybook/react",builder:"@storybook/builder-vite"}},"react-webpack/18-ts":{name:"React 18 Webpack5 (TS)",script:"yarn create webpack5-react {{beforeDir}}",expected:{framework:"@storybook/react-webpack5",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"react-webpack/17-ts":{name:"React 17 Webpack5 (TS)",script:'yarn create webpack5-react {{beforeDir}} --version-react="17" --version-react-dom="17"',expected:{framework:"@storybook/react-webpack5",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"solid-vite/default-js":{name:"SolidJS Vite (JS)",script:"npx degit solidjs/templates/js {{beforeDir}}",expected:{framework:"storybook-solidjs-vite",renderer:"storybook-solidjs",builder:"@storybook/builder-vite"},inDevelopment:!0,skipTasks:["e2e-tests-dev"]},"solid-vite/default-ts":{name:"SolidJS Vite (TS)",script:"npx degit solidjs/templates/ts {{beforeDir}}",expected:{framework:"storybook-solidjs-vite",renderer:"storybook-solidjs",builder:"@storybook/builder-vite"},inDevelopment:!0,skipTasks:["e2e-tests-dev"]},"vue3-vite/default-js":{name:"Vue3 Vite (JS)",script:"npm create vite@latest --yes {{beforeDir}} -- --template vue",expected:{framework:"@storybook/vue3-vite",renderer:"@storybook/vue3",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"vue3-vite/default-ts":{name:"Vue3 Vite (TS)",script:"npm create vite@latest --yes {{beforeDir}} -- --template vue-ts",expected:{framework:"@storybook/vue3-vite",renderer:"@storybook/vue3",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"vue2-vite/2.7-js":{name:"Vue2 Vite (vue 2.7 JS)",script:"npx create-vue@2 {{beforeDir}} --default",expected:{framework:"@storybook/vue-vite",renderer:"@storybook/vue",builder:"@storybook/builder-vite"},skipTasks:["smoke-test","e2e-tests-dev"]},"html-webpack/default":{name:"HTML Webpack5",script:"yarn create webpack5-html {{beforeDir}}",expected:{framework:"@storybook/html-webpack5",renderer:"@storybook/html",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"html-vite/default-js":{name:"HTML Vite JS",script:'npm create vite@latest --yes {{beforeDir}} -- --template vanilla && cd {{beforeDir}} && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/html-vite",renderer:"@storybook/html",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"html-vite/default-ts":{name:"HTML Vite TS",script:'npm create vite@latest --yes {{beforeDir}} -- --template vanilla-ts && cd {{beforeDir}} && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/html-vite",renderer:"@storybook/html",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"svelte-vite/default-js":{name:"Svelte Vite (JS)",script:"npm create vite@latest --yes {{beforeDir}} -- --template svelte",expected:{framework:"@storybook/svelte-vite",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"svelte-vite/default-ts":{name:"Svelte Vite (TS)",script:"npm create vite@latest --yes {{beforeDir}} -- --template svelte-ts",expected:{framework:"@storybook/svelte-vite",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"},skipTasks:["smoke-test","e2e-tests-dev"]},"angular-cli/prerelease":{name:"Angular CLI (Prerelease)",script:"npx -p @angular/cli@next ng new angular-v16 --directory {{beforeDir}} --routing=true --minimal=true --style=scss --strict --skip-git --skip-install --package-manager=yarn",expected:{framework:"@storybook/angular",renderer:"@storybook/angular",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"angular-cli/default-ts":{name:"Angular CLI (latest)",script:"npx -p @angular/cli ng new angular-latest --directory {{beforeDir}} --routing=true --minimal=true --style=scss --strict --skip-git --skip-install --package-manager=yarn",expected:{framework:"@storybook/angular",renderer:"@storybook/angular",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"angular-cli/14-ts":{name:"Angular CLI (Version 14)",script:"npx -p @angular/cli@14 ng new angular-v14 --directory {{beforeDir}} --routing=true --minimal=true --style=scss --strict --skip-git --skip-install --package-manager=yarn",expected:{framework:"@storybook/angular",renderer:"@storybook/angular",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"svelte-kit/skeleton-js":{name:"Svelte Kit (JS)",script:"yarn create svelte-with-args --name=svelte-kit/skeleton-js --directory={{beforeDir}} --template=skeleton --types=null --no-prettier --no-eslint --no-playwright --no-vitest",expected:{framework:"@storybook/sveltekit",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"svelte-kit/skeleton-ts":{name:"Svelte Kit (TS)",script:"yarn create svelte-with-args --name=svelte-kit/skeleton-ts --directory={{beforeDir}} --template=skeleton --types=typescript --no-prettier --no-eslint --no-playwright --no-vitest",expected:{framework:"@storybook/sveltekit",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"lit-vite/default-js":{name:"Lit Vite (JS)",script:'npm create vite@latest --yes {{beforeDir}} -- --template lit && cd {{beforeDir}} && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/web-components-vite",renderer:"@storybook/web-components",builder:"@storybook/builder-vite"},skipTasks:["smoke-test","e2e-tests-dev"]},"lit-vite/default-ts":{name:"Lit Vite (TS)",script:'npm create vite@latest --yes {{beforeDir}} -- --template lit-ts && cd {{beforeDir}} && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/web-components-vite",renderer:"@storybook/web-components",builder:"@storybook/builder-vite"},skipTasks:["smoke-test","e2e-tests-dev"]},"vue-cli/default-js":{name:"Vue-CLI (Default JS)",script:'npx -p @vue/cli vue create {{beforeDir}} --default --packageManager=yarn --force --merge && cd {{beforeDir}} && echo "module.exports = {}" > webpack.config.js',expected:{framework:"@storybook/vue3-webpack5",renderer:"@storybook/vue3",builder:"@storybook/builder-webpack5"},skipTasks:["smoke-test","e2e-tests-dev"]},"vue-cli/vue2-default-js":{name:"Vue-CLI (Vue2 JS)",script:'npx -p @vue/cli vue create {{beforeDir}} --default --packageManager=yarn --force --merge --preset="Default (Vue 2)" && cd {{beforeDir}} && echo "module.exports = {}" > webpack.config.js',expected:{framework:"@storybook/vue-webpack5",renderer:"@storybook/vue",builder:"@storybook/builder-webpack5"},skipTasks:["smoke-test","e2e-tests-dev"]},"preact-webpack5/default-js":{name:"Preact CLI (Default JS)",script:'npx preact-cli create default {{beforeDir}} --name preact-app --yarn --no-install && cd {{beforeDir}} && echo "module.exports = {}" > webpack.config.js',expected:{framework:"@storybook/preact-webpack5",renderer:"@storybook/preact",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"preact-webpack5/default-ts":{name:"Preact CLI (Default TS)",script:'npx preact-cli create typescript {{beforeDir}} --name preact-app --yarn --no-install && cd {{beforeDir}} && echo "module.exports = {}" > webpack.config.js',expected:{framework:"@storybook/preact-webpack5",renderer:"@storybook/preact",builder:"@storybook/builder-webpack5"},skipTasks:["e2e-tests-dev"]},"preact-vite/default-js":{name:"Preact Vite (JS)",script:"npm create vite@latest --yes {{beforeDir}} -- --template preact",expected:{framework:"@storybook/preact-vite",renderer:"@storybook/preact",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"preact-vite/default-ts":{name:"Preact Vite (TS)",script:"npm create vite@latest --yes {{beforeDir}} -- --template preact-ts",expected:{framework:"@storybook/preact-vite",renderer:"@storybook/preact",builder:"@storybook/builder-vite"},skipTasks:["e2e-tests-dev"]},"qwik-vite/default-ts":{name:"Qwik CLI (Default TS)",script:"yarn create qwik basic {{beforeDir}} --no-install",inDevelopment:!0,expected:{framework:"storybook-framework-qwik",renderer:"storybook-framework-qwik",builder:"storybook-framework-qwik"},skipTasks:["e2e-tests","e2e-tests-dev"]}},internalTemplates={"internal/ssv6-vite":{...baseTemplates["react-vite/default-ts"],name:"StoryStore v6 (react-vite/default-ts)",isInternal:!0,modifications:{mainConfig:{features:{storyStoreV7:!1,storyStoreV7MdxErrors:!1}}}},"internal/ssv6-webpack":{...baseTemplates["cra/default-ts"],name:"StoryStore v6 (cra/default-ts)",isInternal:!0,modifications:{mainConfig:{features:{storyStoreV7:!1,storyStoreV7MdxErrors:!1}}}},"internal/server-webpack5":{name:"Server Webpack5",script:'yarn init -y && echo "module.exports = {}" > webpack.config.js',expected:{framework:"@storybook/server-webpack5",renderer:"@storybook/server",builder:"@storybook/builder-webpack5"},isInternal:!0,inDevelopment:!0}},allTemplates={...baseTemplates,...internalTemplates};var logger25=console,toChoices=c=>({title:allTemplates[c].name,value:c}),sandbox=async({output:outputDirectory,filterValue,branch,init})=>{let selectedConfig=allTemplates[filterValue],selectedTemplate=selectedConfig?filterValue:null;if(!selectedConfig){let filterRegex=new RegExp(`^${filterValue||""}`,"i"),keys=Object.keys(allTemplates),choices=keys.reduce((acc,group)=>{let current=allTemplates[group];return (!filterValue||current.name.match(filterRegex)||group.match(filterRegex)||current.expected.builder.match(filterRegex)||current.expected.framework.match(filterRegex)||current.expected.renderer.match(filterRegex))&&acc.push(group),acc},[]);if(choices.length===0&&(logger25.info(boxen3(dedent`
|
|
397
398
|
🔎 You filtered out all templates. 🔍
|
|
398
399
|
|
|
399
400
|
After filtering all the templates with "${chalk13.yellow(filterValue)}", we found no results. Please try again with a different filter.
|
|
@@ -401,7 +402,7 @@ ${error.stack}`),fixSummary.failed[f.id]=error.message,fixResults[f.id]="check_f
|
|
|
401
402
|
Available templates:
|
|
402
403
|
${keys.map(key=>chalk13.blue`- ${key}`).join(`
|
|
403
404
|
`)}
|
|
404
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),process.exit(1)),choices.length===1?[selectedTemplate]=choices:(
|
|
405
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),process.exit(1)),choices.length===1?[selectedTemplate]=choices:(logger25.info(boxen3(dedent`
|
|
405
406
|
🤗 Welcome to ${chalk13.yellow("sb sandbox")}! 🤗
|
|
406
407
|
|
|
407
408
|
Create a ${chalk13.green("new project")} to minimally reproduce Storybook issues.
|
|
@@ -410,9 +411,9 @@ ${error.stack}`),fixSummary.failed[f.id]=error.message,fixResults[f.id]="check_f
|
|
|
410
411
|
2. select a location for the reproduction, outside of your project.
|
|
411
412
|
|
|
412
413
|
After the reproduction is ready, we'll guide you through the next steps.
|
|
413
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),selectedTemplate=await promptSelectedTemplate(choices)),!!!(selectedTemplate??null)){
|
|
414
|
-
Are you use it exists? Or did you want to set ${chalk13.yellow(selectedTemplate)} to inDevelopment first?`)}catch(err){throw
|
|
415
|
-
yarn storybook`):`Recreate your setup, then ${chalk13.yellow("npx storybook@latest init")}`;
|
|
414
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),selectedTemplate=await promptSelectedTemplate(choices)),!!!(selectedTemplate??null)){logger25.error("Somehow we got no templates. Please rerun this command!");return}if(selectedConfig=allTemplates[selectedTemplate],!selectedConfig)throw new Error("\u{1F6A8} Sandbox: please specify a valid template type")}let selectedDirectory=outputDirectory,outputDirectoryName=outputDirectory||selectedTemplate;if(selectedDirectory&&existsSync(`${selectedDirectory}`)&&logger25.info(`\u26A0\uFE0F ${selectedDirectory} already exists! Overwriting...`),!selectedDirectory){let{directory}=await prompts5({type:"text",message:"Enter the output directory",name:"directory",initial:outputDirectoryName,validate:async directoryName=>existsSync(directoryName)?`${directoryName} already exists. Please choose another name.`:!0},{onCancel:()=>{logger25.log("Command cancelled by the user. Exiting..."),process.exit(1);}});selectedDirectory=directory;}try{let templateDestination=path9.isAbsolute(selectedDirectory)?selectedDirectory:path9.join(process.cwd(),selectedDirectory);logger25.info(`\u{1F3C3} Adding ${selectedConfig.name} into ${templateDestination}`),logger25.log("\u{1F4E6} Downloading sandbox template...");try{let gitPath=`github:storybookjs/sandboxes/${selectedTemplate}/${init?"after-storybook":"before-storybook"}#${branch}`;if(await downloadTemplate(gitPath,{force:!0,dir:templateDestination}),(await readdir(templateDestination)).length===0)throw new Error(dedent`Template downloaded from ${chalk13.blue(gitPath)} is empty.
|
|
415
|
+
Are you use it exists? Or did you want to set ${chalk13.yellow(selectedTemplate)} to inDevelopment first?`)}catch(err){throw logger25.error(`\u{1F6A8} Failed to download sandbox template: ${err.message}`),err}let initMessage=init?chalk13.yellow(`yarn install
|
|
416
|
+
yarn storybook`):`Recreate your setup, then ${chalk13.yellow("npx storybook@latest init")}`;logger25.info(boxen3(dedent`
|
|
416
417
|
🎉 Your Storybook reproduction project is ready to use! 🎉
|
|
417
418
|
|
|
418
419
|
${chalk13.yellow(`cd ${selectedDirectory}`)}
|
|
@@ -425,7 +426,7 @@ yarn storybook`):`Recreate your setup, then ${chalk13.yellow("npx storybook@late
|
|
|
425
426
|
3. Link to the repro repository in your issue
|
|
426
427
|
|
|
427
428
|
Having a clean repro helps us solve your issue faster! 🙏
|
|
428
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}));}catch(error){throw
|
|
429
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}));}catch(error){throw logger25.error("\u{1F6A8} Failed to create sandbox"),error}};async function promptSelectedTemplate(choices){let{template}=await prompts5({type:"select",message:"\u{1F308} Select the template",name:"template",choices:choices.map(toChoices)},{onCancel:()=>{logger25.log("Command cancelled by the user. Exiting..."),process.exit(1);}});return template||null}var exec=async(command2,options={},{startMessage,errorMessage,dryRun}={})=>{if(startMessage&&logger.info(startMessage),dryRun){logger.info(`
|
|
429
430
|
> ${command2}
|
|
430
431
|
`);return}return logger.info(command2),new Promise((resolve2,reject)=>{let defaultOptions2={silent:!1},child=shell.exec(command2,{...defaultOptions2,...options,async:!0,silent:!1});child.stderr.pipe(process.stderr),child.on("exit",code=>{code===0?resolve2(void 0):(logger.error(chalk13.red(`An error occurred while executing: \`${command2}\``)),logger.info(errorMessage),reject(new Error(`command exited with code: ${code}: `)));});})},link=async({target,local,start})=>{let storybookDir=process.cwd();try{if((await fse__default.readJSON("package.json")).name!=="@storybook/root")throw new Error}catch{throw new Error("Expected to run link from the root of the storybook monorepo")}let reproDir=target,reproName=path9.basename(target);if(!local){let reprosDir=path9.join(storybookDir,"../storybook-repros");logger.info(`Ensuring directory ${reprosDir}`),await fse__default.ensureDir(reprosDir),logger.info(`Cloning ${target}`),await exec(`git clone ${target}`,{cwd:reprosDir}),reproName=path9.basename(target,path9.extname(target)),reproDir=path9.join(reprosDir,reproName);}let reproPackageJson=await fse__default.readJSON(path9.join(reproDir,"package.json")),version=sync$1("yarn",["--version"],{cwd:reproDir,stdio:"pipe",shell:!0}).stdout.toString();if(!/^[23]\./.test(version)){logger.warn(`\u{1F6A8} Expected yarn 2 or 3 in ${reproDir}!`),logger.warn(""),logger.warn("Please set it up with `yarn set version berry`,"),logger.warn(`then link '${reproDir}' with the '--local' flag.`);return}logger.info(`Linking ${reproDir}`),await exec(`yarn link --all ${storybookDir}`,{cwd:reproDir}),logger.info(`Installing ${reproName}`),await exec("yarn install",{cwd:reproDir}),reproPackageJson.devDependencies?.vite||await exec("yarn add -D webpack-hot-middleware",{cwd:reproDir}),await exec("yarn add @types/node@16",{cwd:reproDir}),start&&(logger.info(`Running ${reproName} storybook`),await exec("yarn run storybook",{cwd:reproDir}));};function printError(error){instance.heading="",error instanceof Error?error.error?logger.error(error.error):error.stats&&error.stats.compilation.errors?error.stats.compilation.errors.forEach(e=>logger.plain(e)):logger.error(error):error.compilation?.errors&&error.compilation.errors.forEach(e=>logger.plain(e)),logger.line(),logger.warn(error.close?dedent`
|
|
431
432
|
FATAL broken build!, will close the process,
|