@storybook/cli 7.0.0-beta.60 → 7.0.0-beta.62
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-T3OUNNBL.mjs → chunk-INFU6FKX.mjs} +3 -3
- package/dist/generate.js +62 -47
- package/dist/generate.mjs +61 -46
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +10 -10
package/dist/generate.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import{JsPackageManagerFactory,SUPPORTED_RENDERERS,__require,codeLog,commandLog,copyTemplate,copyTemplateFiles,externalFrameworks,getBabelDependencies,getBowerJson,getCliDir,getPackageDetails,getStorybookVersionSpecifier,installableProjectTypes,paddedLog,readFileAsJson,supportedTemplates,unsupportedTemplate,useNpmWarning,versions_default,writeFileAsJson}from"./chunk-
|
|
1
|
+
import{JsPackageManagerFactory,SUPPORTED_RENDERERS,__require,codeLog,commandLog,copyTemplate,copyTemplateFiles,externalFrameworks,getBabelDependencies,getBowerJson,getCliDir,getPackageDetails,getStorybookVersionSpecifier,installableProjectTypes,isNxProject,paddedLog,readFileAsJson,supportedTemplates,unsupportedTemplate,useNpmWarning,versions_default,writeFileAsJson}from"./chunk-INFU6FKX.mjs";import program from"commander";import path8 from"path";import chalk26 from"chalk";import envinfo from"envinfo";import leven from"leven";import{sync as readUpSync3}from"read-pkg-up";import{logger as logger26}from"@storybook/node-logger";import chalk23 from"chalk";import prompts6 from"prompts";import{telemetry}from"@storybook/telemetry";import{withTelemetry}from"@storybook/core-server";import fs from"fs";import findUp from"find-up";import semver from"semver";import{logger}from"@storybook/node-logger";import{pathExistsSync}from"fs-extra";import{join}from"path";var detectWebpack=packageManager=>{try{let out="";if(packageManager.type==="npm")try{out=packageManager.executeCommand("npm",["ls","webpack"])}catch{out=packageManager.executeCommand("npm",["why","webpack"])}else out=packageManager.executeCommand("yarn",["why","webpack"]);if(out.includes("webpack@4")||out.includes("webpack@npm:4"))return 4;if(out.includes("webpack@5")||out.includes("webpack@npm:5"))return 5}catch{}return!1};var viteConfigFiles=["vite.config.ts","vite.config.js","vite.config.mjs"],hasDependency=(packageJson,name,matcher)=>{let version=packageJson.dependencies?.[name]||packageJson.devDependencies?.[name];return version&&typeof matcher=="function"?matcher(version):!!version},hasPeerDependency=(packageJson,name,matcher)=>{let version=packageJson.peerDependencies?.[name];return version&&typeof matcher=="function"?matcher(version):!!version},getFrameworkPreset=(packageJson,framework)=>{let matcher={dependencies:[!1],peerDependencies:[!1],files:[!1]},{preset,files,dependencies,peerDependencies,matcherFunction}=framework,dependencySearches=[];Array.isArray(dependencies)?dependencySearches=dependencies.map(name=>[name,void 0]):typeof dependencies=="object"&&(dependencySearches=Object.entries(dependencies)),dependencySearches.length>0&&(matcher.dependencies=dependencySearches.map(([name,matchFn])=>hasDependency(packageJson,name,matchFn)));let peerDependencySearches=[];return Array.isArray(peerDependencies)?peerDependencySearches=peerDependencies.map(name=>[name,void 0]):typeof peerDependencies=="object"&&(peerDependencySearches=Object.entries(peerDependencies)),peerDependencySearches.length>0&&(matcher.peerDependencies=peerDependencySearches.map(([name,matchFn])=>hasPeerDependency(packageJson,name,matchFn))),Array.isArray(files)&&files.length>0&&(matcher.files=files.map(name=>fs.existsSync(name))),matcherFunction(matcher)?preset:null};function detectFrameworkPreset(packageJson={}){let result=[...supportedTemplates,unsupportedTemplate].find(framework=>getFrameworkPreset(packageJson,framework)!==null);return result?result.preset:"UNDETECTED"}function detectBuilder(packageManager,projectType){if(findUp.sync(viteConfigFiles))return paddedLog("Detected Vite project. Setting builder to Vite"),"vite";if(detectWebpack(packageManager))return paddedLog("Detected webpack project. Setting builder to webpack"),"webpack5";switch(projectType){case"SVELTE":case"SVELTEKIT":case"VUE":case"VUE3":case"SFC_VUE":return"vite";default:return"webpack5"}}function isStorybookInstalled(dependencies,force){return dependencies?!!(!force&&dependencies.devDependencies&&SUPPORTED_RENDERERS.reduce((storybookPresent,framework)=>storybookPresent||!!dependencies.devDependencies[`@storybook/${framework}`],!1)):!1}function detectPnp(){return pathExistsSync(join(process.cwd(),".pnp.cjs"))}function detectLanguage(packageJson){let language="javascript";return!packageJson||fs.existsSync("jsconfig.json")||(hasDependency(packageJson,"typescript",version=>semver.gte(semver.coerce(version),"4.9.0"))&&(!hasDependency(packageJson,"prettier")||hasDependency(packageJson,"prettier",version=>semver.gte(semver.coerce(version),"2.8.0")))&&(!hasDependency(packageJson,"@babel/plugin-transform-typescript")||hasDependency(packageJson,"@babel/plugin-transform-typescript",version=>semver.gte(semver.coerce(version),"7.20.0")))&&(!hasDependency(packageJson,"@typescript-eslint/parser")||hasDependency(packageJson,"@typescript-eslint/parser",version=>semver.gte(semver.coerce(version),"5.44.0")))&&(!hasDependency(packageJson,"eslint-plugin-storybook")||hasDependency(packageJson,"eslint-plugin-storybook",version=>semver.gte(semver.coerce(version),"0.6.8")))?language="typescript-4-9":hasDependency(packageJson,"typescript",version=>semver.gte(semver.coerce(version),"3.8.0"))?language="typescript-3-8":hasDependency(packageJson,"typescript",version=>semver.lt(semver.coerce(version),"3.8.0"))&&logger.warn("Detected TypeScript < 3.8, populating with JavaScript examples")),language}function detect(packageJson,options={}){let bowerJson=getBowerJson();return!packageJson&&!bowerJson?"UNDETECTED":isNxProject(packageJson)?"NX":options.html?"HTML":detectFrameworkPreset(packageJson||bowerJson)}import{join as join2}from"path";import semver2 from"semver";import path2 from"path";import fse2 from"fs-extra";import{dedent as dedent2}from"ts-dedent";import fse from"fs-extra";import{dedent}from"ts-dedent";var logger2=console,sanitizeFramework=framework=>{let matches=framework.match(/(@storybook\/\w+(?:-\w+)*)|(storybook-(\w+(?:-\w+)*))/g);if(matches)return matches[0]};async function configureMain({addons,extensions=["js","jsx","ts","tsx"],storybookConfigFolder,language,...custom}){let prefix=await fse.pathExists("./src")?"../src":"../stories",config={stories:[`${prefix}/**/*.mdx`,`${prefix}/**/*.stories.@(${extensions.join("|")})`],addons,...custom},isTypescript=language==="typescript-4-9"||language==="typescript-3-8",mainConfigTemplate=dedent`<<import>>const config<<type>> = <<mainContents>>;
|
|
2
2
|
export default config;`,frameworkPackage=sanitizeFramework(custom.framework?.name);frameworkPackage||(mainConfigTemplate=mainConfigTemplate.replace("<<import>>","").replace("<<type>>",""),logger2.warn("Could not find framework package name"));let mainContents=JSON.stringify(config,null,2).replace(/['"]%%/g,"").replace(/%%['"]/g,""),imports=[];custom.framework?.name.includes("path.dirname(")&&imports.push("import path from 'path';"),isTypescript?imports.push(`import type { StorybookConfig } from '${frameworkPackage}';`):imports.push(`/** @type { import('${frameworkPackage}').StorybookConfig } */`);let mainJsContents=mainConfigTemplate.replace("<<import>>",`${imports.join(`
|
|
3
3
|
|
|
4
4
|
`)}
|
|
@@ -36,7 +36,7 @@ import{JsPackageManagerFactory,SUPPORTED_RENDERERS,__require,codeLog,commandLog,
|
|
|
36
36
|
import { setCompodocJson } from "@storybook/addon-docs/angular";
|
|
37
37
|
import docJson from "../documentation.json";
|
|
38
38
|
setCompodocJson(docJson);
|
|
39
|
-
`.trimStart(),promptForCompoDocs=async()=>{let{useCompoDoc}=await prompts2({type:"confirm",name:"useCompoDoc",message:"Do you want to use Compodoc for documentation?"});return useCompoDoc},AngularJSON=class{constructor(){if(!fs2.existsSync(ANGULAR_JSON_PATH))throw commandLog("An angular.json file was not found in the current directory. Storybook needs it to work properly."),new Error("No angular.json file found");let jsonContent=fs2.readFileSync(ANGULAR_JSON_PATH,"utf8");this.json=JSON.parse(jsonContent)}get projects(){return this.json.projects}get projectsWithoutStorybook(){return Object.keys(this.projects).filter(projectName=>{let{architect}=this.projects[projectName];return!architect.storybook})}getProjectSettingsByName(projectName){return this.projects[projectName]}async getProjectName(){if(this.projectsWithoutStorybook.length>1){let{projectName}=await prompts2({type:"select",name:"projectName",message:"For which project do you want to generate Storybook configuration?",choices:this.projectsWithoutStorybook.map(name=>({title:name,value:name}))});return projectName}return this.projectsWithoutStorybook[0]}addStorybookEntries({angularProjectName,storybookFolder,useCompodoc,root}){let{architect}=this.projects[angularProjectName],baseOptions={configDir:storybookFolder,browserTarget:`${angularProjectName}:build`,compodoc:useCompodoc,...useCompodoc&&{compodocArgs:["-e","json","-d",root||"."]}};architect.storybook||(architect.storybook={builder:"@storybook/angular:start-storybook",options:{...baseOptions,port:6006}}),architect["build-storybook"]||(architect["build-storybook"]={builder:"@storybook/angular:build-storybook",options:{...baseOptions,outputDir:Object.keys(this.projects).length===1?"storybook-static":`dist/storybook/${angularProjectName}`}})}write(){fs2.writeFileSync(ANGULAR_JSON_PATH,JSON.stringify(this.json,null,2))}};var generator=async(packageManager,npmOptions,options,commandOptions)=>{let angularVersionFromDependencies=semver2.coerce(packageManager.retrievePackageJson().dependencies["@angular/core"])?.version,angularVersionFromDevDependencies=semver2.coerce(packageManager.retrievePackageJson().devDependencies["@angular/core"])?.version,angularVersion=angularVersionFromDependencies||angularVersionFromDevDependencies,updatedOptions=semver2.gte(angularVersion,"12.0.0")?{...options,builder:"webpack5"}:options,angularJSON=new AngularJSON;if(angularJSON.projectsWithoutStorybook.length===0)return paddedLog("Every project in your workspace is already set up with Storybook. There is nothing to do!"),Promise.reject();let angularProjectName=await angularJSON.getProjectName();paddedLog(`Adding Storybook support to your "${angularProjectName}" project`);let{root}=angularJSON.getProjectSettingsByName(angularProjectName),{projects}=angularJSON,useCompodoc=commandOptions.yes?!0:await promptForCompoDocs(),storybookFolder=root?`${root}/.storybook`:".storybook";angularJSON.addStorybookEntries({angularProjectName,storybookFolder,useCompodoc,root}),angularJSON.write(),await baseGenerator(packageManager,npmOptions,{...updatedOptions,...useCompodoc&&{frameworkPreviewParts:{prefix:compoDocPreviewPrefix}}},"angular",{...useCompodoc&&{extraPackages:["@compodoc/compodoc"]},addScripts:!1,componentsDestinationPath:root?`${root}/src/stories`:void 0,storybookConfigFolder:storybookFolder},"angular"),Object.keys(projects).length===1&&packageManager.addScripts({storybook:`ng run ${angularProjectName}:storybook`,"build-storybook":`ng run ${angularProjectName}:build-storybook`});let templateDir=join2(getCliDir(),"templates","angular");return copyTemplate(templateDir,root||void 0),{projectName:angularProjectName}},ANGULAR_default=generator;import{join as join3}from"path";function addStorybookExcludeGlobToTsConfig(){let tsConfigJson=readFileAsJson("tsconfig.json",!0),glob="**/*.stories.ts";if(!tsConfigJson)return;let{exclude=[]}=tsConfigJson;exclude.includes(glob)||(tsConfigJson.exclude=[...exclude,glob],writeFileAsJson("tsconfig.json",tsConfigJson))}var generator2=async(packageManager,npmOptions,options)=>{addStorybookExcludeGlobToTsConfig(),await baseGenerator(packageManager,npmOptions,options,"aurelia",{extraPackages:["aurelia"]});let templateDir=join3(getCliDir(),"templates","aurelia");copyTemplate(templateDir)},AURELIA_default=generator2;var generator3=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"ember",{extraPackages:["babel-plugin-ember-modules-api-polyfill","babel-plugin-htmlbars-inline-precompile"],staticDir:"dist"})},EMBER_default=generator3;var generator4=async(packageManager,npmOptions,options)=>{let extraPackages=detectLanguage()==="javascript"?["prop-types"]:[];await baseGenerator(packageManager,npmOptions,options,"react",{extraPackages})},REACT_default=generator4;var generator5=async(packageManager,npmOptions)=>{let packageJson=packageManager.retrievePackageJson(),missingReactDom=!packageJson.dependencies["react-dom"]&&!packageJson.devDependencies["react-dom"],reactVersion=packageJson.dependencies.react,packagesToResolve=["react-native-safe-area-context","@react-native-async-storage/async-storage","@react-native-community/datetimepicker","@react-native-community/slider"],packagesWithFixedVersion=["@storybook/addon-actions@^6.5.14","@storybook/addon-controls@^6.5.14","@storybook/addon-ondevice-controls@6.5.0-rc.0","@storybook/addon-ondevice-actions@6.5.0-rc.0","@storybook/react-native@6.5.0-rc.0"],resolvedPackages=await packageManager.getVersionedPackages(packagesToResolve),packages=[...await getBabelDependencies(packageManager,packageJson),...packagesWithFixedVersion,...resolvedPackages,missingReactDom&&reactVersion&&`react-dom@${reactVersion}`].filter(Boolean);packageManager.addDependencies({...npmOptions,packageJson},packages),packageManager.addScripts({"storybook-generate":"sb-rn-get-stories","storybook-watch":"sb-rn-watcher"});let storybookConfigFolder=".storybook";await copyTemplateFiles({packageManager,renderer:"react-native",language:"javascript",destination:storybookConfigFolder,includeCommonAssets:!1})},REACT_NATIVE_default=generator5;import path3 from"path";import fs3 from"fs";import semver3 from"semver";import dedent4 from"ts-dedent";var generator6=async(packageManager,npmOptions,options)=>{let monorepoRootPath=path3.join(__dirname,"..","..","..","..","..",".."),extraMain=options.linkable?{webpackFinal:`%%(config) => {
|
|
39
|
+
`.trimStart(),promptForCompoDocs=async()=>{let{useCompoDoc}=await prompts2({type:"confirm",name:"useCompoDoc",message:"Do you want to use Compodoc for documentation?"});return useCompoDoc},AngularJSON=class{constructor(){if(!fs2.existsSync(ANGULAR_JSON_PATH))throw commandLog("An angular.json file was not found in the current directory. Storybook needs it to work properly."),new Error("No angular.json file found");let jsonContent=fs2.readFileSync(ANGULAR_JSON_PATH,"utf8");this.json=JSON.parse(jsonContent)}get projects(){return this.json.projects}get projectsWithoutStorybook(){return Object.keys(this.projects).filter(projectName=>{let{architect}=this.projects[projectName];return!architect.storybook})}get hasStorybookBuilder(){return Object.keys(this.projects).some(projectName=>{let{architect}=this.projects[projectName];return Object.keys(architect).some(key=>architect[key].builder==="@storybook/angular:start-storybook")})}get rootProject(){let rootProjectName=Object.keys(this.projects).find(projectName=>{let{root}=this.projects[projectName];return root===""||root==="."});return rootProjectName?this.projects[rootProjectName]:null}getProjectSettingsByName(projectName){return this.projects[projectName]}async getProjectName(){if(this.projectsWithoutStorybook.length>1){let{projectName}=await prompts2({type:"select",name:"projectName",message:"For which project do you want to generate Storybook configuration?",choices:this.projectsWithoutStorybook.map(name=>({title:name,value:name}))});return projectName}return this.projectsWithoutStorybook[0]}addStorybookEntries({angularProjectName,storybookFolder,useCompodoc,root}){let{architect}=this.projects[angularProjectName],baseOptions={configDir:storybookFolder,browserTarget:`${angularProjectName}:build`,compodoc:useCompodoc,...useCompodoc&&{compodocArgs:["-e","json","-d",root||"."]}};architect.storybook||(architect.storybook={builder:"@storybook/angular:start-storybook",options:{...baseOptions,port:6006}}),architect["build-storybook"]||(architect["build-storybook"]={builder:"@storybook/angular:build-storybook",options:{...baseOptions,outputDir:Object.keys(this.projects).length===1?"storybook-static":`dist/storybook/${angularProjectName}`}})}write(){fs2.writeFileSync(ANGULAR_JSON_PATH,JSON.stringify(this.json,null,2))}};var generator=async(packageManager,npmOptions,options,commandOptions)=>{let angularVersionFromDependencies=semver2.coerce(packageManager.retrievePackageJson().dependencies["@angular/core"])?.version,angularVersionFromDevDependencies=semver2.coerce(packageManager.retrievePackageJson().devDependencies["@angular/core"])?.version,angularVersion=angularVersionFromDependencies||angularVersionFromDevDependencies,updatedOptions=semver2.gte(angularVersion,"12.0.0")?{...options,builder:"webpack5"}:options,angularJSON=new AngularJSON;if(angularJSON.projectsWithoutStorybook.length===0)return paddedLog("Every project in your workspace is already set up with Storybook. There is nothing to do!"),Promise.reject();let angularProjectName=await angularJSON.getProjectName();paddedLog(`Adding Storybook support to your "${angularProjectName}" project`);let{root}=angularJSON.getProjectSettingsByName(angularProjectName),{projects}=angularJSON,useCompodoc=commandOptions.yes?!0:await promptForCompoDocs(),storybookFolder=root?`${root}/.storybook`:".storybook";angularJSON.addStorybookEntries({angularProjectName,storybookFolder,useCompodoc,root}),angularJSON.write(),await baseGenerator(packageManager,npmOptions,{...updatedOptions,...useCompodoc&&{frameworkPreviewParts:{prefix:compoDocPreviewPrefix}}},"angular",{...useCompodoc&&{extraPackages:["@compodoc/compodoc"]},addScripts:!1,componentsDestinationPath:root?`${root}/src/stories`:void 0,storybookConfigFolder:storybookFolder},"angular"),Object.keys(projects).length===1&&packageManager.addScripts({storybook:`ng run ${angularProjectName}:storybook`,"build-storybook":`ng run ${angularProjectName}:build-storybook`});let templateDir=join2(getCliDir(),"templates","angular");return copyTemplate(templateDir,root||void 0),{projectName:angularProjectName}},ANGULAR_default=generator;import{join as join3}from"path";function addStorybookExcludeGlobToTsConfig(){let tsConfigJson=readFileAsJson("tsconfig.json",!0),glob="**/*.stories.ts";if(!tsConfigJson)return;let{exclude=[]}=tsConfigJson;exclude.includes(glob)||(tsConfigJson.exclude=[...exclude,glob],writeFileAsJson("tsconfig.json",tsConfigJson))}var generator2=async(packageManager,npmOptions,options)=>{addStorybookExcludeGlobToTsConfig(),await baseGenerator(packageManager,npmOptions,options,"aurelia",{extraPackages:["aurelia"]});let templateDir=join3(getCliDir(),"templates","aurelia");copyTemplate(templateDir)},AURELIA_default=generator2;var generator3=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"ember",{extraPackages:["babel-plugin-ember-modules-api-polyfill","babel-plugin-htmlbars-inline-precompile"],staticDir:"dist"})},EMBER_default=generator3;var generator4=async(packageManager,npmOptions,options)=>{let extraPackages=detectLanguage()==="javascript"?["prop-types"]:[];await baseGenerator(packageManager,npmOptions,options,"react",{extraPackages})},REACT_default=generator4;var generator5=async(packageManager,npmOptions)=>{let packageJson=packageManager.retrievePackageJson(),missingReactDom=!packageJson.dependencies["react-dom"]&&!packageJson.devDependencies["react-dom"],reactVersion=packageJson.dependencies.react,packagesToResolve=["react-native-safe-area-context","@react-native-async-storage/async-storage","@react-native-community/datetimepicker","@react-native-community/slider"],packagesWithFixedVersion=["@storybook/addon-actions@^6.5.14","@storybook/addon-controls@^6.5.14","@storybook/addon-ondevice-controls@6.5.0-rc.0","@storybook/addon-ondevice-actions@6.5.0-rc.0","@storybook/react-native@6.5.0-rc.0"],resolvedPackages=await packageManager.getVersionedPackages(packagesToResolve),packages=[...await getBabelDependencies(packageManager,packageJson),...packagesWithFixedVersion,...resolvedPackages,missingReactDom&&reactVersion&&`react-dom@${reactVersion}`].filter(Boolean);packageManager.addDependencies({...npmOptions,packageJson},packages),packageManager.addScripts({"storybook-generate":"sb-rn-get-stories","storybook-watch":"sb-rn-watcher"});let storybookConfigFolder=".storybook";await copyTemplateFiles({packageManager,renderer:"react-native",language:"javascript",destination:storybookConfigFolder,includeCommonAssets:!1})},REACT_NATIVE_default=generator5;import path3 from"path";import fs3 from"fs";import semver3 from"semver";import dedent4 from"ts-dedent";var generator6=async(packageManager,npmOptions,options)=>{let monorepoRootPath=path3.join(__dirname,"..","..","..","..","..",".."),extraMain=options.linkable?{webpackFinal:`%%(config) => {
|
|
40
40
|
// add monorepo root as a valid directory to import modules from
|
|
41
41
|
config.resolve.plugins.forEach((p) => {
|
|
42
42
|
if (Array.isArray(p.appSrcs)) {
|
|
@@ -49,7 +49,7 @@ import{JsPackageManagerFactory,SUPPORTED_RENDERERS,__require,codeLog,commandLog,
|
|
|
49
49
|
Storybook 7.0+ doesn't support react-scripts@<5.0.0.
|
|
50
50
|
|
|
51
51
|
https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#create-react-app-dropped-cra4-support
|
|
52
|
-
`);await baseGenerator(packageManager,npmOptions,updatedOptions,"react",{extraAddons,extraPackages,staticDir:fs3.existsSync(path3.resolve("./public"))?"public":void 0,addBabel:!1,addESLint:!0,extraMain})},REACT_SCRIPTS_default=generator6;var generator7=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"react",void 0,"nextjs")},NEXTJS_default=generator7;var generator8=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"vue")},SFC_VUE_default=generator8;var generator9=async(packageManager,npmOptions,options)=>{let extraPackages=options.builder==="webpack5"?["vue-loader@^15.7.0"]:[];await baseGenerator(packageManager,npmOptions,options,"vue",{extraPackages})},VUE_default=generator9;var generator10=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=generator10;var generator11=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"react")},WEBPACK_REACT_default=generator11;var generator12=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"mithril")},MITHRIL_default=generator12;var generator13=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"marionette")},MARIONETTE_default=generator13;var generator14=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"marko")},MARKO_default=generator14;var generator15=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"html")},HTML_default=generator15;var generator16=async(packageManager,npmOptions,options)=>baseGenerator(packageManager,npmOptions,options,"web-components",{extraPackages:["lit"]}),WEB_COMPONENTS_default=generator16;var generator17=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"riot",{extraPackages:["riot-tag-loader"]})},RIOT_default=generator17;var generator18=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"preact")},PREACT_default=generator18;var generator19=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"svelte",{extensions:["js","jsx","ts","tsx","svelte"]})},SVELTE_default=generator19;var generator20=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"qwik",{},"qwik")},QWIK_default=generator20;var generator21=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"svelte",void 0,"sveltekit")},SVELTEKIT_default=generator21;var generator22=async(packageManager,npmOptions,options)=>{let[latestRaxVersion]=await packageManager.getVersions("rax"),packageJson=packageManager.retrievePackageJson(),raxVersion=packageJson.dependencies.rax||latestRaxVersion;packageJson.dependencies.rax=packageJson.dependencies.rax||raxVersion,packageJson.dependencies["rax-image"]=packageJson.dependencies["rax-image"]||raxVersion,packageJson.dependencies["rax-link"]=packageJson.dependencies["rax-link"]||raxVersion,packageJson.dependencies["rax-text"]=packageJson.dependencies["rax-text"]||raxVersion,packageJson.dependencies["rax-view"]=packageJson.dependencies["rax-view"]||raxVersion,packageManager.writePackageJson(packageJson),await baseGenerator(packageManager,npmOptions,options,"rax",{extraPackages:["rax"]})},RAX_default=generator22;var generator23=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"solid",{},"solid")},SOLID_default=generator23;import{join as join4}from"path";var generator24=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"server",{extensions:["json"]});let templateDir=join4(getCliDir(),"templates","server");copyTemplate(templateDir)},SERVER_default=generator24;import
|
|
52
|
+
`);await baseGenerator(packageManager,npmOptions,updatedOptions,"react",{extraAddons,extraPackages,staticDir:fs3.existsSync(path3.resolve("./public"))?"public":void 0,addBabel:!1,addESLint:!0,extraMain})},REACT_SCRIPTS_default=generator6;var generator7=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"react",void 0,"nextjs")},NEXTJS_default=generator7;var generator8=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"vue")},SFC_VUE_default=generator8;var generator9=async(packageManager,npmOptions,options)=>{let extraPackages=options.builder==="webpack5"?["vue-loader@^15.7.0"]:[];await baseGenerator(packageManager,npmOptions,options,"vue",{extraPackages})},VUE_default=generator9;var generator10=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=generator10;var generator11=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"react")},WEBPACK_REACT_default=generator11;var generator12=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"mithril")},MITHRIL_default=generator12;var generator13=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"marionette")},MARIONETTE_default=generator13;var generator14=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"marko")},MARKO_default=generator14;var generator15=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"html")},HTML_default=generator15;var generator16=async(packageManager,npmOptions,options)=>baseGenerator(packageManager,npmOptions,options,"web-components",{extraPackages:["lit"]}),WEB_COMPONENTS_default=generator16;var generator17=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"riot",{extraPackages:["riot-tag-loader"]})},RIOT_default=generator17;var generator18=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"preact")},PREACT_default=generator18;var generator19=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"svelte",{extensions:["js","jsx","ts","tsx","svelte"]})},SVELTE_default=generator19;var generator20=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"qwik",{},"qwik")},QWIK_default=generator20;var generator21=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"svelte",void 0,"sveltekit")},SVELTEKIT_default=generator21;var generator22=async(packageManager,npmOptions,options)=>{let[latestRaxVersion]=await packageManager.getVersions("rax"),packageJson=packageManager.retrievePackageJson(),raxVersion=packageJson.dependencies.rax||latestRaxVersion;packageJson.dependencies.rax=packageJson.dependencies.rax||raxVersion,packageJson.dependencies["rax-image"]=packageJson.dependencies["rax-image"]||raxVersion,packageJson.dependencies["rax-link"]=packageJson.dependencies["rax-link"]||raxVersion,packageJson.dependencies["rax-text"]=packageJson.dependencies["rax-text"]||raxVersion,packageJson.dependencies["rax-view"]=packageJson.dependencies["rax-view"]||raxVersion,packageManager.writePackageJson(packageJson),await baseGenerator(packageManager,npmOptions,options,"rax",{extraPackages:["rax"]})},RAX_default=generator22;var generator23=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"solid",{},"solid")},SOLID_default=generator23;import{join as join4}from"path";var generator24=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"server",{extensions:["json"]});let templateDir=join4(getCliDir(),"templates","server");copyTemplate(templateDir)},SERVER_default=generator24;import prompts5 from"prompts";import chalk22 from"chalk";import boxen from"boxen";import{createWriteStream,move,remove}from"fs-extra";import tempy from"tempy";import dedent26 from"ts-dedent";import{join as join5}from"path";import{getStorybookInfo as getStorybookInfo3,loadMainConfig as loadMainConfig2}from"@storybook/core-common";import semver19 from"semver";import chalk5 from"chalk";import{dedent as dedent8}from"ts-dedent";import semver7 from"semver";import chalk4 from"chalk";import{dedent as dedent7}from"ts-dedent";import semver6 from"semver";import chalk3 from"chalk";import semver5 from"semver";import dedent6 from"ts-dedent";import{getStorybookInfo,loadMainConfig}from"@storybook/core-common";import{readConfig,writeConfig as writeConfigFile}from"@storybook/csf-tools";import chalk2 from"chalk";import semver4 from"semver";import dedent5 from"ts-dedent";var logger4=console,getStorybookData=async({packageManager,configDir:userDefinedConfigDir})=>{let packageJson=packageManager.retrievePackageJson(),{mainConfig:mainConfigPath,version:storybookVersionSpecifier,configDir:configDirFromScript,previewConfig:previewConfigPath}=getStorybookInfo(packageJson,userDefinedConfigDir),storybookVersion=storybookVersionSpecifier&&semver4.coerce(storybookVersionSpecifier)?.version,configDir=userDefinedConfigDir||configDirFromScript||".storybook",mainConfig;try{mainConfig=await loadMainConfig({configDir})}catch(err){throw new Error(dedent5`Unable to find or evaluate ${chalk2.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 writeConfigFile(main)}catch(e){logger4.info(`\u274C The migration failed to update your ${chalk2.blue(mainConfigPath)} on your behalf because of the following error:
|
|
53
53
|
${e}
|
|
54
54
|
`),logger4.info(`\u26A0\uFE0F Storybook automigrations are based on AST parsing and it's possible that your ${chalk2.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.`)}};var logger5=console,checkWebpack5Builder=async({configDir,packageManager})=>{let{mainConfig,storybookVersion}=await getStorybookData({configDir,packageManager});if(semver5.lt(storybookVersion,"6.3.0"))return logger5.warn(dedent6`
|
|
55
55
|
Detected SB 6.3 or below, please upgrade storybook to use webpack5.
|
|
@@ -285,45 +285,60 @@ import{JsPackageManagerFactory,SUPPORTED_RENDERERS,__require,codeLog,commandLog,
|
|
|
285
285
|
|
|
286
286
|
To learn more about this change, see: ${chalk19.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#mdx-docs-files")}
|
|
287
287
|
`},async run({dryRun,mainConfigPath,result:{nextStoriesEntries}}){logger17.info(dedent23`✅ Setting 'stories' config:
|
|
288
|
-
${JSON.stringify(nextStoriesEntries,null,2)}`),dryRun||await updateMainConfig({mainConfigPath,dryRun},async main=>{main.setFieldValue(["stories"],nextStoriesEntries)})}};
|
|
288
|
+
${JSON.stringify(nextStoriesEntries,null,2)}`),dryRun||await updateMainConfig({mainConfigPath,dryRun},async main=>{main.setFieldValue(["stories"],nextStoriesEntries)})}};import{dedent as dedent24}from"ts-dedent";import semver17 from"semver";import chalk20 from"chalk";import prompts4 from"prompts";var angularBuilders={id:"angular-builders",async check({packageManager,configDir}){let packageJSON=packageManager.retrievePackageJson();if(isNxProject(packageJSON))return null;let angularVersion=packageManager.getAllDependencies()["@angular/core"],angularCoerced=semver17.coerce(angularVersion)?.version;if(!angularCoerced)return null;if(semver17.lt(angularCoerced,"14.0.0"))throw new Error(dedent24`
|
|
289
|
+
❌ Your project uses Angular < 14.0.0. Storybook 7.0 for Angular requires Angular 14.0.0 or higher.
|
|
290
|
+
Please upgrade your Angular version to at least version 14.0.0 to use Storybook 7.0 in your project.
|
|
291
|
+
`);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 dedent24`
|
|
292
|
+
We have detected that your project does not use the Storybook Angular builder yet. In Storybook 6.4 we have deprecated calling Storybook directly (npm run storybook) for Angular. In Storybook 7.0, we've removed it entirely.
|
|
293
|
+
|
|
294
|
+
In order to use the Storybook Angular builder, we need to add a few entries to your angular.json file. Additionally, we will add the @compodoc/compodoc package to your devDependencies if you want and we will add a few scripts to your package.json file.
|
|
295
|
+
|
|
296
|
+
Also feel free to remove the Compodoc script from your package.json file if you don't use it apart from Storybook anymore. Storybook uses Compodoc internally and you don't have to call in separately anymore.
|
|
297
|
+
|
|
298
|
+
Read more about the Angular builder here: ${chalk20.yellow("https://storybook.js.org/docs/angular/configure/storybook-builders")}
|
|
299
|
+
`},async run({result}){let angularJSON=new AngularJSON,{packageManager}=result,{useCompoDoc}=await prompts4({type:"confirm",name:"useCompoDoc",message:"Have you set up compodoc in Storybook previously?"}),angularProjectName=await angularJSON.getProjectName();angularJSON.addStorybookEntries({angularProjectName,storybookFolder:".storybook",useCompodoc:useCompoDoc,root:"."}),angularJSON.write(),packageManager.addScripts({storybook:`ng run ${angularProjectName}:storybook`,"build-storybook":`ng run ${angularProjectName}:build-storybook`})}};import{dedent as dedent25}from"ts-dedent";import semver18 from"semver";import chalk21 from"chalk";var angularBuildersMultiproject={id:"angular-builders-multiproject",promptOnly:!0,async check({packageManager,configDir}){let packageJSON=packageManager.retrievePackageJson();if(isNxProject(packageJSON))return null;let angularVersion=packageManager.getAllDependencies()["@angular/core"],angularCoerced=semver18.coerce(angularVersion)?.version;if(!angularCoerced||semver18.lt(angularCoerced,"14.0.0"))return null;let angularJSON=new AngularJSON,{hasStorybookBuilder}=angularJSON;return hasStorybookBuilder||angularJSON.rootProject||Object.keys(angularJSON.projects).length===1?null:{}},prompt(){return dedent25`
|
|
300
|
+
In Storybook 6.4 we have deprecated calling Storybook directly (npm run storybook) for Angular. In Storybook 7.0, we've removed it entirely. Instead you have to set up the Storybook builder in your ${chalk21.yellow("angular.json")} and execute ${chalk21.yellow("ng run <your-project>:storybook")} to start Storybook.
|
|
301
|
+
|
|
302
|
+
❌ Your Angular workspace uses multiple projects defined in the ${chalk21.yellow("angular.json")} file and we were not able to detect a root project. Therefore we are not able to automigrate to use Angular Storybook builder. Instead, please visit ${chalk21.yellow("https://github.com/storybookjs/storybook/tree/next/code/frameworks/angular")} to do the migration manually.
|
|
303
|
+
`}};var allFixes=[nodeJsRequirement,cra5,webpack5,angular12,vue3,eslintPlugin,builderVite,sbBinary,sbScripts,newFrameworks,removedGlobalClientAPIs,mdx1to2,mdxgfm,bareMdxStoriesGlob,autodocsTrue,addReact,missingBabelRc,angularBuildersMultiproject,angularBuilders],initFixes=[missingBabelRc,eslintPlugin];import{EOL}from"os";var ansiRegex=({onlyFirst=!1}={})=>{let pattern=["[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)","(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))"].join("|");return new RegExp(pattern,onlyFirst?void 0:"g")},cleanLog=str=>str.replace(ansiRegex(),"").replace(/╮│/g,`\u256E
|
|
289
304
|
\u2502`).replace(/││/g,`\u2502
|
|
290
305
|
\u2502`).replace(/│╰/g,`\u2502
|
|
291
|
-
\u2570`).replace(/⚠️ {2}failed to check/g,`${EOL}\u26A0\uFE0F failed to check`);var logger18=console,LOG_FILE_NAME="migration-storybook.log",LOG_FILE_PATH=join5(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};var logAvailableMigrations=()=>{let availableFixes=allFixes.map(f=>
|
|
292
|
-
The following migrations are available: ${availableFixes}`)},automigrate=async({fixId,fixes:inputFixes,dryRun,yes,useNpm,packageManager:pkgMgr,list,configDir:userSpecifiedConfigDir,renderer:rendererPackage,skipInstall}={})=>{if(list)return logAvailableMigrations(),null;useNpm&&(useNpmWarning(),pkgMgr="npm");let selectedFixes=inputFixes||allFixes,fixes=fixId?selectedFixes.filter(f=>f.id===fixId):selectedFixes;if(fixId&&fixes.length===0)return logger18.info(`\u{1F4ED} No migrations found for ${
|
|
306
|
+
\u2570`).replace(/⚠️ {2}failed to check/g,`${EOL}\u26A0\uFE0F failed to check`);var logger18=console,LOG_FILE_NAME="migration-storybook.log",LOG_FILE_PATH=join5(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};var logAvailableMigrations=()=>{let availableFixes=allFixes.map(f=>chalk22.yellow(f.id)).join(", ");logger18.info(`
|
|
307
|
+
The following migrations are available: ${availableFixes}`)},automigrate=async({fixId,fixes:inputFixes,dryRun,yes,useNpm,packageManager:pkgMgr,list,configDir:userSpecifiedConfigDir,renderer:rendererPackage,skipInstall}={})=>{if(list)return logAvailableMigrations(),null;useNpm&&(useNpmWarning(),pkgMgr="npm");let selectedFixes=inputFixes||allFixes,fixes=fixId?selectedFixes.filter(f=>f.id===fixId):selectedFixes;if(fixId&&fixes.length===0)return logger18.info(`\u{1F4ED} No migrations found for ${chalk22.magenta(fixId)}.`),logAvailableMigrations(),null;augmentLogsToFile();let packageManager=JsPackageManagerFactory.getPackageManager({force:pkgMgr}),{configDir:inferredConfigDir,mainConfig:mainConfigPath,version:storybookVersion}=getStorybookInfo3(packageManager.retrievePackageJson(),userSpecifiedConfigDir);if(!(storybookVersion&&semver19.coerce(storybookVersion)?.version))return logger18.info(dedent26`
|
|
293
308
|
[Storybook automigrate] ❌ Unable to determine storybook version so the automigrations will be skipped.
|
|
294
309
|
🤔 Are you running automigrate from your project directory? Please specify your Storybook config directory with the --config-dir flag.
|
|
295
|
-
`),{preCheckFailure:"undetected_sb_version"};let configDir=userSpecifiedConfigDir||inferredConfigDir||".storybook";try{await loadMainConfig2({configDir})}catch(err){return err.message.includes("No configuration files have been found")?(logger18.info(
|
|
310
|
+
`),{preCheckFailure:"undetected_sb_version"};let configDir=userSpecifiedConfigDir||inferredConfigDir||".storybook";try{await loadMainConfig2({configDir})}catch(err){return err.message.includes("No configuration files have been found")?(logger18.info(dedent26`[Storybook automigrate] Could not find or evaluate your Storybook main.js config directory at ${chalk22.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.`),{preCheckFailure:"mainjs_not_found"}):(logger18.info(dedent26`[Storybook automigrate] ❌ Failed trying to evaluate ${chalk22.blue(mainConfigPath)} with the following error: ${err.message}`),logger18.info("Please fix the error and try again."),{preCheckFailure:"mainjs_evaluation_error"})}logger18.info("\u{1F50E} checking possible migrations..");let fixResults={},fixSummary={succeeded:[],failed:{},manual:[],skipped:[]};for(let i=0;i<fixes.length;i+=1){let f=fixes[i],result;try{result=await f.check({packageManager,configDir,rendererPackage})}catch(error){logger18.info(`\u26A0\uFE0F failed to check fix ${chalk22.bold(f.id)}`),logger18.error(`
|
|
296
311
|
${error.stack}`),fixSummary.failed[f.id]=error.message,fixResults[f.id]="check_failed"}if(result){logger18.info(`
|
|
297
|
-
\u{1F50E} found a '${
|
|
298
|
-
${
|
|
312
|
+
\u{1F50E} found a '${chalk22.cyan(f.id)}' migration:`);let message=f.prompt(result);logger18.info(boxen(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),logger18.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 '${chalk22.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}),logger18.info(`\u2705 ran ${chalk22.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,logger18.info(`\u274C error when running ${chalk22.cyan(f.id)} migration`),logger18.info(error),logger18.info()}else fixResults[f.id]="skipped",fixSummary.skipped.push(f.id)}else fixResults[f.id]=fixResults[f.id]||"unnecessary"}return Object.values(fixResults).some(r=>r==="failed"||r==="check_failed")?await move(TEMP_LOG_FILE_PATH,join5(process.cwd(),LOG_FILE_NAME),{overwrite:!0}):await remove(TEMP_LOG_FILE_PATH),logger18.info(),logger18.info(getMigrationSummary(fixResults,fixSummary,LOG_FILE_PATH)),logger18.info(),cleanup(),fixResults};function getMigrationSummary(fixResults,fixSummary,logFile){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",successfulFixesMessage=fixSummary.succeeded.length>0?`
|
|
313
|
+
${chalk22.bold("Successful migrations:")}
|
|
299
314
|
|
|
300
|
-
${fixSummary.succeeded.map(m=>
|
|
315
|
+
${fixSummary.succeeded.map(m=>chalk22.green(m)).join(", ")}
|
|
301
316
|
`:"",failedFixesMessage=Object.keys(fixSummary.failed).length>0?`
|
|
302
|
-
${
|
|
317
|
+
${chalk22.bold("Failed migrations:")}
|
|
303
318
|
${Object.entries(fixSummary.failed).reduce((acc,[id,error])=>`${acc}
|
|
304
|
-
${
|
|
319
|
+
${chalk22.redBright(id)}:
|
|
305
320
|
${error}
|
|
306
321
|
`,"")}
|
|
307
322
|
|
|
308
|
-
You can find the full logs in ${
|
|
323
|
+
You can find the full logs in ${chalk22.cyan(logFile)}
|
|
309
324
|
`:"",manualFixesMessage=fixSummary.manual.length>0?`
|
|
310
|
-
${
|
|
325
|
+
${chalk22.bold("Manual migrations:")}
|
|
311
326
|
|
|
312
|
-
${fixSummary.manual.map(m=>fixResults[m]==="manual_succeeded"?
|
|
327
|
+
${fixSummary.manual.map(m=>fixResults[m]==="manual_succeeded"?chalk22.green(m):chalk22.blue(m)).join(", ")}
|
|
313
328
|
`:"",skippedFixesMessage=fixSummary.skipped.length>0?`
|
|
314
|
-
${
|
|
329
|
+
${chalk22.bold("Skipped migrations:")}
|
|
315
330
|
|
|
316
|
-
${fixSummary.skipped.map(m=>
|
|
317
|
-
`:"",summaryMessage=
|
|
331
|
+
${fixSummary.skipped.map(m=>chalk22.cyan(m)).join(", ")}
|
|
332
|
+
`:"",summaryMessage=dedent26`
|
|
318
333
|
${successfulFixesMessage}${manualFixesMessage}${failedFixesMessage}${skippedFixesMessage}${hasNoFixes?"":`
|
|
319
334
|
\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500
|
|
320
335
|
|
|
321
|
-
`}If you'd like to run the migrations again, you can do so by running '${
|
|
336
|
+
`}If you'd like to run the migrations again, you can do so by running '${chalk22.cyan("npx storybook@next automigrate")}'
|
|
322
337
|
|
|
323
338
|
The automigrations try to migrate common patterns in your project, but might not contain everything needed to migrate to the latest version of Storybook.
|
|
324
339
|
|
|
325
|
-
Please check the changelog and migration guide for manual migrations and more information: ${
|
|
326
|
-
And reach out on Discord if you need help: ${
|
|
340
|
+
Please check the changelog and migration guide for manual migrations and more information: ${chalk22.yellow("https://storybook.js.org/migration-guides/7.0")}
|
|
341
|
+
And reach out on Discord if you need help: ${chalk22.yellow("https://discord.gg/storybook")}
|
|
327
342
|
`;return boxen(summaryMessage,{borderStyle:"round",padding:1,title,borderColor:hasFailures?"red":"green"})}var logger19=console,installStorybook=(projectType,packageManager,options)=>{let npmOptions={installAsDevDependencies:!0,skipInstall:options.skipInstall},packageJson;try{packageJson=packageManager.readPackageJson()}catch{}let language=detectLanguage(packageJson),pnp=detectPnp(),generatorOptions={language,builder:options.builder||detectBuilder(packageManager,projectType),linkable:!!options.linkable,pnp:pnp||options.usePnp};return(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
|
|
328
343
|
`));case"REACT_NATIVE":return REACT_NATIVE_default(packageManager,npmOptions).then(commandLog(`Adding Storybook support to your "React Native" app
|
|
329
344
|
`));case"QWIK":return QWIK_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Qwik" app
|
|
@@ -349,73 +364,73 @@ You can find the full logs in ${chalk20.cyan(logFile)}
|
|
|
349
364
|
`));case"SERVER":return SERVER_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Server" app
|
|
350
365
|
`));case"NX":return paddedLog("We have detected Nx in your project. Please use `nx g @nrwl/storybook:configuration` to add Storybook to your project."),paddedLog("For more information, please see https://nx.dev/packages/storybook"),Promise.reject();case"SOLID":return SOLID_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "SolidJS" app
|
|
351
366
|
`));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"),logger19.log(),Promise.resolve();default:return paddedLog(`We couldn't detect your project type. (code: ${projectType})`),paddedLog("You can specify a project type explicitly via `sb init --type <type>`, see our docs on how to configure Storybook for your framework: https://storybook.js.org/docs/react/get-started/install"),logger19.log(),projectTypeInquirer(options,packageManager)}})().catch(ex=>{logger19.error(`
|
|
352
|
-
${
|
|
367
|
+
${chalk23.red(ex.stack)}`),process.exit(1)})},projectTypeInquirer=async(options,packageManager)=>{let manualAnswer=options.yes?!0:await prompts6([{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 prompts6([{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.";logger19.log(chalk23.inverse(`
|
|
353
368
|
${welcomeMessage}
|
|
354
369
|
`));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=packageManager.retrievePackageJson();try{projectTypeProvided?installableProjectTypes.includes(projectTypeProvided)?projectType=projectTypeProvided.toUpperCase():(done(`The provided project type was not recognized by Storybook: ${projectTypeProvided}`),logger19.log(`
|
|
355
370
|
The project types currently supported by Storybook are:
|
|
356
371
|
`),installableProjectTypes.sort().forEach(framework=>paddedLog(`- ${framework}`)),logger19.log(),process.exit(1)):projectType=detect(packageJson,options)}catch(ex){done(ex.message),process.exit(1)}done();let storybookInstalled=isStorybookInstalled(packageJson,options.force);if(storybookInstalled&&projectType!=="ANGULAR"){logger19.log(),paddedLog("There seems to be a Storybook already available in this project."),paddedLog(`Apply following command to force:
|
|
357
372
|
`),codeLog(["sb init [options] -f"]),logger19.log();return}let installResult=await installStorybook(projectType,packageManager,options).catch(e=>{process.exit()});!options.skipInstall&&!storybookInstalled&&packageManager.installDependencies(),options.disableTelemetry||telemetry("init",{projectType}),projectType!=="REACT_NATIVE"&&await automigrate({yes:options.yes||process.env.CI==="true",packageManager:pkgMgr,fixes:initFixes}),logger19.log(`
|
|
358
|
-
For more information visit:`,
|
|
373
|
+
For more information visit:`,chalk23.cyan("https://storybook.js.org")),projectType==="ANGULAR"?(logger19.log(`
|
|
359
374
|
To run your Storybook, type:
|
|
360
|
-
`),codeLog([`ng run ${installResult.projectName}:storybook`])):projectType==="REACT_NATIVE"?(logger19.log(),logger19.log(
|
|
375
|
+
`),codeLog([`ng run ${installResult.projectName}:storybook`])):projectType==="REACT_NATIVE"?(logger19.log(),logger19.log(chalk23.yellow(`NOTE: installation is not 100% automated.
|
|
361
376
|
`)),logger19.log(`To quickly run Storybook, replace contents of your app entry with:
|
|
362
377
|
`),codeLog(["export {default} from './.storybook';"]),logger19.log(`
|
|
363
378
|
Then to run your Storybook, type:
|
|
364
379
|
`),codeLog([packageManager.getRunCommand("start")]),logger19.log(`
|
|
365
380
|
For more in information, see the github readme:
|
|
366
|
-
`),logger19.log(
|
|
381
|
+
`),logger19.log(chalk23.cyan("https://github.com/storybookjs/react-native")),logger19.log()):(logger19.log(`
|
|
367
382
|
To run your Storybook, type:
|
|
368
|
-
`),codeLog([packageManager.getRunStorybookCommand()])),logger19.log()}async function initiate(options,pkg2){await withTelemetry("init",{cliOptions:options},()=>doInitiate(options,pkg2))}import path4 from"path";import fs4 from"fs";import{sync as spawnSync}from"cross-spawn";import{getStorybookInfo as getStorybookInfo4}from"@storybook/core-common";import{readConfig as readConfig3,writeConfig as writeConfig3}from"@storybook/csf-tools";var logger20=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=path4.join(".storybook",`${config}.ts`);fs4.existsSync(configFile)||(configFile=path4.join(".storybook",`${config}.js`),fs4.existsSync(configFile)||fs4.writeFileSync(configFile,"","utf8")),spawnSync("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=packageManager.retrievePackageJson(),[addonName,versionSpecifier]=getVersionSpecifier(addon),{mainConfig,version:storybookVersion}=getStorybookInfo4(packageJson);if(!mainConfig){logger20.error("Unable to find storybook main.js config");return}let main=await readConfig3(mainConfig),addons=main.getFieldValue(["addons"]);addons&&!Array.isArray(addons)&&logger20.error("Expected addons array in main.js config"),logger20.log(`Verifying ${addonName}`);let latestVersion=packageManager.latestVersion(addonName);latestVersion||logger20.error(`Unknown addon ${addonName}`);let isStorybookAddon=addonName.startsWith("@storybook/"),addonWithVersion=`${addonName}@${versionSpecifier||(isStorybookAddon?storybookVersion:latestVersion)}`;logger20.log(`Installing ${addonWithVersion}`),packageManager.addDependencies({installAsDevDependencies:!0},[addonWithVersion]),logger20.log(`Adding '${addon}' to main.js addons field.`);let updatedAddons=[...addons||[],addonName];main.setFieldValue(["addons"],updatedAddons),await writeConfig3(main),options.skipPostinstall||await postinstallAddon(addon,isStorybookAddon)}import{listCodemods,runCodemod}from"@storybook/codemod";async function migrate(migration,{glob,dryRun,list,rename,logger:
|
|
383
|
+
`),codeLog([packageManager.getRunStorybookCommand()])),logger19.log()}async function initiate(options,pkg2){await withTelemetry("init",{cliOptions:options},()=>doInitiate(options,pkg2))}import path4 from"path";import fs4 from"fs";import{sync as spawnSync}from"cross-spawn";import{getStorybookInfo as getStorybookInfo4}from"@storybook/core-common";import{readConfig as readConfig3,writeConfig as writeConfig3}from"@storybook/csf-tools";var logger20=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=path4.join(".storybook",`${config}.ts`);fs4.existsSync(configFile)||(configFile=path4.join(".storybook",`${config}.js`),fs4.existsSync(configFile)||fs4.writeFileSync(configFile,"","utf8")),spawnSync("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=packageManager.retrievePackageJson(),[addonName,versionSpecifier]=getVersionSpecifier(addon),{mainConfig,version:storybookVersion}=getStorybookInfo4(packageJson);if(!mainConfig){logger20.error("Unable to find storybook main.js config");return}let main=await readConfig3(mainConfig),addons=main.getFieldValue(["addons"]);addons&&!Array.isArray(addons)&&logger20.error("Expected addons array in main.js config"),logger20.log(`Verifying ${addonName}`);let latestVersion=packageManager.latestVersion(addonName);latestVersion||logger20.error(`Unknown addon ${addonName}`);let isStorybookAddon=addonName.startsWith("@storybook/"),addonWithVersion=`${addonName}@${versionSpecifier||(isStorybookAddon?storybookVersion:latestVersion)}`;logger20.log(`Installing ${addonWithVersion}`),packageManager.addDependencies({installAsDevDependencies:!0},[addonWithVersion]),logger20.log(`Adding '${addon}' to main.js addons field.`);let updatedAddons=[...addons||[],addonName];main.setFieldValue(["addons"],updatedAddons),await writeConfig3(main),options.skipPostinstall||await postinstallAddon(addon,isStorybookAddon)}import{listCodemods,runCodemod}from"@storybook/codemod";async function migrate(migration,{glob,dryRun,list,rename,logger:logger27,parser}){if(list)listCodemods().forEach(key=>logger27.log(key));else if(migration)await runCodemod(migration,{glob,dryRun,logger:logger27,rename,parser});else throw new Error("Migrate: please specify a migration name or --list")}import path5 from"path";import{writeFile as writeFile2,stat}from"fs-extra";import puppeteerCore from"puppeteer-core";import express from"express";import getPort from"get-port";import{logger as logger21}from"@storybook/node-logger";var read=async url=>{let browser=await usePuppeteerBrowser(),page=await browser.newPage();await page.goto(url),await page.waitForFunction(`
|
|
369
384
|
(window.__STORYBOOK_PREVIEW__ && window.__STORYBOOK_PREVIEW__.extract && window.__STORYBOOK_PREVIEW__.extract()) ||
|
|
370
385
|
(window.__STORYBOOK_STORY_STORE__ && window.__STORYBOOK_STORY_STORE__.extract && window.__STORYBOOK_STORY_STORE__.extract())
|
|
371
|
-
`);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(path5.resolve(input)),input.match(/^http/))return[input,async()=>{}];let app=express();app.use(express.static(input));let port=await getPort();return new Promise(resolve=>{let server=app.listen(port,()=>{let result=`http://localhost:${port}/iframe.html`;logger21.info(`connecting to: ${result}`),resolve([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 logger21.info("installing puppeteer..."),new Promise((resolve,reject)=>{__require("child_process").exec(`node ${__require.resolve(path5.join("puppeteer-core","install.js"))}`,error=>error?reject(error):resolve(puppeteerCore.launch({args})))})}};async function extract(input,targetPath){if(input&&targetPath){let[location,exit]=await useLocation(input),data=await read(location);await writeFile2(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")}import{sync as spawnSync2}from"cross-spawn";import{telemetry as telemetry2,getStorybookCoreVersion}from"@storybook/telemetry";import
|
|
372
|
-
`).map(getStorybookVersion).filter(Boolean).filter(pkg2=>isCorePackage(pkg2.package));if(!storybookPackages.length){logger22.warn("No storybook core packages found."),logger22.warn("'npm ls | grep storybook' can show if multiple versions are installed.");return}storybookPackages.sort((a,b)=>
|
|
386
|
+
`);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(path5.resolve(input)),input.match(/^http/))return[input,async()=>{}];let app=express();app.use(express.static(input));let port=await getPort();return new Promise(resolve=>{let server=app.listen(port,()=>{let result=`http://localhost:${port}/iframe.html`;logger21.info(`connecting to: ${result}`),resolve([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 logger21.info("installing puppeteer..."),new Promise((resolve,reject)=>{__require("child_process").exec(`node ${__require.resolve(path5.join("puppeteer-core","install.js"))}`,error=>error?reject(error):resolve(puppeteerCore.launch({args})))})}};async function extract(input,targetPath){if(input&&targetPath){let[location,exit]=await useLocation(input),data=await read(location);await writeFile2(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")}import{sync as spawnSync2}from"cross-spawn";import{telemetry as telemetry2,getStorybookCoreVersion}from"@storybook/telemetry";import semver20 from"semver";import{logger as logger22}from"@storybook/node-logger";import{withTelemetry as withTelemetry2}from"@storybook/core-server";var versionRegex=/(@storybook\/[^@]+)@(\S+)/,getStorybookVersion=line=>{if(line.startsWith("npm "))return null;let match=versionRegex.exec(line);return!match||!semver20.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=>logger22.warn(`- ${formatPackage(pkg2)}`)),checkVersionConsistency=()=>{let storybookPackages=spawnSync2("npm",["ls"],{stdio:"pipe",shell:!0}).output.toString().split(`
|
|
387
|
+
`).map(getStorybookVersion).filter(Boolean).filter(pkg2=>isCorePackage(pkg2.package));if(!storybookPackages.length){logger22.warn("No storybook core packages found."),logger22.warn("'npm ls | grep storybook' can show if multiple versions are installed.");return}storybookPackages.sort((a,b)=>semver20.rcompare(a.version,b.version));let latestVersion=storybookPackages[0].version,outdated=storybookPackages.filter(pkg2=>pkg2.version!==latestVersion);outdated.length>0&&(logger22.warn(`Found ${outdated.length} outdated packages (relative to '${formatPackage(storybookPackages[0])}')`),logger22.warn("Please make sure your packages are updated to ensure a consistent experience."),warnPackages(outdated)),deprecatedPackages.forEach(({minVersion,url,deprecations})=>{if(semver20.gte(latestVersion,minVersion)){let deprecated=storybookPackages.filter(pkg2=>deprecations.includes(pkg2.package));deprecated.length>0&&(logger22.warn(`Found ${deprecated.length} deprecated packages since ${minVersion}`),logger22.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&&semver20.satisfies(semver20.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,packageManager.retrievePackageJson());let check=spawnSync2("npx",["npm-check-updates@latest","/storybook/",...flags],{stdio:"pipe",shell:!0}).output.toString();logger22.info(check);let checkSb=spawnSync2("npx",["npm-check-updates@latest","sb",...flags],{stdio:"pipe",shell:!0}).output.toString();logger22.info(checkSb),dryRun||(commandLog("Installing upgrades"),packageManager.installDependencies());let automigrationResults;if(skipCheck||(checkVersionConsistency(),automigrationResults=await automigrate({dryRun,yes,packageManager:pkgMgr,configDir})),!options.disableTelemetry){let afterVersion=await getStorybookCoreVersion(),{preCheckFailure,...results}=automigrationResults||{};telemetry2("upgrade",{prerelease,tag,beforeVersion,afterVersion,...{automigrationResults:preCheckFailure?null:results,automigrationPreCheckFailure:preCheckFailure||null}})}};async function upgrade(options){await withTelemetry2("upgrade",{cliOptions:options},()=>doUpgrade(options))}import prompts7 from"prompts";import path6 from"path";import chalk24 from"chalk";import boxen2 from"boxen";import{dedent as dedent27}from"ts-dedent";import{downloadTemplate}from"giget";import{existsSync,readdir}from"fs-extra";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"}},"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"}},"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"}},"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"}},"react-vite/default-js":{name:"React Vite (JS)",script:"yarn create vite . --template react",expected:{framework:"@storybook/react-vite",renderer:"@storybook/react",builder:"@storybook/builder-vite"}},"react-vite/default-ts":{name:"React Vite (TS)",script:"yarn create vite . --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"}},"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"}},"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},"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},"vue3-vite/default-js":{name:"Vue3 Vite (JS)",script:"yarn create vite . --template vue",expected:{framework:"@storybook/vue3-vite",renderer:"@storybook/vue3",builder:"@storybook/builder-vite"}},"vue3-vite/default-ts":{name:"Vue3 Vite (TS)",script:"yarn create vite . --template vue-ts",expected:{framework:"@storybook/vue3-vite",renderer:"@storybook/vue3",builder:"@storybook/builder-vite"}},"vue2-vite/2.7-js":{name:"Vue2 Vite (vue 2.7 JS)",script:`yarn create vite . --template vanilla && yarn add --dev @vitejs/plugin-vue2 vue-template-compiler vue@2 && echo "import vue2 from '@vitejs/plugin-vue2';
|
|
373
388
|
|
|
374
389
|
export default {
|
|
375
390
|
plugins: [vue2()]
|
|
376
|
-
};" > vite.config.js`,skipTasks:["smoke-test"],expected:{framework:"@storybook/vue-vite",renderer:"@storybook/vue",builder:"@storybook/builder-vite"}},"html-webpack/default":{name:"HTML Webpack5",script:"yarn create webpack5-html .",expected:{framework:"@storybook/html-webpack5",renderer:"@storybook/html",builder:"@storybook/builder-webpack5"}},"html-vite/default-js":{name:"HTML Vite JS",script:'yarn create vite . --template vanilla && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/html-vite",renderer:"@storybook/html",builder:"@storybook/builder-vite"}},"html-vite/default-ts":{name:"HTML Vite TS",script:'yarn create vite . --template vanilla-ts && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/html-vite",renderer:"@storybook/html",builder:"@storybook/builder-vite"}},"svelte-vite/default-js":{name:"Svelte Vite (JS)",script:"yarn create vite . --template svelte",expected:{framework:"@storybook/svelte-vite",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"}},"svelte-vite/default-ts":{name:"Svelte Vite (TS)",script:"yarn create vite . --template svelte-ts",skipTasks:["smoke-test"],expected:{framework:"@storybook/svelte-vite",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"}},"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"}},"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"}},"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"}},"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"}},"lit-vite/default-js":{name:"Lit Vite (JS)",script:"yarn create vite . --template lit",skipTasks:["smoke-test"],expected:{framework:"@storybook/web-components-vite",renderer:"@storybook/web-components",builder:"@storybook/builder-vite"}},"lit-vite/default-ts":{name:"Lit Vite (TS)",script:"yarn create vite . --template lit-ts",skipTasks:["smoke-test"],expected:{framework:"@storybook/web-components-vite",renderer:"@storybook/web-components",builder:"@storybook/builder-vite"}},"vue-cli/default-js":{name:"Vue-CLI (Default JS)",script:"npx -p @vue/cli vue create . --default --packageManager=yarn --force --merge",skipTasks:["smoke-test"],expected:{framework:"@storybook/vue3-webpack5",renderer:"@storybook/vue3",builder:"@storybook/builder-webpack5"}},"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)"',skipTasks:["smoke-test"],expected:{framework:"@storybook/vue-webpack5",renderer:"@storybook/vue",builder:"@storybook/builder-webpack5"}},"preact-webpack5/default-js":{name:"Preact CLI (Default JS)",script:"npx preact-cli create default {{beforeDir}} --name preact-app --yarn --no-install",expected:{framework:"@storybook/preact-webpack5",renderer:"@storybook/preact",builder:"@storybook/builder-webpack5"}},"preact-webpack5/default-ts":{name:"Preact CLI (Default TS)",script:"npx preact-cli create typescript {{beforeDir}} --name preact-app --yarn --no-install",expected:{framework:"@storybook/preact-webpack5",renderer:"@storybook/preact",builder:"@storybook/builder-webpack5"}},"preact-vite/default-js":{name:"Preact Vite (JS)",script:"yarn create vite . --template preact",expected:{framework:"@storybook/preact-vite",renderer:"@storybook/preact",builder:"@storybook/builder-vite"}},"preact-vite/default-ts":{name:"Preact Vite (TS)",script:"yarn create vite . --template preact-ts",expected:{framework:"@storybook/preact-vite",renderer:"@storybook/preact",builder:"@storybook/builder-vite"}},"qwik-vite/default-ts":{name:"Qwik CLI (Default TS)",script:"yarn create qwik basic {{beforeDir}} --no-install",skipTasks:["e2e-tests"],inDevelopment:!0,expected:{framework:"storybook-framework-qwik",renderer:"storybook-framework-qwik",builder:"storybook-framework-qwik"}}},internalTemplates={"internal/ssv6-vite":{...baseTemplates["react-vite/default-ts"],name:"StoryStore v6 (react-vite/default-ts)",isInternal:!0,modifications:{mainConfig:{features:{storyStoreV7:!1}}}},"internal/ssv6-webpack":{...baseTemplates["react-webpack/18-ts"],name:"StoryStore v6 (react-webpack/18-ts)",isInternal:!0,modifications:{mainConfig:{features:{storyStoreV7:!1}}}},"internal/pnp":{...baseTemplates["react-webpack/18-ts"],name:"PNP (react-webpack/18-ts)",script:"yarn create react-app . --use-pnp",isInternal:!0,inDevelopment:!0}},allTemplates={...baseTemplates,...internalTemplates},ci=["cra/default-ts","react-vite/default-ts"],pr=[...ci,"angular-cli/default-ts","vue3-vite/default-ts","vue-cli/vue2-default-js","lit-vite/default-ts","svelte-vite/default-ts","svelte-kit/skeleton-ts","nextjs/default-ts"],merged=[...pr,"react-webpack/18-ts","react-webpack/17-ts","angular-cli/14-ts","preact-webpack5/default-ts","preact-vite/default-ts","html-webpack/default","html-vite/default-ts","internal/ssv6-vite","internal/ssv6-webpack"],daily=[...merged,"cra/default-js","react-vite/default-js","vue3-vite/default-js","vue2-vite/2.7-js","vue-cli/default-js","lit-vite/default-js","svelte-kit/skeleton-js","svelte-vite/default-js","nextjs/12-js","nextjs/default-js","qwik-vite/default-ts","preact-webpack5/default-js","preact-vite/default-js","html-vite/default-js"];var logger23=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&&(logger23.info(boxen2(
|
|
391
|
+
};" > vite.config.js`,skipTasks:["smoke-test"],expected:{framework:"@storybook/vue-vite",renderer:"@storybook/vue",builder:"@storybook/builder-vite"}},"html-webpack/default":{name:"HTML Webpack5",script:"yarn create webpack5-html .",expected:{framework:"@storybook/html-webpack5",renderer:"@storybook/html",builder:"@storybook/builder-webpack5"}},"html-vite/default-js":{name:"HTML Vite JS",script:'yarn create vite . --template vanilla && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/html-vite",renderer:"@storybook/html",builder:"@storybook/builder-vite"}},"html-vite/default-ts":{name:"HTML Vite TS",script:'yarn create vite . --template vanilla-ts && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/html-vite",renderer:"@storybook/html",builder:"@storybook/builder-vite"}},"svelte-vite/default-js":{name:"Svelte Vite (JS)",script:"yarn create vite . --template svelte",expected:{framework:"@storybook/svelte-vite",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"}},"svelte-vite/default-ts":{name:"Svelte Vite (TS)",script:"yarn create vite . --template svelte-ts",skipTasks:["smoke-test"],expected:{framework:"@storybook/svelte-vite",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"}},"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"}},"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"}},"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"}},"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"}},"lit-vite/default-js":{name:"Lit Vite (JS)",script:"yarn create vite . --template lit",skipTasks:["smoke-test"],expected:{framework:"@storybook/web-components-vite",renderer:"@storybook/web-components",builder:"@storybook/builder-vite"}},"lit-vite/default-ts":{name:"Lit Vite (TS)",script:"yarn create vite . --template lit-ts",skipTasks:["smoke-test"],expected:{framework:"@storybook/web-components-vite",renderer:"@storybook/web-components",builder:"@storybook/builder-vite"}},"vue-cli/default-js":{name:"Vue-CLI (Default JS)",script:"npx -p @vue/cli vue create . --default --packageManager=yarn --force --merge",skipTasks:["smoke-test"],expected:{framework:"@storybook/vue3-webpack5",renderer:"@storybook/vue3",builder:"@storybook/builder-webpack5"}},"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)"',skipTasks:["smoke-test"],expected:{framework:"@storybook/vue-webpack5",renderer:"@storybook/vue",builder:"@storybook/builder-webpack5"}},"preact-webpack5/default-js":{name:"Preact CLI (Default JS)",script:"npx preact-cli create default {{beforeDir}} --name preact-app --yarn --no-install",expected:{framework:"@storybook/preact-webpack5",renderer:"@storybook/preact",builder:"@storybook/builder-webpack5"}},"preact-webpack5/default-ts":{name:"Preact CLI (Default TS)",script:"npx preact-cli create typescript {{beforeDir}} --name preact-app --yarn --no-install",expected:{framework:"@storybook/preact-webpack5",renderer:"@storybook/preact",builder:"@storybook/builder-webpack5"}},"preact-vite/default-js":{name:"Preact Vite (JS)",script:"yarn create vite . --template preact",expected:{framework:"@storybook/preact-vite",renderer:"@storybook/preact",builder:"@storybook/builder-vite"}},"preact-vite/default-ts":{name:"Preact Vite (TS)",script:"yarn create vite . --template preact-ts",expected:{framework:"@storybook/preact-vite",renderer:"@storybook/preact",builder:"@storybook/builder-vite"}},"qwik-vite/default-ts":{name:"Qwik CLI (Default TS)",script:"yarn create qwik basic {{beforeDir}} --no-install",skipTasks:["e2e-tests"],inDevelopment:!0,expected:{framework:"storybook-framework-qwik",renderer:"storybook-framework-qwik",builder:"storybook-framework-qwik"}}},internalTemplates={"internal/ssv6-vite":{...baseTemplates["react-vite/default-ts"],name:"StoryStore v6 (react-vite/default-ts)",isInternal:!0,modifications:{mainConfig:{features:{storyStoreV7:!1}}}},"internal/ssv6-webpack":{...baseTemplates["react-webpack/18-ts"],name:"StoryStore v6 (react-webpack/18-ts)",isInternal:!0,modifications:{mainConfig:{features:{storyStoreV7:!1}}}},"internal/pnp":{...baseTemplates["react-webpack/18-ts"],name:"PNP (react-webpack/18-ts)",script:"yarn create react-app . --use-pnp",isInternal:!0,inDevelopment:!0}},allTemplates={...baseTemplates,...internalTemplates},ci=["cra/default-ts","react-vite/default-ts"],pr=[...ci,"angular-cli/default-ts","vue3-vite/default-ts","vue-cli/vue2-default-js","lit-vite/default-ts","svelte-vite/default-ts","svelte-kit/skeleton-ts","nextjs/default-ts"],merged=[...pr,"react-webpack/18-ts","react-webpack/17-ts","angular-cli/14-ts","preact-webpack5/default-ts","preact-vite/default-ts","html-webpack/default","html-vite/default-ts","internal/ssv6-vite","internal/ssv6-webpack"],daily=[...merged,"cra/default-js","react-vite/default-js","vue3-vite/default-js","vue2-vite/2.7-js","vue-cli/default-js","lit-vite/default-js","svelte-kit/skeleton-js","svelte-vite/default-js","nextjs/12-js","nextjs/default-js","qwik-vite/default-ts","preact-webpack5/default-js","preact-vite/default-js","html-vite/default-js"];var logger23=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&&(logger23.info(boxen2(dedent27`
|
|
377
392
|
🔎 You filtered out all templates. 🔍
|
|
378
393
|
|
|
379
|
-
After filtering all the templates with "${
|
|
394
|
+
After filtering all the templates with "${chalk24.yellow(filterValue)}", we found no results. Please try again with a different filter.
|
|
380
395
|
|
|
381
396
|
Available templates:
|
|
382
|
-
${keys.map(key=>
|
|
397
|
+
${keys.map(key=>chalk24.blue`- ${key}`).join(`
|
|
383
398
|
`)}
|
|
384
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),process.exit(1)),choices.length===1?[selectedTemplate]=choices:(logger23.info(boxen2(
|
|
385
|
-
🤗 Welcome to ${
|
|
399
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),process.exit(1)),choices.length===1?[selectedTemplate]=choices:(logger23.info(boxen2(dedent27`
|
|
400
|
+
🤗 Welcome to ${chalk24.yellow("sb sandbox")}! 🤗
|
|
386
401
|
|
|
387
|
-
Create a ${
|
|
402
|
+
Create a ${chalk24.green("new project")} to minimally reproduce Storybook issues.
|
|
388
403
|
|
|
389
404
|
1. select an environment that most closely matches your project setup.
|
|
390
405
|
2. select a location for the reproduction, outside of your project.
|
|
391
406
|
|
|
392
407
|
After the reproduction is ready, we'll guide you through the next steps.
|
|
393
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),selectedTemplate=await promptSelectedTemplate(choices)),!!!(selectedTemplate??null)){logger23.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}`)&&logger23.info(`\u26A0\uFE0F ${selectedDirectory} already exists! Overwriting...`),!selectedDirectory){let{directory}=await
|
|
394
|
-
Are you use it exists? Or did you want to set ${
|
|
395
|
-
yarn storybook`):`Recreate your setup, then ${
|
|
408
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),selectedTemplate=await promptSelectedTemplate(choices)),!!!(selectedTemplate??null)){logger23.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}`)&&logger23.info(`\u26A0\uFE0F ${selectedDirectory} already exists! Overwriting...`),!selectedDirectory){let{directory}=await prompts7({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:()=>{logger23.log("Command cancelled by the user. Exiting..."),process.exit(1)}});selectedDirectory=directory}try{let templateDestination=path6.isAbsolute(selectedDirectory)?selectedDirectory:path6.join(process.cwd(),selectedDirectory);logger23.info(`\u{1F3C3} Adding ${selectedConfig.name} into ${templateDestination}`),logger23.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(dedent27`Template downloaded from ${chalk24.blue(gitPath)} is empty.
|
|
409
|
+
Are you use it exists? Or did you want to set ${chalk24.yellow(selectedTemplate)} to inDevelopment first?`)}catch(err){throw logger23.error(`\u{1F6A8} Failed to download sandbox template: ${err.message}`),err}let initMessage=init?chalk24.yellow(`yarn install
|
|
410
|
+
yarn storybook`):`Recreate your setup, then ${chalk24.yellow("run npx storybook init")}`;logger23.info(boxen2(dedent27`
|
|
396
411
|
🎉 Your Storybook reproduction project is ready to use! 🎉
|
|
397
412
|
|
|
398
|
-
${
|
|
413
|
+
${chalk24.yellow(`cd ${selectedDirectory}`)}
|
|
399
414
|
${initMessage}
|
|
400
415
|
|
|
401
416
|
Once you've recreated the problem you're experiencing, please:
|
|
402
417
|
|
|
403
|
-
1. Document any additional steps in ${
|
|
418
|
+
1. Document any additional steps in ${chalk24.cyan("README.md")}
|
|
404
419
|
2. Publish the repository to github
|
|
405
420
|
3. Link to the repro repository in your issue
|
|
406
421
|
|
|
407
422
|
Having a clean repro helps us solve your issue faster! 🙏
|
|
408
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}))}catch(error){throw logger23.error("\u{1F6A8} Failed to create sandbox"),error}};async function promptSelectedTemplate(choices){let{template}=await
|
|
423
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}))}catch(error){throw logger23.error("\u{1F6A8} Failed to create sandbox"),error}};async function promptSelectedTemplate(choices){let{template}=await prompts7({type:"select",message:"\u{1F308} Select the template",name:"template",choices:choices.map(toChoices)},{onCancel:()=>{logger23.log("Command cancelled by the user. Exiting..."),process.exit(1)}});return template||null}import fse5 from"fs-extra";import path7 from"path";import{sync as spawnSync3}from"cross-spawn";import{logger as logger24}from"@storybook/node-logger";import shell from"shelljs";import chalk25 from"chalk";var exec=async(command2,options={},{startMessage,errorMessage,dryRun}={})=>{if(startMessage&&logger24.info(startMessage),dryRun){logger24.info(`
|
|
409
424
|
> ${command2}
|
|
410
|
-
`);return}return logger24.info(command2),new Promise((resolve,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?resolve(void 0):(logger24.error(
|
|
425
|
+
`);return}return logger24.info(command2),new Promise((resolve,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?resolve(void 0):(logger24.error(chalk25.red(`An error occurred while executing: \`${command2}\``)),logger24.info(errorMessage),reject(new Error(`command exited with code: ${code}: `)))})})},link=async({target,local,start})=>{let storybookDir=process.cwd();try{if((await fse5.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=path7.basename(target);if(!local){let reprosDir=path7.join(storybookDir,"../storybook-repros");logger24.info(`Ensuring directory ${reprosDir}`),await fse5.ensureDir(reprosDir),logger24.info(`Cloning ${target}`),await exec(`git clone ${target}`,{cwd:reprosDir}),reproName=path7.basename(target,path7.extname(target)),reproDir=path7.join(reprosDir,reproName)}let reproPackageJson=await fse5.readJSON(path7.join(reproDir,"package.json")),version=spawnSync3("yarn",["--version"],{cwd:reproDir,stdio:"pipe",shell:!0}).stdout.toString();if(!/^[23]\./.test(version)){logger24.warn(`\u{1F6A8} Expected yarn 2 or 3 in ${reproDir}!`),logger24.warn(""),logger24.warn("Please set it up with `yarn set version berry`,"),logger24.warn(`then link '${reproDir}' with the '--local' flag.`);return}logger24.info(`Linking ${reproDir}`),await exec(`yarn link --all ${storybookDir}`,{cwd:reproDir}),logger24.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&&(logger24.info(`Running ${reproName} storybook`),await exec("yarn run storybook",{cwd:reproDir}))};import{dedent as dedent28}from"ts-dedent";import{sync as readUpSync}from"read-pkg-up";import{logger as logger25,instance as npmLog}from"@storybook/node-logger";import{buildDevStandalone,withTelemetry as withTelemetry3}from"@storybook/core-server";import{cache}from"@storybook/core-common";function printError(error){npmLog.heading="",error instanceof Error?error.error?logger25.error(error.error):error.stats&&error.stats.compilation.errors?error.stats.compilation.errors.forEach(e=>logger25.plain(e)):logger25.error(error):error.compilation?.errors&&error.compilation.errors.forEach(e=>logger25.plain(e)),logger25.line(),logger25.warn(error.close?dedent28`
|
|
411
426
|
FATAL broken build!, will close the process,
|
|
412
427
|
Fix the error below and restart storybook.
|
|
413
|
-
`:
|
|
428
|
+
`:dedent28`
|
|
414
429
|
Broken build, fix the error above.
|
|
415
430
|
You may need to refresh the browser.
|
|
416
|
-
`),logger25.line()
|
|
417
|
-
Environment Info:`)),envinfo.run({System:["OS","CPU"],Binaries:["Node","Yarn","npm"],Browsers:["Chrome","Edge","Firefox","Safari"],npmPackages:"@storybook/*",npmGlobalPackages:"@storybook/*"}).then(consoleLogger.log)});command("migrate [migration]").description("Run a Storybook codemod migration on your source files").option("-l --list","List available migrations").option("-g --glob <glob>","Glob for files upon which to apply the migration","**/*.js").option("-p --parser <babel | babylon | flow | ts | tsx>","jscodeshift parser").option("-n --dry-run","Dry run: verify the migration exists and show the files to which it will be applied").option("-r --rename <from-to>",'Rename suffix of matching files after codemod has been applied, e.g. ".js:.ts"').action((migration,{configDir,glob,dryRun,list,rename,parser})=>{migrate(migration,{configDir,glob,dryRun,list,rename,parser,logger:consoleLogger}).catch(err=>{
|
|
418
|
-
`)),getEnvConfig(program,{port:"SBCONFIG_PORT",host:"SBCONFIG_HOSTNAME",staticDir:"SBCONFIG_STATIC_DIR",configDir:"SBCONFIG_CONFIG_DIR",ci:"CI"}),typeof program.port=="string"&&program.port.length>0&&(program.port=parseInt(program.port,10)),dev({...options,packageJson:pkg})});command("build").option("-s, --static-dir <dir-names>","Directory where to load static files from",parseList).option("-o, --output-dir <dir-name>","Directory where to store built files").option("-c, --config-dir <dir-name>","Directory where to load Storybook configurations from").option("--quiet","Suppress verbose build output").option("--loglevel <level>","Control level of logging during build").option("--debug-webpack","Display final webpack configurations for debugging purposes").option("--webpack-stats-json [directory]","Write Webpack Stats JSON to disk").option("--preview-url <string>","Disables the default storybook preview and lets your use your own").option("--force-build-preview","Build the preview iframe even if you are using --preview-url").option("--docs","Build a documentation-only site using addon-docs").action(options=>{process.env.NODE_ENV=process.env.NODE_ENV||"production",
|
|
419
|
-
`)),getEnvConfig(program,{staticDir:"SBCONFIG_STATIC_DIR",outputDir:"SBCONFIG_OUTPUT_DIR",configDir:"SBCONFIG_CONFIG_DIR"}),build({...options,packageJson:pkg})});program.on("command:*",([invalidCmd])=>{consoleLogger.error(` Invalid command: %s.
|
|
431
|
+
`),logger25.line()}var dev=async cliOptions=>{process.env.NODE_ENV=process.env.NODE_ENV||"development";let options={...cliOptions,configDir:cliOptions.configDir||"./.storybook",configType:"DEVELOPMENT",ignorePreview:!!cliOptions.previewUrl&&!cliOptions.forceBuildPreview,cache,packageJson:readUpSync({cwd:__dirname}).packageJson};await withTelemetry3("dev",{cliOptions,presetOptions:options,printError},()=>buildDevStandalone(options))};import{sync as readUpSync2}from"read-pkg-up";import{buildStaticStandalone,withTelemetry as withTelemetry4}from"@storybook/core-server";import{cache as cache2}from"@storybook/core-common";var build=async cliOptions=>{let options={...cliOptions,configDir:cliOptions.configDir||"./.storybook",outputDir:cliOptions.outputDir||"./storybook-static",ignorePreview:!!cliOptions.previewUrl&&!cliOptions.forceBuildPreview,configType:"PRODUCTION",cache:cache2,packageJson:readUpSync2({cwd:__dirname}).packageJson};await withTelemetry4("build",{cliOptions,presetOptions:options},()=>buildStaticStandalone(options))};function parseList(str){return str.split(",").map(item=>item.trim()).filter(item=>item.length>0)}function getEnvConfig(program2,configEnv){Object.keys(configEnv).forEach(fieldName=>{let envVarName=configEnv[fieldName],envVarValue=process.env[envVarName];envVarValue&&(program2[fieldName]=envVarValue)})}var pkg=readUpSync3({cwd:__dirname}).packageJson,consoleLogger=console,command=name=>program.command(name).option("--disable-telemetry","disable sending telemetry data",process.env.STORYBOOK_DISABLE_TELEMETRY&&process.env.STORYBOOK_DISABLE_TELEMETRY!=="false").option("--debug","Get more logs in debug mode",!1).option("--enable-crash-reports","enable sending crash reports to telemetry data");command("init").description("Initialize Storybook into your project.").option("-f --force","Force add Storybook").option("-s --skip-install","Skip installing deps").option("--package-manager <npm|pnpm|yarn1|yarn2>","Force package manager for installing deps").option("-N --use-npm","Use npm to install deps (deprecated)").option("--use-pnp","Enable pnp mode for Yarn 2+").option("-p --parser <babel | babylon | flow | ts | tsx>","jscodeshift parser").option("-t --type <type>","Add Storybook for a specific project type").option("-y --yes","Answer yes to all prompts").option("-b --builder <webpack5 | vite>","Builder library").option("-l --linkable","Prepare installation for link (contributor helper)").action(options=>{initiate(options,pkg).catch(()=>process.exit(1))});command("add <addon>").description("Add an addon to your Storybook").option("--package-manager <npm|pnpm|yarn1|yarn2>","Force package manager for installing dependencies").option("-N --use-npm","Use NPM to install dependencies (deprecated)").option("-s --skip-postinstall","Skip package specific postinstall config modifications").action((addonName,options)=>add(addonName,options));command("babelrc").description("generate the default storybook babel config into your current working directory").action(()=>generateStorybookBabelConfigInCWD());command("upgrade").description("Upgrade your Storybook packages to the latest").option("--package-manager <npm|pnpm|yarn1|yarn2>","Force package manager for installing dependencies").option("-N --use-npm","Use NPM to install dependencies (deprecated)").option("-y --yes","Skip prompting the user").option("-n --dry-run","Only check for upgrades, do not install").option("-t --tag <tag>","Upgrade to a certain npm dist-tag (e.g. next, prerelease)").option("-p --prerelease","Upgrade to the pre-release packages").option("-s --skip-check","Skip postinstall version and automigration checks").option("-c, --config-dir <dir-name>","Directory where to load Storybook configurations from").action(async options=>upgrade(options).catch(()=>process.exit(1)));command("info").description("Prints debugging information about the local environment").action(()=>{consoleLogger.log(chalk26.bold(`
|
|
432
|
+
Environment Info:`)),envinfo.run({System:["OS","CPU"],Binaries:["Node","Yarn","npm"],Browsers:["Chrome","Edge","Firefox","Safari"],npmPackages:"@storybook/*",npmGlobalPackages:"@storybook/*"}).then(consoleLogger.log)});command("migrate [migration]").description("Run a Storybook codemod migration on your source files").option("-l --list","List available migrations").option("-g --glob <glob>","Glob for files upon which to apply the migration","**/*.js").option("-p --parser <babel | babylon | flow | ts | tsx>","jscodeshift parser").option("-n --dry-run","Dry run: verify the migration exists and show the files to which it will be applied").option("-r --rename <from-to>",'Rename suffix of matching files after codemod has been applied, e.g. ".js:.ts"').action((migration,{configDir,glob,dryRun,list,rename,parser})=>{migrate(migration,{configDir,glob,dryRun,list,rename,parser,logger:consoleLogger}).catch(err=>{logger26.error(err),process.exit(1)})});command("extract [location] [output]").description("extract stories.json from a built version").action((location="storybook-static",output=path8.join(location,"stories.json"))=>extract(location,output).catch(e=>{logger26.error(e),process.exit(1)}));command("sandbox [filterValue]").alias("repro").description("Create a sandbox from a set of possible templates").option("-o --output <outDir>","Define an output directory").option("-b --branch <branch>","Define the branch to download from","next").option("--no-init","Whether to download a template without an initialized Storybook",!1).action((filterValue,options)=>sandbox({filterValue,...options}).catch(e=>{logger26.error(e),process.exit(1)}));command("link <repo-url-or-directory>").description("Pull down a repro from a URL (or a local directory), link it, and run storybook").option("--local","Link a local directory already in your file system").option("--no-start","Start the storybook",!0).action((target,{local,start})=>link({target,local,start}).catch(e=>{logger26.error(e),process.exit(1)}));command("automigrate [fixId]").description("Check storybook for known problems or migrations and apply fixes").option("-y --yes","Skip prompting the user").option("-n --dry-run","Only check for fixes, do not actually run them").option("--package-manager <npm|pnpm|yarn1|yarn2>","Force package manager").option("-N --use-npm","Use npm as package manager (deprecated)").option("-l --list","List available migrations").option("-c, --config-dir <dir-name>","Directory of Storybook configurations to migrate").option("-s --skip-install","Skip installing deps").option("--renderer <renderer-pkg-name>","The renderer package for the framework Storybook is using.").action(async(fixId,options)=>{await automigrate({fixId,...options}).catch(e=>{logger26.error(e),process.exit(1)})});command("dev").option("-p, --port <number>","Port to run Storybook",str=>parseInt(str,10)).option("-h, --host <string>","Host to run Storybook").option("-s, --static-dir <dir-names>","Directory where to load static files from",parseList).option("-c, --config-dir <dir-name>","Directory where to load Storybook configurations from").option("--https","Serve Storybook over HTTPS. Note: You must provide your own certificate information.").option("--ssl-ca <ca>","Provide an SSL certificate authority. (Optional with --https, required if using a self-signed certificate)",parseList).option("--ssl-cert <cert>","Provide an SSL certificate. (Required with --https)").option("--ssl-key <key>","Provide an SSL key. (Required with --https)").option("--smoke-test","Exit after successful start").option("--ci","CI mode (skip interactive prompts, don't open browser)").option("--no-open","Do not open Storybook automatically in the browser").option("--loglevel <level>","Control level of logging during build").option("--quiet","Suppress verbose build output").option("--no-version-updates","Suppress update check",!0).option("--no-release-notes","Suppress automatic redirects to the release notes after upgrading",!0).option("--debug-webpack","Display final webpack configurations for debugging purposes").option("--webpack-stats-json [directory]","Write Webpack Stats JSON to disk").option("--preview-url <string>","Disables the default storybook preview and lets your use your own").option("--force-build-preview","Build the preview iframe even if you are using --preview-url").option("--docs","Build a documentation-only site using addon-docs").action(async options=>{logger26.setLevel(program.loglevel),consoleLogger.log(chalk26.bold(`${pkg.name} v${pkg.version}`)+chalk26.reset(`
|
|
433
|
+
`)),getEnvConfig(program,{port:"SBCONFIG_PORT",host:"SBCONFIG_HOSTNAME",staticDir:"SBCONFIG_STATIC_DIR",configDir:"SBCONFIG_CONFIG_DIR",ci:"CI"}),typeof program.port=="string"&&program.port.length>0&&(program.port=parseInt(program.port,10)),await dev({...options,packageJson:pkg}).catch(()=>process.exit(1))});command("build").option("-s, --static-dir <dir-names>","Directory where to load static files from",parseList).option("-o, --output-dir <dir-name>","Directory where to store built files").option("-c, --config-dir <dir-name>","Directory where to load Storybook configurations from").option("--quiet","Suppress verbose build output").option("--loglevel <level>","Control level of logging during build").option("--debug-webpack","Display final webpack configurations for debugging purposes").option("--webpack-stats-json [directory]","Write Webpack Stats JSON to disk").option("--preview-url <string>","Disables the default storybook preview and lets your use your own").option("--force-build-preview","Build the preview iframe even if you are using --preview-url").option("--docs","Build a documentation-only site using addon-docs").action(async options=>{process.env.NODE_ENV=process.env.NODE_ENV||"production",logger26.setLevel(program.loglevel),consoleLogger.log(chalk26.bold(`${pkg.name} v${pkg.version}
|
|
434
|
+
`)),getEnvConfig(program,{staticDir:"SBCONFIG_STATIC_DIR",outputDir:"SBCONFIG_OUTPUT_DIR",configDir:"SBCONFIG_CONFIG_DIR"}),await build({...options,packageJson:pkg}).catch(()=>process.exit(1))});program.on("command:*",([invalidCmd])=>{consoleLogger.error(` Invalid command: %s.
|
|
420
435
|
See --help for a list of available commands.`,invalidCmd);let suggestion=program.commands.map(cmd=>cmd._name).find(cmd=>leven(cmd,invalidCmd)<3);suggestion&&consoleLogger.info(`
|
|
421
436
|
Did you mean ${suggestion}?`),process.exit(1)});program.usage("<command> [options]").version(pkg.version).parse(process.argv);
|