@storybook/cli 7.0.0-beta.4 → 7.0.0-beta.41
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/bin/index.js +0 -1
- package/dist/chunk-R33VFH4C.mjs +14 -0
- package/dist/generate.js +298 -212
- package/dist/generate.mjs +243 -170
- package/dist/index.d.ts +133 -0
- package/dist/index.js +10 -0
- package/dist/index.mjs +1 -0
- package/package.json +29 -16
- package/rendererAssets/common/Introduction.mdx +1 -1
- package/rendererAssets/common/header.css +1 -1
- package/rendererAssets/common/page.css +1 -1
- package/templates/angular/template-csf/.storybook/tsconfig.json +5 -4
package/dist/generate.mjs
CHANGED
|
@@ -1,24 +1,7 @@
|
|
|
1
|
-
var __freeze=Object.freeze,__defProp=Object.defineProperty;var __require=(x=>typeof require!="undefined"?require:typeof Proxy!="undefined"?new Proxy(x,{get:(a,b)=>(typeof require!="undefined"?require:a)[b]}):x)(function(x){if(typeof require!="undefined")return require.apply(this,arguments);throw new Error('Dynamic require of "'+x+'" is not supported')});var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0})};var __template=(cooked,raw)=>__freeze(__defProp(cooked,"raw",{value:__freeze(raw||cooked.slice())}));import program from"commander";import path15 from"path";import chalk23 from"chalk";import envinfo from"envinfo";import leven from"leven";import{sync as readUpSync3}from"read-pkg-up";import{logger as logger24}from"@storybook/node-logger";import chalk19 from"chalk";import prompts3 from"prompts";import{telemetry}from"@storybook/telemetry";import{withTelemetry}from"@storybook/core-server";import{minVersion,validRange}from"semver";function ltMajor(versionRange,major){return validRange(versionRange)&&minVersion(versionRange).major<major}function gtMajor(versionRange,major){return validRange(versionRange)&&minVersion(versionRange).major>major}function eqMajor(versionRange,major){return validRange(versionRange)&&minVersion(versionRange).major===major}var SUPPORTED_RENDERERS=["react","react-native","vue","vue3","angular","mithril","riot","ember","marionette","marko","preact","svelte","rax","aurelia"],ProjectType=(ProjectType2=>(ProjectType2.UNDETECTED="UNDETECTED",ProjectType2.UNSUPPORTED="UNSUPPORTED",ProjectType2.REACT_SCRIPTS="REACT_SCRIPTS",ProjectType2.REACT="REACT",ProjectType2.REACT_NATIVE="REACT_NATIVE",ProjectType2.REACT_PROJECT="REACT_PROJECT",ProjectType2.WEBPACK_REACT="WEBPACK_REACT",ProjectType2.NEXTJS="NEXTJS",ProjectType2.VUE="VUE",ProjectType2.VUE3="VUE3",ProjectType2.SFC_VUE="SFC_VUE",ProjectType2.ANGULAR="ANGULAR",ProjectType2.EMBER="EMBER",ProjectType2.ALREADY_HAS_STORYBOOK="ALREADY_HAS_STORYBOOK",ProjectType2.WEB_COMPONENTS="WEB_COMPONENTS",ProjectType2.MITHRIL="MITHRIL",ProjectType2.MARIONETTE="MARIONETTE",ProjectType2.MARKO="MARKO",ProjectType2.HTML="HTML",ProjectType2.RIOT="RIOT",ProjectType2.PREACT="PREACT",ProjectType2.SVELTE="SVELTE",ProjectType2.SVELTEKIT="SVELTEKIT",ProjectType2.RAX="RAX",ProjectType2.AURELIA="AURELIA",ProjectType2.SERVER="SERVER",ProjectType2))(ProjectType||{});var supportedTemplates=[{preset:"SFC_VUE",dependencies:{"vue-loader":versionRange=>ltMajor(versionRange,16),vuetify:versionRange=>ltMajor(versionRange,3)},matcherFunction:({dependencies})=>dependencies.some(Boolean)},{preset:"VUE",dependencies:{vue:versionRange=>ltMajor(versionRange,3),nuxt:versionRange=>ltMajor(versionRange,3)},matcherFunction:({dependencies})=>dependencies.some(Boolean)},{preset:"VUE3",dependencies:{vue:versionRange=>versionRange==="next"||eqMajor(versionRange,3)},matcherFunction:({dependencies})=>dependencies.some(Boolean)},{preset:"EMBER",dependencies:["ember-cli"],matcherFunction:({dependencies})=>dependencies.every(Boolean)},{preset:"NEXTJS",dependencies:{next:versionRange=>eqMajor(versionRange,9)||gtMajor(versionRange,9)},matcherFunction:({dependencies})=>dependencies.every(Boolean)},{preset:"REACT_PROJECT",peerDependencies:["react"],matcherFunction:({peerDependencies})=>peerDependencies.every(Boolean)},{preset:"REACT_NATIVE",dependencies:["react-native","react-native-scripts"],matcherFunction:({dependencies})=>dependencies.some(Boolean)},{preset:"REACT_SCRIPTS",files:["/node_modules/.bin/react-scripts"],dependencies:["react-scripts"],matcherFunction:({dependencies,files})=>dependencies.every(Boolean)||files.every(Boolean)},{preset:"WEBPACK_REACT",dependencies:["react","webpack"],matcherFunction:({dependencies})=>dependencies.every(Boolean)},{preset:"REACT",dependencies:["react"],matcherFunction:({dependencies})=>dependencies.every(Boolean)},{preset:"ANGULAR",dependencies:["@angular/core"],matcherFunction:({dependencies})=>dependencies.every(Boolean)},{preset:"WEB_COMPONENTS",dependencies:["lit-element","lit-html","lit"],matcherFunction:({dependencies})=>dependencies.some(Boolean)},{preset:"MITHRIL",dependencies:["mithril"],matcherFunction:({dependencies})=>dependencies.every(Boolean)},{preset:"MARIONETTE",dependencies:["backbone.marionette"],matcherFunction:({dependencies})=>dependencies.every(Boolean)},{preset:"MARKO",dependencies:["marko"],matcherFunction:({dependencies})=>dependencies.every(Boolean)},{preset:"RIOT",dependencies:["riot"],matcherFunction:({dependencies})=>dependencies.every(Boolean)},{preset:"PREACT",dependencies:["preact"],matcherFunction:({dependencies})=>dependencies.every(Boolean)},{preset:"SVELTEKIT",dependencies:["@sveltejs/kit"],matcherFunction:({dependencies})=>dependencies.every(Boolean)},{preset:"SVELTE",dependencies:["svelte"],matcherFunction:({dependencies})=>dependencies.every(Boolean)},{preset:"RAX",dependencies:["rax"],matcherFunction:({dependencies})=>dependencies.every(Boolean)},{preset:"AURELIA",dependencies:["aurelia-bootstrapper"],matcherFunction:({dependencies})=>dependencies.every(Boolean)}],unsupportedTemplate={preset:"UNSUPPORTED",dependencies:{nuxt:versionRange=>eqMajor(versionRange,3)},matcherFunction:({dependencies})=>dependencies.some(Boolean)},notInstallableProjectTypes=["UNDETECTED","UNSUPPORTED","ALREADY_HAS_STORYBOOK"],installableProjectTypes=Object.values(ProjectType).filter(type=>!notInstallableProjectTypes.includes(type)).map(type=>type.toLowerCase());import path2 from"path";import fs2 from"fs";import findUp from"find-up";import semver from"semver";import path,{join}from"path";import fs from"fs";import fse from"fs-extra";import chalk from"chalk";import{satisfies}from"semver";import stripJsonComments from"strip-json-comments";import{dirname}from"path";function getCliDir(){return dirname(__require.resolve("@storybook/cli/package.json"))}function getRendererDir(renderer){return dirname(__require.resolve(`@storybook/${renderer}/package.json`,{paths:[process.cwd()]}))}var versions_default={"@storybook/addon-a11y":"7.0.0-beta.4","@storybook/addon-actions":"7.0.0-beta.4","@storybook/addon-backgrounds":"7.0.0-beta.4","@storybook/addon-controls":"7.0.0-beta.4","@storybook/addon-docs":"7.0.0-beta.4","@storybook/addon-essentials":"7.0.0-beta.4","@storybook/addon-highlight":"7.0.0-beta.4","@storybook/addon-interactions":"7.0.0-beta.4","@storybook/addon-jest":"7.0.0-beta.4","@storybook/addon-links":"7.0.0-beta.4","@storybook/addon-measure":"7.0.0-beta.4","@storybook/addon-outline":"7.0.0-beta.4","@storybook/addon-storyshots":"7.0.0-beta.4","@storybook/addon-storyshots-puppeteer":"7.0.0-beta.4","@storybook/addon-storysource":"7.0.0-beta.4","@storybook/addon-toolbars":"7.0.0-beta.4","@storybook/addon-viewport":"7.0.0-beta.4","@storybook/addons":"7.0.0-beta.4","@storybook/angular":"7.0.0-beta.4","@storybook/manager-api":"7.0.0-beta.4","@storybook/blocks":"7.0.0-beta.4","@storybook/builder-manager":"7.0.0-beta.4","@storybook/builder-vite":"7.0.0-beta.4","@storybook/builder-webpack5":"7.0.0-beta.4","@storybook/channel-postmessage":"7.0.0-beta.4","@storybook/channel-websocket":"7.0.0-beta.4","@storybook/channels":"7.0.0-beta.4","@storybook/cli":"7.0.0-beta.4","@storybook/client-api":"7.0.0-beta.4","@storybook/client-logger":"7.0.0-beta.4","@storybook/codemod":"7.0.0-beta.4","@storybook/components":"7.0.0-beta.4","@storybook/core-client":"7.0.0-beta.4","@storybook/core-common":"7.0.0-beta.4","@storybook/core-events":"7.0.0-beta.4","@storybook/core-server":"7.0.0-beta.4","@storybook/core-webpack":"7.0.0-beta.4","@storybook/csf-tools":"7.0.0-beta.4","@storybook/docs-tools":"7.0.0-beta.4","@storybook/ember":"7.0.0-beta.4","@storybook/html":"7.0.0-beta.4","@storybook/html-webpack5":"7.0.0-beta.4","@storybook/html-vite":"7.0.0-beta.4","@storybook/instrumenter":"7.0.0-beta.4","@storybook/nextjs":"7.0.0-beta.4","@storybook/node-logger":"7.0.0-beta.4","@storybook/postinstall":"7.0.0-beta.4","@storybook/preact":"7.0.0-beta.4","@storybook/preact-webpack5":"7.0.0-beta.4","@storybook/preset-html-webpack":"7.0.0-beta.4","@storybook/preset-preact-webpack":"7.0.0-beta.4","@storybook/preset-react-webpack":"7.0.0-beta.4","@storybook/preset-server-webpack":"7.0.0-beta.4","@storybook/preset-svelte-webpack":"7.0.0-beta.4","@storybook/preset-vue-webpack":"7.0.0-beta.4","@storybook/preset-vue3-webpack":"7.0.0-beta.4","@storybook/preset-web-components-webpack":"7.0.0-beta.4","@storybook/preview":"7.0.0-beta.4","@storybook/preview-api":"7.0.0-beta.4","@storybook/preview-web":"7.0.0-beta.4","@storybook/react":"7.0.0-beta.4","@storybook/react-vite":"7.0.0-beta.4","@storybook/react-webpack5":"7.0.0-beta.4","@storybook/router":"7.0.0-beta.4","@storybook/server":"7.0.0-beta.4","@storybook/server-webpack5":"7.0.0-beta.4","@storybook/source-loader":"7.0.0-beta.4","@storybook/store":"7.0.0-beta.4","@storybook/svelte":"7.0.0-beta.4","@storybook/sveltekit":"7.0.0-beta.4","@storybook/svelte-vite":"7.0.0-beta.4","@storybook/svelte-webpack5":"7.0.0-beta.4","@storybook/telemetry":"7.0.0-beta.4","@storybook/theming":"7.0.0-beta.4","@storybook/manager":"7.0.0-beta.4","@storybook/vue":"7.0.0-beta.4","@storybook/vue-vite":"7.0.0-beta.4","@storybook/vue-webpack5":"7.0.0-beta.4","@storybook/vue3":"7.0.0-beta.4","@storybook/vue3-vite":"7.0.0-beta.4","@storybook/vue3-webpack5":"7.0.0-beta.4","@storybook/web-components":"7.0.0-beta.4","@storybook/web-components-webpack5":"7.0.0-beta.4","@storybook/web-components-vite":"7.0.0-beta.4",sb:"7.0.0-beta.4",storybook:"7.0.0-beta.4"};var logger=console;function getBowerJson(){let bowerJsonPath=path.resolve("bower.json");if(!fs.existsSync(bowerJsonPath))return!1;let jsonContent=fs.readFileSync(bowerJsonPath,"utf8");return JSON.parse(jsonContent)}function readFileAsJson(jsonPath,allowComments){let filePath=path.resolve(jsonPath);if(!fs.existsSync(filePath))return!1;let fileContent=fs.readFileSync(filePath,"utf8"),jsonContent=allowComments?stripJsonComments(fileContent):fileContent;try{return JSON.parse(jsonContent)}catch(e){throw logger.error(chalk.red(`Invalid json in file: ${filePath}`)),e}}var writeFileAsJson=(jsonPath,content)=>{let filePath=path.resolve(jsonPath);return fs.existsSync(filePath)?(fs.writeFileSync(filePath,`${JSON.stringify(content,null,2)}
|
|
2
|
-
`
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
`).map(line=>` ${chalk.dim(line)}`).join(`
|
|
6
|
-
`);logger.error(`${newErrorInfo}
|
|
7
|
-
`);return}process.stdout.write(`. ${chalk.green("\u2713")}
|
|
8
|
-
`)});function paddedLog(message){let newMessage=message.split(`
|
|
9
|
-
`).map(line=>` ${line}`).join(`
|
|
10
|
-
`);logger.log(newMessage)}function getChars(char,amount){let line="";for(let lc=0;lc<amount;lc+=1)line+=char;return line}function codeLog(codeLines,leftPadAmount){let maxLength=0,finalResult=codeLines.map(line=>(maxLength=line.length>maxLength?line.length:maxLength,line)).map(line=>{let rightPadAmount=maxLength-line.length,newLine=line+getChars(" ",rightPadAmount);return newLine=getChars(" ",leftPadAmount||2)+chalk.inverse(` ${newLine} `),newLine}).join(`
|
|
11
|
-
`);logger.log(finalResult)}async function getBabelDependencies(packageManager,packageJson){let dependenciesToAdd=[],babelLoaderVersion="^8.0.0-0",babelCoreVersion=packageJson.dependencies["babel-core"]||packageJson.devDependencies["babel-core"];if(babelCoreVersion){let latestCompatibleBabelVersion=await packageManager.latestVersion("babel-core",babelCoreVersion);satisfies(latestCompatibleBabelVersion,"^6.0.0")&&(babelLoaderVersion="^7.0.0")}else if(!packageJson.dependencies["@babel/core"]&&!packageJson.devDependencies["@babel/core"]){let babelCoreInstallVersion=await packageManager.getVersion("@babel/core");dependenciesToAdd.push(`@babel/core@${babelCoreInstallVersion}`)}if(!packageJson.dependencies["babel-loader"]&&!packageJson.devDependencies["babel-loader"]){let babelLoaderInstallVersion=await packageManager.getVersion("babel-loader",babelLoaderVersion);dependenciesToAdd.push(`babel-loader@${babelLoaderInstallVersion}`)}return dependenciesToAdd}function copyTemplate(templateRoot){let templateDir=path.resolve(templateRoot,"template-csf/");if(!fs.existsSync(templateDir))throw new Error("Couldn't find template dir");fse.copySync(templateDir,".",{overwrite:!0})}async function copyComponents(renderer,language){let languageFolderMapping={["javascript"]:"js",["typescript"]:"ts",["typescript-legacy"]:"ts-legacy"},componentsPath=async()=>{let baseDir=getRendererDir(renderer),assetsDir=join(baseDir,"template/cli"),assetsLanguage=join(assetsDir,languageFolderMapping[language]),assetsJS=join(assetsDir,languageFolderMapping["javascript"]),assetsTSLegacy=join(assetsDir,languageFolderMapping["typescript-legacy"]),assetsTS=join(assetsDir,languageFolderMapping["typescript"]);if(await fse.pathExists(assetsLanguage))return assetsLanguage;if(language==="typescript"&&await fse.pathExists(assetsTSLegacy))return assetsTSLegacy;if(language==="typescript-legacy"&&await fse.pathExists(assetsTS))return assetsTS;if(await fse.pathExists(assetsJS))return assetsJS;if(await fse.pathExists(assetsDir))return assetsDir;throw new Error(`Unsupported renderer: ${renderer}`)},destinationPath=await(async()=>await fse.pathExists("./src")?"./src/stories":"./stories")();await fse.copy(join(getCliDir(),"rendererAssets/common"),destinationPath,{overwrite:!0}),await fse.copy(await componentsPath(),destinationPath,{overwrite:!0})}function getStorybookVersionSpecifier(packageJson){let allDeps={...packageJson.dependencies,...packageJson.devDependencies},storybookPackage=Object.keys(allDeps).find(name=>versions_default[name]);if(!storybookPackage)throw new Error("Couldn't find any official storybook packages in package.json");return allDeps[storybookPackage]}var regex=/[\s"\n]next.*?(\d+).*/,detectNextJS=packageManager=>{try{let out="";if(packageManager.type==="npm")try{out=packageManager.executeCommand("npm",["ls","next"])}catch{out=packageManager.executeCommand("npm",["why","next"])}else out=packageManager.executeCommand("yarn",["why","next"]);let[,version]=out.match(regex);return version&&parseInt(version,10)?parseInt(version,10):!1}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=>fs2.existsSync(path2.join(process.cwd(),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){if(findUp.sync(viteConfigFiles))return paddedLog("Detected vite project, setting builder to @storybook/builder-vite"),"vite";let nextJSVersion=detectNextJS(packageManager);return nextJSVersion&&nextJSVersion>=11?"webpack5":"webpack5"}function isStorybookInstalled(dependencies,force){return dependencies&&!force&&dependencies.devDependencies&&SUPPORTED_RENDERERS.reduce((storybookPresent,framework)=>storybookPresent||!!dependencies.devDependencies[`@storybook/${framework}`],!1)?"ALREADY_HAS_STORYBOOK":!1}function detectLanguage(packageJson){let language="javascript";return packageJson&&(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":hasDependency(packageJson,"typescript")&&(language="typescript-legacy")),language}function detect(packageJson,options={}){let bowerJson=getBowerJson();if(!packageJson&&!bowerJson)return"UNDETECTED";let storyBookInstalled=isStorybookInstalled(packageJson,options.force);return storyBookInstalled||(options.html?"HTML":detectFrameworkPreset(packageJson||bowerJson))}import path7,{join as join2}from"path";import semver3 from"semver";import*as path3 from"path";import*as fs3 from"fs";import{pathExists}from"fs-extra";function getAngularAppTsConfigPath(){let angularJson=readFileAsJson("angular.json",!0),defaultProject=getDefaultProjectName(angularJson),tsConfigPath=angularJson.projects[defaultProject].architect.build.options.tsConfig;return!tsConfigPath||!fs3.existsSync(path3.resolve(tsConfigPath))?!1:tsConfigPath}function getAngularAppTsConfigJson(){let tsConfigPath=getAngularAppTsConfigPath();return tsConfigPath?readFileAsJson(tsConfigPath,!0):!1}function setStorybookTsconfigExtendsPath(tsconfigJson){let angularProjectTsConfigPath=getAngularAppTsConfigPath(),newTsconfigJson={...tsconfigJson};return newTsconfigJson.extends=`../${angularProjectTsConfigPath}`,newTsconfigJson}function editStorybookTsConfig(tsconfigPath){let tsConfigJson;try{tsConfigJson=readFileAsJson(tsconfigPath)}catch(e){throw e.name==="SyntaxError"&&e.message.indexOf("Unexpected token /")>-1?new Error(`Comments are disallowed in ${tsconfigPath}`):e}tsConfigJson=setStorybookTsconfigExtendsPath(tsConfigJson),writeFileAsJson(tsconfigPath,tsConfigJson)}function getDefaultProjectName(angularJson){let{defaultProject,projects}=angularJson;if(projects?.storybook)return"storybook";if(defaultProject)return defaultProject;let firstProjectName=projects?Object.keys(projects)[0]:void 0;if(firstProjectName)return firstProjectName}function checkForProjects(){let{projects}=readFileAsJson("angular.json",!0);if(!projects||Object.keys(projects).length===0)throw new Error(`Could not find a project in your Angular workspace.
|
|
12
|
-
Add a project and re-run the installation`)}async function getBaseTsConfigName(){return await pathExists("./tsconfig.base.json")?"tsconfig.base.json":"tsconfig.json"}import path6 from"path";import fse3 from"fs-extra";import{dedent as dedent2}from"ts-dedent";import fse2 from"fs-extra";import{dedent}from"ts-dedent";async function configureMain({addons,extensions=["js","jsx","ts","tsx"],commonJs=!1,...custom}){let prefix=await fse2.pathExists("./src")?"../src":"../stories",config={stories:[`${prefix}/**/*.mdx`,`${prefix}/**/*.stories.@(${extensions.join("|")})`],addons,...custom},stringified=`module.exports = ${JSON.stringify(config,null,2).replace(/\\"/g,'"').replace(/['"]%%/g,"").replace(/%%['"]/g,"").replace(/\\n/g,`\r
|
|
13
|
-
`)}`;await fse2.writeFile(`./.storybook/main.${commonJs?"cjs":"js"}`,dedent`
|
|
14
|
-
const path = require('path');
|
|
15
|
-
${stringified}
|
|
16
|
-
`,{encoding:"utf8"})}var frameworkToPreviewParts={angular:{prefix:dedent`
|
|
17
|
-
import { setCompodocJson } from "@storybook/addon-docs/angular";
|
|
18
|
-
import docJson from "../documentation.json";
|
|
19
|
-
setCompodocJson(docJson);
|
|
20
|
-
|
|
21
|
-
`.trimStart(),extraParameters:"docs: { inlineStories: true },"}};async function configurePreview(framework){let{prefix="",extraParameters=""}=frameworkToPreviewParts[framework]||{},previewPath="./.storybook/preview.js";if(await fse2.pathExists(previewPath))return;let preview=dedent`
|
|
1
|
+
import{JsPackageManagerFactory,SUPPORTED_RENDERERS,__require,codeLog,commandLog,copyComponents,copyTemplate,externalFrameworks,getBabelDependencies,getBowerJson,getCliDir,getPackageDetails,getStorybookVersionSpecifier,installableProjectTypes,paddedLog,readFileAsJson,supportedTemplates,unsupportedTemplate,useNpmWarning,versions_default,writeFileAsJson}from"./chunk-R33VFH4C.mjs";import program from"commander";import path9 from"path";import chalk25 from"chalk";import envinfo from"envinfo";import leven from"leven";import{sync as readUpSync3}from"read-pkg-up";import{logger as logger23}from"@storybook/node-logger";import chalk22 from"chalk";import prompts4 from"prompts";import{telemetry}from"@storybook/telemetry";import{withTelemetry}from"@storybook/core-server";import path from"path";import fs from"fs";import findUp from"find-up";import semver from"semver";var regex=/[\s"\n]next.*?(\d+).*/,detectNextJS=packageManager=>{try{let out="";if(packageManager.type==="npm")try{out=packageManager.executeCommand("npm",["ls","next"])}catch{out=packageManager.executeCommand("npm",["why","next"])}else out=packageManager.executeCommand("yarn",["why","next"]);let[,version]=out.match(regex);return version&&parseInt(version,10)?parseInt(version,10):!1}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(path.join(process.cwd(),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){if(findUp.sync(viteConfigFiles))return paddedLog("Detected vite project, setting builder to @storybook/builder-vite"),"vite";let nextJSVersion=detectNextJS(packageManager);return nextJSVersion&&nextJSVersion>=11?"webpack5":"webpack5"}function isStorybookInstalled(dependencies,force){return dependencies?!!(!force&&dependencies.devDependencies&&SUPPORTED_RENDERERS.reduce((storybookPresent,framework)=>storybookPresent||!!dependencies.devDependencies[`@storybook/${framework}`],!1)):!1}function detectLanguage(packageJson){let language="javascript";return packageJson&&(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":hasDependency(packageJson,"typescript")&&(language="typescript-legacy")),language}function detect(packageJson,options={}){let bowerJson=getBowerJson();return!packageJson&&!bowerJson?"UNDETECTED":isNxProject(packageJson)?"NX":options.html?"HTML":detectFrameworkPreset(packageJson||bowerJson)}function isNxProject(packageJSON){return!!packageJSON.devDependencies?.nx||fs.existsSync("nx.json")}import{join}from"path";import semver2 from"semver";import fs3 from"fs";import dedent4 from"ts-dedent";import path3 from"path";import fse2 from"fs-extra";import{dedent as dedent2}from"ts-dedent";import fse from"fs-extra";import{dedent}from"ts-dedent";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"||language==="typescript-legacy",tsTemplate=dedent`<<import>>const config<<type>> = <<mainContents>>;
|
|
2
|
+
export default config;`,jsTemplate=dedent`export default <<mainContents>>;`,mainJsContents=(isTypescript?tsTemplate:jsTemplate).replace("<<import>>",`import { StorybookConfig } from '${custom.framework.name}';
|
|
3
|
+
|
|
4
|
+
`).replace("<<type>>",": StorybookConfig").replace("<<mainContents>>",JSON.stringify(config,null,2));await fse.writeFile(`./${storybookConfigFolder}/main.${isTypescript?"ts":"js"}`,dedent(mainJsContents),{encoding:"utf8"})}async function configurePreview(options){let{prefix=""}=options.frameworkPreviewParts||{},isTypescript=options.language==="typescript"||options.language==="typescript-legacy",previewPath=`./${options.storybookConfigFolder}/preview.${isTypescript?"ts":"js"}`;if(await fse.pathExists(previewPath))return;let preview=dedent`
|
|
22
5
|
${prefix}
|
|
23
6
|
export const parameters = {
|
|
24
7
|
actions: { argTypesRegex: "^on[A-Z].*" },
|
|
@@ -28,20 +11,28 @@ Add a project and re-run the installation`)}async function getBaseTsConfigName()
|
|
|
28
11
|
date: /Date$/,
|
|
29
12
|
},
|
|
30
13
|
},
|
|
31
|
-
${extraParameters}
|
|
32
14
|
}`.replace(`
|
|
33
|
-
`,"").trim();await
|
|
34
|
-
`;fs4.writeFileSync(this.packageJsonPath(),content,"utf8")}retrievePackageJson(){let packageJson;try{packageJson=this.readPackageJson()}catch{this.initPackageJson(),packageJson=this.readPackageJson()}return{...packageJson,dependencies:{...packageJson.dependencies},devDependencies:{...packageJson.devDependencies}}}addDependencies(options,dependencies){let{skipInstall}=options;if(skipInstall){let{packageJson}=options,dependenciesMap=dependencies.reduce((acc,dep)=>{let[packageName,packageVersion]=getPackageDetails(dep);return{...acc,[packageName]:packageVersion}},{});options.installAsDevDependencies?packageJson.devDependencies={...packageJson.devDependencies,...dependenciesMap}:packageJson.dependencies={...packageJson.dependencies,...dependenciesMap},this.writePackageJson(packageJson)}else try{this.runAddDeps(dependencies,options.installAsDevDependencies)}catch(e){logger2.error("An error occurred while installing dependencies."),logger2.log(e.message),process.exit(1)}}removeDependencies(options,dependencies){let{skipInstall}=options;if(skipInstall){let{packageJson}=options;dependencies.forEach(dep=>{packageJson.devDependencies&&delete packageJson.devDependencies[dep],packageJson.dependencies&&delete packageJson.dependencies[dep]}),this.writePackageJson(packageJson)}else try{this.runRemoveDeps(dependencies)}catch(e){logger2.error("An error occurred while removing dependencies."),logger2.log(e.message),process.exit(1)}}getVersionedPackages(packages){return Promise.all(packages.map(async pkg2=>{let[packageName,packageVersion]=getPackageDetails(pkg2);return`${packageName}@${await this.getVersion(packageName,packageVersion)}`}))}getVersions(...packageNames){return Promise.all(packageNames.map(packageName=>this.getVersion(packageName)))}async getVersion(packageName,constraint){let current;/(@storybook|^sb$|^storybook$)/.test(packageName)&&(current=versions_default[packageName]);let latest;try{latest=await this.latestVersion(packageName,constraint)}catch(e){if(current)return logger2.warn(`
|
|
35
|
-
${chalk2.yellow(e.message)}`),current;logger2.error(`
|
|
36
|
-
${chalk2.red(e.message)}`),process.exit(1)}return`^${current&&(!constraint||satisfies2(current,constraint))&>(current,latest)?current:latest}`}async latestVersion(packageName,constraint){return constraint?(await this.runGetVersions(packageName,!0)).reverse().find(version=>satisfies2(version,constraint)):this.runGetVersions(packageName,!1)}addStorybookCommandInScripts(options){let storybookCmd=`storybook dev -p ${options?.port??6006}`,buildStorybookCmd="storybook build",preCommand=options?.preCommand?this.getRunCommand(options.preCommand):void 0;this.addScripts({storybook:[preCommand,storybookCmd].filter(Boolean).join(" && "),"build-storybook":[preCommand,buildStorybookCmd].filter(Boolean).join(" && ")})}addESLintConfig(){let packageJson=this.retrievePackageJson();this.writePackageJson({...packageJson,eslintConfig:{...packageJson.eslintConfig,overrides:[...packageJson.eslintConfig?.overrides||[],{files:["**/*.stories.*"],rules:{"import/no-anonymous-default-export":"off"}}]}})}addScripts(scripts){let packageJson=this.retrievePackageJson();this.writePackageJson({...packageJson,scripts:{...packageJson.scripts,...scripts}})}addPackageResolutions(versions){let packageJson=this.retrievePackageJson(),resolutions=this.getResolutions(packageJson,versions);this.writePackageJson({...packageJson,...resolutions})}executeCommand(command2,args,stdio){let commandResult=spawnSync(command2,args,{cwd:this.cwd,stdio:stdio??"pipe",encoding:"utf-8",shell:!0});if(commandResult.status!==0)throw new Error(commandResult.stderr??"");return commandResult.stdout??""}};var NPMProxy=class extends JsPackageManager{constructor(){super(...arguments);this.type="npm"}initPackageJson(){return this.executeCommand("npm",["init","-y"])}getRunStorybookCommand(){return"npm run storybook"}getRunCommand(command2){return`npm run ${command2}`}getNpmVersion(){return this.executeCommand("npm",["--version"])}hasLegacyPeerDeps(){return this.executeCommand("npm",["config","get","legacy-peer-deps","--location=project"]).trim()==="true"}setLegacyPeerDeps(){this.executeCommand("npm",["config","set","legacy-peer-deps=true","--location=project"])}needsLegacyPeerDeps(version){return semver2.gte(version,"7.0.0")&&!this.hasLegacyPeerDeps()}getInstallArgs(){return this.installArgs||(this.installArgs=this.needsLegacyPeerDeps(this.getNpmVersion())?["install","--legacy-peer-deps"]:["install"]),this.installArgs}getUninstallArgs(){return this.uninstallArgs||(this.uninstallArgs=this.needsLegacyPeerDeps(this.getNpmVersion())?["uninstall","--legacy-peer-deps"]:["uninstall"]),this.uninstallArgs}getResolutions(packageJson,versions){return{overrides:{...packageJson.overrides,...versions}}}runInstall(){this.executeCommand("npm",this.getInstallArgs(),"inherit")}runAddDeps(dependencies,installAsDevDependencies){let args=[...dependencies];installAsDevDependencies&&(args=["-D",...args]),this.executeCommand("npm",[...this.getInstallArgs(),...args],"inherit")}runRemoveDeps(dependencies){let args=[...dependencies];this.executeCommand("npm",[...this.getUninstallArgs(),...args],"inherit")}runGetVersions(packageName,fetchAllVersions){let args=[fetchAllVersions?"versions":"version","--json"],commandResult=this.executeCommand("npm",["info",packageName,...args]);try{let parsedOutput=JSON.parse(commandResult);if(parsedOutput.error)throw new Error(parsedOutput.error.summary);return parsedOutput}catch{throw new Error(`Unable to find versions of ${packageName} using npm`)}}};var PNPMProxy=class extends JsPackageManager{constructor(){super(...arguments);this.type="pnpm"}initPackageJson(){return this.executeCommand("pnpm",["init","-y"])}getRunStorybookCommand(){return"pnpm run storybook"}getRunCommand(command2){return`pnpm run ${command2}`}getPnpmVersion(){return this.executeCommand("pnpm",["--version"])}getResolutions(packageJson,versions){return{overrides:{...packageJson.overrides,...versions}}}runInstall(){this.executeCommand("pnpm",["install"],"inherit")}runAddDeps(dependencies,installAsDevDependencies){let args=[...dependencies];installAsDevDependencies&&(args=["-D",...args]),this.executeCommand("pnpm",["add",...args],"inherit")}runRemoveDeps(dependencies){let args=[...dependencies];this.executeCommand("pnpm",["remove",...args],"inherit")}runGetVersions(packageName,fetchAllVersions){let args=[fetchAllVersions?"versions":"version","--json"],commandResult=this.executeCommand("pnpm",["info",packageName,...args]);try{let parsedOutput=JSON.parse(commandResult);if(parsedOutput.error)throw new Error(parsedOutput.error.summary);return parsedOutput}catch{throw new Error(`Unable to find versions of ${packageName} using pnpm`)}}};var Yarn2Proxy=class extends JsPackageManager{constructor(){super(...arguments);this.type="yarn2"}initPackageJson(){return this.executeCommand("yarn",["init"])}getRunStorybookCommand(){return"yarn storybook"}getRunCommand(command2){return`yarn ${command2}`}getResolutions(packageJson,versions){return{resolutions:{...packageJson.resolutions,...versions}}}runInstall(){this.executeCommand("yarn",[],"inherit")}runAddDeps(dependencies,installAsDevDependencies){let args=[...dependencies];installAsDevDependencies&&(args=["-D",...args]),this.executeCommand("yarn",["add",...args],"inherit")}runRemoveDeps(dependencies){let args=[...dependencies];this.executeCommand("yarn",["remove",...args],"inherit")}runGetVersions(packageName,fetchAllVersions){let field=fetchAllVersions?"versions":"version",args=["--fields",field,"--json"],commandResult=this.executeCommand("yarn",["npm","info",packageName,...args]);try{return JSON.parse(commandResult)[field]}catch{throw new Error(`Unable to find versions of ${packageName} using yarn 2`)}}};var Yarn1Proxy=class extends JsPackageManager{constructor(){super(...arguments);this.type="yarn1"}initPackageJson(){return this.executeCommand("yarn",["init","-y"])}getRunStorybookCommand(){return"yarn storybook"}getRunCommand(command2){return`yarn ${command2}`}getResolutions(packageJson,versions){return{resolutions:{...packageJson.resolutions,...versions}}}runInstall(){this.executeCommand("yarn",[],"inherit")}runAddDeps(dependencies,installAsDevDependencies){let args=["--ignore-workspace-root-check",...dependencies];installAsDevDependencies&&(args=["-D",...args]),this.executeCommand("yarn",["add",...args],"inherit")}runRemoveDeps(dependencies){let args=["--ignore-workspace-root-check",...dependencies];this.executeCommand("yarn",["remove",...args],"inherit")}runGetVersions(packageName,fetchAllVersions){let args=[fetchAllVersions?"versions":"version","--json"],commandResult=this.executeCommand("yarn",["info",packageName,...args]);try{let parsedOutput=JSON.parse(commandResult);if(parsedOutput.type==="inspect")return parsedOutput.data;throw new Error(`Unable to find versions of ${packageName} using yarn`)}catch{throw new Error(`Unable to find versions of ${packageName} using yarn`)}}};var JsPackageManagerFactory=class{static getPackageManager({force,useNpm}={},cwd){if(useNpm||force==="npm")return new NPMProxy({cwd});if(force==="pnpm")return new PNPMProxy({cwd});if(force==="yarn1")return new Yarn1Proxy({cwd});if(force==="yarn2")return new Yarn2Proxy({cwd});let yarnVersion=getYarnVersion(cwd),hasYarnLockFile=Boolean(findUpSync("yarn.lock",{cwd})),hasPNPMLockFile=Boolean(findUpSync("pnpm-lock.yaml",{cwd})),hasNPMCommand=hasNPM(cwd),hasPNPMCommand=hasPNPM(cwd);if(yarnVersion&&(hasYarnLockFile||!hasNPMCommand&&!hasPNPMCommand))return yarnVersion===1?new Yarn1Proxy({cwd}):new Yarn2Proxy({cwd});if(hasPNPMCommand&&hasPNPMLockFile)return new PNPMProxy({cwd});if(hasNPMCommand)return new NPMProxy({cwd});throw new Error("Unable to find a usable package manager within NPM, PNPM, Yarn and Yarn 2")}};function hasNPM(cwd){return spawnSync2("npm",["--version"],{cwd,shell:!0}).status===0}function hasPNPM(cwd){return spawnSync2("pnpm",["--version"],{cwd,shell:!0}).status===0}function getYarnVersion(cwd){let yarnVersionCommand=spawnSync2("yarn",["--version"],{cwd,shell:!0});if(yarnVersionCommand.status!==0)return;let yarnVersion=yarnVersionCommand.output.toString().replace(/,/g,"").replace(/"/g,"");return/^1\.+/.test(yarnVersion)?1:2}import{writeFile,access}from"fs-extra";import{logger as logger3}from"@storybook/node-logger";import path5 from"path";import prompts from"prompts";var generateStorybookBabelConfigInCWD=async()=>{let target=process.cwd();return generateStorybookBabelConfig({target})},generateStorybookBabelConfig=async({target})=>{logger3.info(`Generating the storybook default babel config at ${target}`);let contents=JSON.stringify({sourceType:"unambiguous",presets:[],plugins:[]},null,2),fileName=".babelrc.json",location=path5.join(target,fileName);if(await access(location).then(()=>!0,()=>!1)){let{overwrite}=await prompts({type:"confirm",initial:!0,name:"overwrite",message:`${fileName} already exists. Would you like overwrite it?`});if(overwrite===!1){logger3.warn("Cancelled, babel config file was NOT written to file-system.");return}}logger3.info(`Writing file to ${location}`),await writeFile(location,contents)};var defaultOptions={extraPackages:[],extraAddons:[],staticDir:void 0,addScripts:!0,addComponents:!0,addBabel:!1,addESLint:!1,extraMain:void 0,framework:void 0,extensions:void 0,commonJs:!1},getBuilderDetails=builder=>{let map=versions_default;if(map[builder])return builder;let builderPackage=`@storybook/${builder}`;return map[builderPackage]?builderPackage:builder},wrapForPnp=packageName=>`%%path.dirname(require.resolve(path.join('${packageName}', 'package.json')))%%`,getFrameworkDetails=(renderer,builder,pnp,framework)=>{let frameworkPackage=framework?`@storybook/${framework}`:`@storybook/${renderer}-${builder}`,frameworkPackagePath=pnp?wrapForPnp(frameworkPackage):frameworkPackage,rendererPackage=`@storybook/${renderer}`,rendererPackagePath=pnp?wrapForPnp(rendererPackage):rendererPackage,builderPackage=getBuilderDetails(builder),builderPackagePath=pnp?wrapForPnp(builderPackage):builderPackage,isKnownFramework=!!versions_default[frameworkPackage],isKnownRenderer=!!versions_default[rendererPackage];if(isKnownFramework)return{packages:[frameworkPackage],framework:frameworkPackagePath,rendererId:renderer,type:"framework"};if(isKnownRenderer)return{packages:[rendererPackage,builderPackage],builder:builderPackagePath,renderer:rendererPackagePath,rendererId:renderer,type:"renderer"};throw new Error(`Could not find the framework (${frameworkPackage}) or renderer (${rendererPackage}) package`)},stripVersions=addons=>addons.map(addon=>getPackageDetails(addon)[0]),hasInteractiveStories=rendererId=>["react","angular","preact","svelte","vue","vue3","html"].includes(rendererId),hasFrameworkTemplates=framework=>["angular","nextjs","sveltekit"].includes(framework),_a;async function baseGenerator(packageManager,npmOptions,{language,builder="webpack5",pnp,commonJs},renderer,options=defaultOptions,framework){let{extraAddons:extraAddonPackages,extraPackages,staticDir,addScripts,addComponents,addBabel,addESLint,extraMain,extensions}={...defaultOptions,...options},{packages:frameworkPackages,type,rendererId,framework:frameworkInclude,builder:builderInclude}=getFrameworkDetails(renderer,builder,pnp,framework),addons=["@storybook/addon-links","@storybook/addon-essentials",...stripVersions(extraAddonPackages)],addonPackages=["@storybook/addon-links","@storybook/addon-essentials","@storybook/blocks",...extraAddonPackages];hasInteractiveStories(rendererId)&&(addons.push("@storybook/addon-interactions"),addonPackages.push("@storybook/addon-interactions","@storybook/testing-library"));let files=await fse3.readdir(process.cwd()),packageJson=packageManager.retrievePackageJson(),installedDependencies=new Set(Object.keys({...packageJson.dependencies,...packageJson.devDependencies}));if(installedDependencies.has("react")||addonPackages.push("react"),installedDependencies.has("react-dom")||addonPackages.push("react-dom"),type==="renderer")throw new Error(dedent2`
|
|
15
|
+
`,"").trim();await fse.writeFile(previewPath,preview,{encoding:"utf8"})}import{writeFile,pathExists}from"fs-extra";import{logger}from"@storybook/node-logger";import path2 from"path";import prompts from"prompts";import chalk from"chalk";var generateStorybookBabelConfigInCWD=async()=>{let target=process.cwd();return generateStorybookBabelConfig({target})},generateStorybookBabelConfig=async({target})=>{logger.info(`Generating the storybook default babel config at ${target}`);let fileName=".babelrc.json",location=path2.join(target,fileName);if(await pathExists(location)){let{overwrite}=await prompts({type:"confirm",initial:!1,name:"overwrite",message:`${fileName} already exists. Would you like overwrite it?`});if(overwrite===!1){logger.warn("Cancelled, babel config file was NOT written to file-system.");return}}logger.info(`The config will contain ${chalk.yellow("@babel/preset-env")} and you will be prompted for additional presets, if you wish to add them depending on your project needs.`);let{typescript,jsx}=await prompts([{type:"confirm",initial:!1,name:"typescript",message:"Do you want to add the TypeScript preset?"},{type:"confirm",initial:!1,name:"jsx",message:"Do you want to add the React preset?"}]),added=["@babel/preset-env"],presets=[["@babel/preset-env",{targets:{chrome:100}}]];typescript&&(added.push("@babel/preset-typescript"),presets.push("@babel/preset-typescript")),jsx&&(added.push("@babel/preset-react"),presets.push("@babel/preset-react"));let contents=JSON.stringify({sourceType:"unambiguous",presets,plugins:[]},null,2);logger.info(`Writing file to ${location}`),await writeFile(location,contents);let{runInstall}=await prompts({type:"confirm",initial:!0,name:"runInstall",message:`Shall we install the required dependencies now? (${added.join(", ")})`});runInstall&&(logger.info("Installing dependencies..."),JsPackageManagerFactory.getPackageManager().addDependencies({installAsDevDependencies:!0},added))};var defaultOptions={extraPackages:[],extraAddons:[],staticDir:void 0,addScripts:!0,addMainFile:!0,addComponents:!0,addBabel:!1,addESLint:!1,extraMain:void 0,framework:void 0,extensions:void 0,componentsDestinationPath:void 0,storybookConfigFolder:".storybook"},getBuilderDetails=builder=>{let map=versions_default;if(map[builder])return builder;let builderPackage=`@storybook/${builder}`;return map[builderPackage]?builderPackage:builder},getExternalFramework=framework=>externalFrameworks.find(exFramework=>exFramework.name===framework||exFramework.packageName===framework),getFrameworkPackage=(framework,renderer,builder)=>{let externalFramework=getExternalFramework(framework);return externalFramework?externalFramework.packageName:framework?`@storybook/${framework}`:`@storybook/${renderer}-${builder}`},wrapForPnp=packageName=>`%%path.dirname(require.resolve(path.join('${packageName}', 'package.json')))%%`,getFrameworkDetails=(renderer,builder,pnp,framework)=>{let frameworkPackage=getFrameworkPackage(framework,renderer,builder),frameworkPackagePath=pnp?wrapForPnp(frameworkPackage):frameworkPackage,rendererPackage=`@storybook/${renderer}`,rendererPackagePath=pnp?wrapForPnp(rendererPackage):rendererPackage,builderPackage=getBuilderDetails(builder),builderPackagePath=pnp?wrapForPnp(builderPackage):builderPackage,isKnownFramework=!!getExternalFramework(frameworkPackage)||!!versions_default[frameworkPackage],isKnownRenderer=!!versions_default[rendererPackage];if(isKnownFramework)return{packages:[frameworkPackage],framework:frameworkPackagePath,rendererId:renderer,type:"framework"};if(isKnownRenderer)return{packages:[rendererPackage,builderPackage],builder:builderPackagePath,renderer:rendererPackagePath,rendererId:renderer,type:"renderer"};throw new Error(`Could not find the framework (${frameworkPackage}) or renderer (${rendererPackage}) package`)},stripVersions=addons=>addons.map(addon=>getPackageDetails(addon)[0]),hasInteractiveStories=rendererId=>["react","angular","preact","svelte","vue","vue3","html"].includes(rendererId),hasFrameworkTemplates=framework=>["angular","nextjs"].includes(framework);async function baseGenerator(packageManager,npmOptions,{language,builder="webpack5",pnp,frameworkPreviewParts},renderer,options=defaultOptions,framework){let{extraAddons:extraAddonPackages,extraPackages,staticDir,addScripts,addMainFile,addComponents,addBabel,addESLint,extraMain,extensions,storybookConfigFolder,componentsDestinationPath}={...defaultOptions,...options},{packages:frameworkPackages,type,rendererId,framework:frameworkInclude,builder:builderInclude}=getFrameworkDetails(renderer,builder,pnp,framework),addons=["@storybook/addon-links","@storybook/addon-essentials",...stripVersions(extraAddonPackages)],addonPackages=["@storybook/addon-links","@storybook/addon-essentials","@storybook/blocks",...extraAddonPackages];hasInteractiveStories(rendererId)&&(addons.push("@storybook/addon-interactions"),addonPackages.push("@storybook/addon-interactions","@storybook/testing-library@^0.0.14-next.1"));let files=await fse2.readdir(process.cwd()),packageJson=packageManager.retrievePackageJson(),installedDependencies=new Set(Object.keys({...packageJson.dependencies,...packageJson.devDependencies}));if(installedDependencies.has("react")||addonPackages.push("react"),installedDependencies.has("react-dom")||addonPackages.push("react-dom"),type==="renderer")throw new Error(dedent2`
|
|
37
16
|
Sorry, for now, you can not do this, please use a framework such as @storybook/react-webpack5
|
|
38
17
|
|
|
39
18
|
https://github.com/storybookjs/storybook/issues/18360
|
|
40
|
-
`);let packages=["storybook"
|
|
19
|
+
`);let packages=["storybook",getExternalFramework(rendererId)?void 0:`@storybook/${rendererId}`,...frameworkPackages,...addonPackages,...extraPackages].filter(Boolean).filter(packageToInstall=>!installedDependencies.has(getPackageDetails(packageToInstall)[0])),versionedPackages=await packageManager.getVersionedPackages(packages);if(await fse2.ensureDir(`./${storybookConfigFolder}`),addMainFile&&await configureMain({framework:{name:frameworkInclude,options:options.framework||{}},storybookConfigFolder,docs:{autodocs:"tag"},addons:pnp?addons.map(wrapForPnp):addons,extensions,language,...staticDir?{staticDirs:[path3.join("..",staticDir)]}:null,...extraMain,...type!=="framework"?{core:{builder:builderInclude}}:{}}),await configurePreview({frameworkPreviewParts,storybookConfigFolder,language}),frameworkPackages.find(pkg2=>pkg2.match(/^@storybook\/.*-vite$/)||pkg2==="@storybook/sveltekit")){let previewHead=dedent2`
|
|
41
20
|
<script>
|
|
42
21
|
window.global = window;
|
|
43
|
-
|
|
44
|
-
|
|
22
|
+
</script>
|
|
23
|
+
`;await fse2.writeFile(`${storybookConfigFolder}/preview-head.html`,previewHead,{encoding:"utf8"})}let babelDependencies=addBabel&&builder!=="vite"?await getBabelDependencies(packageManager,packageJson):[];!files.some(fname=>fname.startsWith(".babel")||fname.startsWith("babel")||fname==="package.json")&&await generateStorybookBabelConfigInCWD();let depsToInstall=[...versionedPackages,...babelDependencies];if(depsToInstall.length>0&&packageManager.addDependencies({...npmOptions,packageJson},depsToInstall),addScripts&&packageManager.addStorybookCommandInScripts({port:6006}),addESLint&&packageManager.addESLintConfig(),addComponents){let templateLocation=hasFrameworkTemplates(framework)?framework:rendererId;await copyComponents(templateLocation,language,componentsDestinationPath)}}import fs2 from"fs";import prompts2 from"prompts";import dedent3 from"ts-dedent";var ANGULAR_JSON_PATH="angular.json",compoDocPreviewPrefix=dedent3`
|
|
24
|
+
import { setCompodocJson } from "@storybook/addon-docs/angular";
|
|
25
|
+
import docJson from "../documentation.json";
|
|
26
|
+
setCompodocJson(docJson);
|
|
27
|
+
`.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 packageJson=packageManager.retrievePackageJson(),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";if(root!==""){fs3.mkdirSync(storybookFolder,{recursive:!0});let rootReferencePathFromStorybookFolder=root.split("/").map(()=>"../").join("");fs3.writeFileSync(`${storybookFolder}/main.ts`,dedent4(`
|
|
28
|
+
import { StorybookConfig } from'@storybook/angular';
|
|
29
|
+
import mainRoot from'${rootReferencePathFromStorybookFolder}../.storybook/main';
|
|
30
|
+
|
|
31
|
+
const config: StorybookConfig = {
|
|
32
|
+
...mainRoot
|
|
33
|
+
};
|
|
34
|
+
export default config;
|
|
35
|
+
`))}angularJSON.addStorybookEntries({angularProjectName,storybookFolder,useCompodoc,root}),angularJSON.write();let isSbInstalled=isStorybookInstalled(packageJson,commandOptions.force);await baseGenerator(packageManager,npmOptions,{...updatedOptions,...useCompodoc&&{frameworkPreviewParts:{prefix:compoDocPreviewPrefix}}},"angular",{...useCompodoc&&{extraPackages:["@compodoc/compodoc"]},addScripts:!1,componentsDestinationPath:root?`${root}/src/stories`:void 0,addMainFile:!isSbInstalled,storybookConfigFolder:storybookFolder},"angular"),Object.keys(projects).length===1&&packageManager.addScripts({storybook:`ng run ${angularProjectName}:storybook`,"build-storybook":`ng run ${angularProjectName}:build-storybook`});let templateDir=join(getCliDir(),"templates","angular");return copyTemplate(templateDir,root||void 0),{projectName:angularProjectName}},ANGULAR_default=generator;import{join as join2}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=join2(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;import{join as join3}from"path";import chalk2 from"chalk";import shell from"shelljs";var generator5=async(packageManager,npmOptions,installServer)=>{let dirname=shell.ls("-d","ios/*.xcodeproj").stdout;if(dirname){let projectName=dirname.slice(4,dirname.length-10-1);projectName?shell.sed("-i","%APP_NAME%",projectName,"storybook/index.js"):paddedLog(chalk2.red("ERR: Could not determine project name, to fix: https://github.com/storybookjs/storybook/issues/1277"))}let packageJson=packageManager.retrievePackageJson(),missingReactDom=!packageJson.dependencies["react-dom"]&&!packageJson.devDependencies["react-dom"],reactVersion=packageJson.dependencies.react,webAddonsV5=["@storybook/addon-links@^5.3","@storybook/addon-knobs@^5.3","@storybook/addon-actions@^5.3"],packagesToResolve=[...["@storybook/addon-ondevice-knobs","@storybook/addon-ondevice-actions"],"@storybook/react-native",installServer&&"@storybook/react-native-server"].filter(Boolean),resolvedPackages=await packageManager.getVersionedPackages(packagesToResolve),packages=[...await getBabelDependencies(packageManager,packageJson),...resolvedPackages,...webAddonsV5,missingReactDom&&reactVersion&&`react-dom@${reactVersion}`].filter(Boolean);packageManager.addDependencies({...npmOptions,packageJson},packages),installServer&&packageManager.addStorybookCommandInScripts({port:7007});let templateDir=join3(getCliDir(),"templates","react-native");copyTemplate(templateDir)},REACT_NATIVE_default=generator5;import path4 from"path";import fs4 from"fs";import semver3 from"semver";var generator6=async(packageManager,npmOptions,options)=>{let monorepoRootPath=path4.join(__dirname,"..","..","..","..","..",".."),extraMain=options.linkable?{webpackFinal:`%%(config) => {
|
|
45
36
|
// add monorepo root as a valid directory to import modules from
|
|
46
37
|
config.resolve.plugins.forEach((p) => {
|
|
47
38
|
if (Array.isArray(p.appSrcs)) {
|
|
@@ -50,172 +41,215 @@ Add a project and re-run the installation`)}async function getBaseTsConfigName()
|
|
|
50
41
|
});
|
|
51
42
|
return config;
|
|
52
43
|
}
|
|
53
|
-
%%`}:{},craVersion=
|
|
54
|
-
❌ Unable to determine storybook version
|
|
44
|
+
%%`}:{},craVersion=semver3.coerce(packageManager.retrievePackageJson().dependencies["react-scripts"])?.version,isCra5=craVersion&&semver3.gte(craVersion,"5.0.0"),updatedOptions=isCra5?{...options,builder:"webpack5"}:options,extraPackages=["@storybook/node-logger"];isCra5&&(extraPackages.push("webpack"),extraPackages.push("babel-plugin-named-exports-order"),extraPackages.push("prop-types")),await baseGenerator(packageManager,npmOptions,updatedOptions,"react",{extraAddons:[`@storybook/preset-create-react-app${isCra5?"":"@3"}`],extraPackages,staticDir:fs4.existsSync(path4.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-html"]}),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;import{join as join4}from"path";var generator23=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"server",{extensions:["json"]});let templateDir=join4(getCliDir(),"templates","server");copyTemplate(templateDir)},SERVER_default=generator23;import prompts3 from"prompts";import chalk21 from"chalk";import boxen from"boxen";import{createWriteStream,move,remove}from"fs-extra";import tempy from"tempy";import dedent23 from"ts-dedent";import{join as join5}from"path";import chalk4 from"chalk";import{dedent as dedent6}from"ts-dedent";import semver5 from"semver";import chalk3 from"chalk";import{dedent as dedent5}from"ts-dedent";import semver4 from"semver";import{readConfig,writeConfig}from"@storybook/csf-tools";import{getStorybookInfo}from"@storybook/core-common";var logger2=console,webpack5={id:"webpack5",async checkWebpack5Builder(packageJson){let{mainConfig,version:storybookVersion}=getStorybookInfo(packageJson),storybookCoerced=storybookVersion&&semver4.coerce(storybookVersion)?.version;if(!storybookCoerced)throw new Error(dedent5`
|
|
45
|
+
❌ Unable to determine storybook version.
|
|
55
46
|
🤔 Are you running automigrate from your project directory?
|
|
56
|
-
`)
|
|
47
|
+
`);if(semver4.lt(storybookCoerced,"6.3.0"))return logger2.warn(dedent5`
|
|
57
48
|
Detected SB 6.3 or below, please upgrade storybook to use webpack5.
|
|
58
49
|
|
|
59
50
|
To upgrade to the latest stable release, run this from your project directory:
|
|
60
51
|
|
|
61
|
-
${
|
|
52
|
+
${chalk3.cyan("npx storybook upgrade")}
|
|
62
53
|
|
|
63
|
-
Add the ${
|
|
64
|
-
`.trim()),null;if(
|
|
54
|
+
Add the ${chalk3.cyan("--prerelease")} flag to get the latest prerelease.
|
|
55
|
+
`.trim()),null;if(semver4.gte(storybookCoerced,"7.0.0"))return null;if(!mainConfig)return logger2.warn("Unable to find storybook main.js config"),null;let main=await readConfig(mainConfig),builder=main.getFieldValue(["core","builder"]);return builder&&builder!=="webpack4"?(logger2.info(`Found builder ${builder}, skipping`),null):{storybookVersion,main}},async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),{dependencies,devDependencies}=packageJson,webpackVersion=dependencies.webpack||devDependencies.webpack,webpackCoerced=semver4.coerce(webpackVersion)?.version;if(!webpackCoerced||semver4.lt(webpackCoerced,"5.0.0")||semver4.gte(webpackCoerced,"6.0.0"))return null;let builderInfo=await this.checkWebpack5Builder(packageJson);return builderInfo?{webpackVersion,...builderInfo}:null},prompt({webpackVersion}){let webpackFormatted=chalk3.cyan(`webpack ${webpackVersion}`);return dedent5`
|
|
65
56
|
We've detected you're running ${webpackFormatted}.
|
|
66
57
|
Your Storybook's main.js files specifies webpack4, which is incompatible.
|
|
67
58
|
|
|
68
|
-
To run Storybook in webpack5-mode, we can install Storybook's ${
|
|
59
|
+
To run Storybook in webpack5-mode, we can install Storybook's ${chalk3.cyan("@storybook/builder-webpack5")} for you.
|
|
69
60
|
|
|
70
|
-
More info: ${
|
|
71
|
-
`},async run({result:{main,storybookVersion,webpackVersion},packageManager,dryRun}){let deps=[`@storybook/builder-webpack5@${storybookVersion}`];webpackVersion||deps.push("webpack@5"),
|
|
61
|
+
More info: ${chalk3.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#webpack-5-manager-build")}
|
|
62
|
+
`},async run({result:{main,storybookVersion,webpackVersion},packageManager,dryRun}){let deps=[`@storybook/builder-webpack5@${storybookVersion}`];webpackVersion||deps.push("webpack@5"),logger2.info(`\u2705 Adding dependencies: ${deps}`),dryRun||packageManager.addDependencies({installAsDevDependencies:!0},deps),logger2.info("\u2705 Setting `core.builder` to `@storybook/builder-webpack5` in main.js"),dryRun||(main.setFieldValue(["core","builder"],"@storybook/builder-webpack5"),await writeConfig(main))}};var cra5={id:"cra5",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),{dependencies,devDependencies}=packageJson,craVersion=dependencies["react-scripts"]||devDependencies["react-scripts"],craCoerced=semver5.coerce(craVersion)?.version;if(!craCoerced||semver5.lt(craCoerced,"5.0.0"))return null;let builderInfo=await webpack5.checkWebpack5Builder(packageJson);return builderInfo?{craVersion,...builderInfo}:null},prompt({craVersion,...rest}){let craFormatted=chalk4.cyan(`Create React App (CRA) ${craVersion}`);return console.log({...rest}),dedent6`
|
|
72
63
|
We've detected you are running ${craFormatted} which is powered by webpack5.
|
|
73
64
|
Your Storybook's main.js files specifies webpack4, which is incompatible.
|
|
74
65
|
|
|
75
|
-
In order to work with your version of CRA, we need to install Storybook's ${
|
|
66
|
+
In order to work with your version of CRA, we need to install Storybook's ${chalk4.cyan("@storybook/builder-webpack5")}.
|
|
76
67
|
|
|
77
|
-
More info: ${
|
|
78
|
-
`},async run(options){return webpack5.run({...options,result:{webpackVersion:null,...options.result}})}};import
|
|
68
|
+
More info: ${chalk4.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#cra5-upgrade")}
|
|
69
|
+
`},async run(options){return webpack5.run({...options,result:{webpackVersion:null,...options.result}})}};import chalk5 from"chalk";import{dedent as dedent7}from"ts-dedent";import semver6 from"semver";var angular12={id:"angular12",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),{dependencies,devDependencies}=packageJson,angularVersion=dependencies["@angular/core"]||devDependencies["@angular/core"],angularCoerced=semver6.coerce(angularVersion)?.version;if(!angularCoerced||semver6.lt(angularCoerced,"12.0.0"))return null;let builderInfo=await webpack5.checkWebpack5Builder(packageJson);return builderInfo?{angularVersion,...builderInfo}:null},prompt({angularVersion}){let angularFormatted=chalk5.cyan(`Angular ${angularVersion}`);return dedent7`
|
|
79
70
|
We've detected you are running ${angularFormatted} which is powered by webpack5.
|
|
80
71
|
Your Storybook's main.js files specifies webpack4, which is incompatible.
|
|
81
72
|
|
|
82
|
-
In order to work with your version of Angular, we need to install Storybook's ${
|
|
73
|
+
In order to work with your version of Angular, we need to install Storybook's ${chalk5.cyan("@storybook/builder-webpack5")}.
|
|
83
74
|
|
|
84
|
-
More info: ${
|
|
85
|
-
`},async run(options){return webpack5.run({...options,result:{webpackVersion:null,...options.result}})}};import
|
|
75
|
+
More info: ${chalk5.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#angular12-upgrade")}
|
|
76
|
+
`},async run(options){return webpack5.run({...options,result:{webpackVersion:null,...options.result}})}};import chalk6 from"chalk";import{dedent as dedent8}from"ts-dedent";import semver7 from"semver";var vue3={id:"vue3",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),{dependencies,devDependencies}=packageJson,vueVersion=dependencies.vue||devDependencies.vue,vueCoerced=semver7.coerce(vueVersion)?.version;if(!vueCoerced||semver7.lt(vueCoerced,"3.0.0"))return null;let builderInfo=await webpack5.checkWebpack5Builder(packageJson);return builderInfo?{vueVersion,...builderInfo}:null},prompt({vueVersion,storybookVersion}){let vueFormatted=chalk6.cyan(`Vue ${vueVersion}`),sbFormatted=chalk6.cyan(`Storybook ${storybookVersion}`);return dedent8`
|
|
86
77
|
We've detected you are running ${vueFormatted} with Storybook.
|
|
87
78
|
${sbFormatted} runs webpack4 by default, which is incompatible.
|
|
88
79
|
|
|
89
|
-
In order to work with your version of Vue, we need to install Storybook's ${
|
|
80
|
+
In order to work with your version of Vue, we need to install Storybook's ${chalk6.cyan("webpack5 builder")}.
|
|
90
81
|
|
|
91
|
-
More info: ${
|
|
92
|
-
`},async run(options){return webpack5.run({...options,result:{webpackVersion:null,...options.result}})}};import
|
|
93
|
-
❌ Unable to determine storybook version
|
|
82
|
+
More info: ${chalk6.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#vue3-upgrade")}
|
|
83
|
+
`},async run(options){return webpack5.run({...options,result:{webpackVersion:null,...options.result}})}};import chalk7 from"chalk";import{dedent as dedent9}from"ts-dedent";import semver8 from"semver";import{readConfig as readConfig2,writeConfig as writeConfig2}from"@storybook/csf-tools";import{getStorybookInfo as getStorybookInfo2}from"@storybook/core-common";var logger3=console,mainjsFramework={id:"mainjsFramework",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),{mainConfig,framework,version:storybookVersion}=getStorybookInfo2(packageJson);if(!mainConfig)return logger3.warn("Unable to find storybook main.js config, skipping"),null;let storybookCoerced=storybookVersion&&semver8.coerce(storybookVersion)?.version;if(!storybookCoerced)throw new Error(dedent9`
|
|
84
|
+
❌ Unable to determine storybook version.
|
|
94
85
|
🤔 Are you running automigrate from your project directory?
|
|
95
|
-
`)
|
|
86
|
+
`);let main=await readConfig2(mainConfig),currentFramework=main.getFieldNode(["framework"]),features=main.getFieldValue(["features"]);return currentFramework?null:features?.breakingChangesV7||features?.storyStoreV7||semver8.gte(storybookCoerced,"7.0.0")?{main,framework:`@storybook/${framework}`}:null},prompt({framework}){let frameworkFormatted=chalk7.cyan(`framework: '${framework}'`);return dedent9`
|
|
96
87
|
We've detected that your main.js configuration file does not specify the
|
|
97
88
|
'framework' field, which is a requirement in SB7.0 and above. We can add one
|
|
98
89
|
for you automatically:
|
|
99
90
|
|
|
100
91
|
${frameworkFormatted}
|
|
101
92
|
|
|
102
|
-
More info: ${
|
|
103
|
-
`},async run({result:{main,framework},dryRun}){
|
|
93
|
+
More info: ${chalk7.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#mainjs-framework-field")}
|
|
94
|
+
`},async run({result:{main,framework},dryRun}){logger3.info(`\u2705 Setting 'framework' to '${framework}' in main.js`),dryRun||(main.setFieldValue(["framework"],framework),await writeConfig2(main))}};import chalk8 from"chalk";import{dedent as dedent10}from"ts-dedent";import{readConfig as readConfig3,writeConfig as writeConfig3}from"@storybook/csf-tools";import{getStorybookInfo as getStorybookInfo3}from"@storybook/core-common";import{readFile,readJson,writeJson}from"fs-extra";import detectIndent from"detect-indent";import fse3 from"fs-extra";var SUPPORTED_ESLINT_EXTENSIONS=["js","cjs","json"],UNSUPPORTED_ESLINT_EXTENSIONS=["yaml","yml"],findEslintFile=()=>{let filePrefix=".eslintrc",unsupportedExtension=UNSUPPORTED_ESLINT_EXTENSIONS.find(ext=>fse3.existsSync(`${filePrefix}.${ext}`));if(unsupportedExtension)throw new Error(unsupportedExtension);let extension=SUPPORTED_ESLINT_EXTENSIONS.find(ext=>fse3.existsSync(`${filePrefix}.${ext}`));return extension?`${filePrefix}.${extension}`:null};var logger4=console,eslintPlugin={id:"eslintPlugin",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),{dependencies,devDependencies}=packageJson,eslintPluginStorybook=dependencies["eslint-plugin-storybook"]||devDependencies["eslint-plugin-storybook"],eslintDependency=dependencies.eslint||devDependencies.eslint;if(eslintPluginStorybook||!eslintDependency)return null;let{mainConfig}=getStorybookInfo3(packageJson);if(!mainConfig)return logger4.warn("Unable to find storybook main.js config, skipping"),null;let eslintFile,unsupportedExtension;try{eslintFile=findEslintFile()}catch(err){unsupportedExtension=err.message}if(!eslintFile&&!unsupportedExtension)return logger4.warn("Unable to find .eslintrc config file, skipping"),null;let main=await readConfig3(mainConfig);return{eslintFile,main,unsupportedExtension}},prompt(){return dedent10`
|
|
104
95
|
We've detected you are not using our eslint-plugin.
|
|
105
96
|
|
|
106
97
|
In order to have the best experience with Storybook and follow best practices, we advise you to install eslint-plugin-storybook.
|
|
107
98
|
|
|
108
|
-
More info: ${
|
|
109
|
-
`},async run({result:{eslintFile,unsupportedExtension},packageManager,dryRun}){let deps=["eslint-plugin-storybook"];if(
|
|
99
|
+
More info: ${chalk8.yellow("https://github.com/storybookjs/eslint-plugin-storybook#readme")}
|
|
100
|
+
`},async run({result:{eslintFile,unsupportedExtension},packageManager,dryRun}){let deps=["eslint-plugin-storybook"];if(logger4.info(`\u2705 Adding dependencies: ${deps}`),dryRun||packageManager.addDependencies({installAsDevDependencies:!0},deps),!dryRun&&unsupportedExtension){logger4.info(dedent10`
|
|
110
101
|
⚠️ The plugin was successfully installed but failed to configure.
|
|
111
102
|
|
|
112
103
|
Found an eslint config file with an unsupported automigration format: .eslintrc.${unsupportedExtension}.
|
|
113
104
|
The supported formats for this automigration are: ${SUPPORTED_ESLINT_EXTENSIONS.join(", ")}.
|
|
114
105
|
|
|
115
106
|
Please refer to https://github.com/storybookjs/eslint-plugin-storybook#usage to finish setting up the plugin manually.
|
|
116
|
-
`);return}if(
|
|
107
|
+
`);return}if(logger4.info(`\u2705 Adding Storybook plugin to ${eslintFile}`),!dryRun)if(eslintFile.endsWith("json")){let eslintConfig=await readJson(eslintFile),existingConfigValue=Array.isArray(eslintConfig.extends)?eslintConfig.extends:[eslintConfig.extends];eslintConfig.extends=[...existingConfigValue||[],"plugin:storybook/recommended"];let eslintFileContents=await readFile(eslintFile,"utf8"),spaces=detectIndent(eslintFileContents).amount||2;await writeJson(eslintFile,eslintConfig,{spaces})}else{let eslint=await readConfig3(eslintFile),extendsConfig=eslint.getFieldValue(["extends"])||[],existingConfigValue=Array.isArray(extendsConfig)?extendsConfig:[extendsConfig];eslint.setFieldValue(["extends"],[...existingConfigValue,"plugin:storybook/recommended"]),await writeConfig3(eslint)}}};import chalk9 from"chalk";import{dedent as dedent11}from"ts-dedent";import{readConfig as readConfig4,writeConfig as writeConfig4}from"@storybook/csf-tools";import{getStorybookInfo as getStorybookInfo4}from"@storybook/core-common";var logger5=console,builderVite={id:"builder-vite",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),{mainConfig}=getStorybookInfo4(packageJson);if(!mainConfig)return logger5.warn("Unable to find storybook main.js config"),null;let main=await readConfig4(mainConfig),builder=main.getFieldValue(["core","builder"]);return(typeof builder=="string"?builder:builder?.name)!=="storybook-builder-vite"?null:{builder,main,packageJson}},prompt({builder}){let builderFormatted=chalk9.cyan(JSON.stringify(builder,null,2));return dedent11`
|
|
117
108
|
We've detected you're using the community vite builder: ${builderFormatted}
|
|
118
109
|
|
|
119
|
-
'storybook-builder-vite' is deprecated and now located at ${
|
|
110
|
+
'storybook-builder-vite' is deprecated and now located at ${chalk9.cyan("@storybook/builder-vite")}.
|
|
120
111
|
|
|
121
112
|
We can upgrade your project to use the new builder automatically.
|
|
122
113
|
|
|
123
|
-
More info: ${
|
|
124
|
-
`},async run({result:{builder,main,packageJson},packageManager,dryRun}){let{dependencies={},devDependencies={}}=packageJson;if(
|
|
125
|
-
❌ Unable to determine storybook version
|
|
114
|
+
More info: ${chalk9.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#vite-builder-renamed")}
|
|
115
|
+
`},async run({result:{builder,main,packageJson},packageManager,dryRun}){let{dependencies={},devDependencies={}}=packageJson;if(logger5.info("Removing existing 'storybook-builder-vite' dependency"),dryRun||(delete dependencies["storybook-builder-vite"],delete devDependencies["storybook-builder-vite"],packageManager.writePackageJson(packageJson)),logger5.info("Adding '@storybook/builder-vite' as dev dependency"),dryRun||packageManager.addDependencies({installAsDevDependencies:!0},["@storybook/builder-vite"]),logger5.info("Updating main.js to use vite builder"),!dryRun){let updatedBuilder=typeof builder=="string"?"@storybook/builder-vite":{name:"@storybook/builder-vite",options:builder.options};main.setFieldValue(["core","builder"],updatedBuilder),await writeConfig4(main)}}};import chalk10 from"chalk";import{dedent as dedent12}from"ts-dedent";import semver9 from"semver";import{getStorybookInfo as getStorybookInfo5}from"@storybook/core-common";var logger6=console,getStorybookScripts=allScripts=>Object.keys(allScripts).reduce((acc,key)=>{let isStorybookScript=!1,allWordsFromScript=allScripts[key].split(" "),newScript=allWordsFromScript.map((currentWord,index)=>{let previousWord=allWordsFromScript[index-1],isSbBinary=currentWord==="build-storybook"||currentWord==="start-storybook"||currentWord==="sb",isPrependedByPkgManager=previousWord&&["npx","run","yarn","pnpx"].some(cmd=>previousWord.includes(cmd));return isSbBinary&&!isPrependedByPkgManager?(isStorybookScript=!0,currentWord.replace("sb","storybook").replace("start-storybook","storybook dev").replace("build-storybook","storybook build")):currentWord}).join(" ");return isStorybookScript&&(acc[key]={before:allScripts[key],after:newScript}),acc},{}),sbScripts={id:"sb-scripts",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),{scripts={}}=packageJson,{version:storybookVersion}=getStorybookInfo5(packageJson),storybookCoerced=storybookVersion&&semver9.coerce(storybookVersion)?.version;if(!storybookCoerced)throw new Error(dedent12`
|
|
116
|
+
❌ Unable to determine storybook version.
|
|
126
117
|
🤔 Are you running automigrate from your project directory?
|
|
127
|
-
`)
|
|
128
|
-
`)),acc),[]);return
|
|
118
|
+
`);if(semver9.lt(storybookCoerced,"7.0.0"))return null;let storybookScripts=getStorybookScripts(scripts);return Object.keys(storybookScripts).length===0?null:{packageJson,storybookScripts,storybookVersion}},prompt({storybookVersion,storybookScripts}){let sbFormatted=chalk10.cyan(`Storybook ${storybookVersion}`),newScriptsMessage=Object.keys(storybookScripts).reduce((acc,scriptKey)=>(acc.push([chalk10.bold(scriptKey),"from:",chalk10.cyan(storybookScripts[scriptKey].before),"to:",chalk10.cyan(storybookScripts[scriptKey].after)].join(`
|
|
119
|
+
`)),acc),[]);return dedent12`
|
|
129
120
|
We've detected you are using ${sbFormatted} with scripts from previous versions of Storybook.
|
|
130
|
-
Starting in Storybook 7, the ${
|
|
131
|
-
In order to work with ${sbFormatted},
|
|
121
|
+
Starting in Storybook 7, the ${chalk10.yellow("start-storybook")} and ${chalk10.yellow("build-storybook")} binaries have changed to ${chalk10.magenta("storybook dev")} and ${chalk10.magenta("storybook build")} respectively.
|
|
122
|
+
In order to work with ${sbFormatted}, your storybook scripts have to be adjusted to use the binary. We can adjust them for you:
|
|
132
123
|
|
|
133
124
|
${newScriptsMessage.join(`
|
|
134
125
|
|
|
135
126
|
`)}
|
|
136
127
|
|
|
137
|
-
In case this migration did not cover all of your scripts, or you'd like more info: ${
|
|
138
|
-
`},async run({result:{storybookScripts
|
|
128
|
+
In case this migration did not cover all of your scripts, or you'd like more info: ${chalk10.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#start-storybook--build-storybook-binaries-removed")}
|
|
129
|
+
`},async run({result:{storybookScripts},packageManager,dryRun}){if(logger6.info("\u2705 Updating scripts in package.json"),logger6.log(),!dryRun){let newScripts=Object.keys(storybookScripts).reduce((acc,scriptKey)=>(acc[scriptKey]=storybookScripts[scriptKey].after,acc),{});logger6.log(),packageManager.addScripts(newScripts)}}};import chalk11 from"chalk";import{dedent as dedent13}from"ts-dedent";import semver10 from"semver";import{getStorybookInfo as getStorybookInfo6}from"@storybook/core-common";var logger7=console,sbBinary={id:"storybook-binary",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),{devDependencies,dependencies}=packageJson,{version:storybookVersion}=getStorybookInfo6(packageJson),allDeps={...dependencies,...devDependencies},storybookCoerced=storybookVersion&&semver10.coerce(storybookVersion)?.version;if(!storybookCoerced)throw new Error(dedent13`
|
|
130
|
+
❌ Unable to determine storybook version.
|
|
131
|
+
🤔 Are you running automigrate from your project directory?
|
|
132
|
+
`);if(semver10.lt(storybookCoerced,"7.0.0"))return null;let hasSbBinary=!!allDeps.sb,hasStorybookBinary=!!allDeps.storybook;return!hasSbBinary&&hasStorybookBinary?null:{hasSbBinary,hasStorybookBinary,storybookVersion,packageJson}},prompt({storybookVersion,hasSbBinary,hasStorybookBinary}){let sbFormatted=chalk11.cyan(`Storybook ${storybookVersion}`),storybookBinaryMessage=hasStorybookBinary?"":`We've detected you are using ${sbFormatted} without Storybook's ${chalk11.magenta("storybook")} binary. Starting in Storybook 7.0, it has to be installed.`;return dedent13`
|
|
133
|
+
${storybookBinaryMessage}
|
|
134
|
+
${hasSbBinary?`You're using the 'sb' binary and it should be replaced, as 'storybook' is the recommended way to run Storybook.
|
|
135
|
+
`:""}
|
|
136
|
+
|
|
137
|
+
More info: ${chalk11.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#start-storybook--build-storybook-binaries-removed")}
|
|
138
|
+
`},async run({result:{packageJson,hasSbBinary,hasStorybookBinary},packageManager,dryRun}){if(hasSbBinary&&(logger7.info("\u2705 Removing 'sb' dependency"),dryRun||packageManager.removeDependencies({skipInstall:!hasStorybookBinary,packageJson},["sb"])),!hasStorybookBinary&&(logger7.log(),logger7.info("\u2705 Adding 'storybook' as dev dependency"),logger7.log(),!dryRun)){let versionToInstall=getStorybookVersionSpecifier(packageJson);packageManager.addDependencies({installAsDevDependencies:!0},[`storybook@${versionToInstall}`])}}};import chalk12 from"chalk";import dedent14 from"ts-dedent";import semver11 from"semver";import{readConfig as readConfig5,writeConfig as writeConfig5}from"@storybook/csf-tools";import{getStorybookInfo as getStorybookInfo7}from"@storybook/core-common";var logger8=console,getNextjsAddonOptions=addons=>{let nextjsAddon=addons?.find(addon=>typeof addon=="string"?addon==="storybook-addon-next":addon.name==="storybook-addon-next");return!nextjsAddon||typeof nextjsAddon=="string"?{}:nextjsAddon.options||{}},nextjsFramework={id:"nextjsFramework",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),allDeps={...packageJson.dependencies,...packageJson.devDependencies};if(!allDeps.next)return null;let{mainConfig,version:storybookVersion}=getStorybookInfo7(packageJson);if(!mainConfig)return logger8.warn("Unable to find storybook main.js config, skipping"),null;let storybookCoerced=storybookVersion&&semver11.coerce(storybookVersion)?.version;if(!storybookCoerced)throw new Error(dedent14`
|
|
139
|
+
❌ Unable to determine storybook version.
|
|
140
|
+
🤔 Are you running automigrate from your project directory?
|
|
141
|
+
`);if(!semver11.gte(storybookCoerced,"7.0.0"))return null;let main=await readConfig5(mainConfig),frameworkPackage=main.getFieldValue(["framework"]);if(!frameworkPackage)return null;let frameworkPackageName=typeof frameworkPackage=="string"?frameworkPackage:frameworkPackage.name;if(frameworkPackageName==="@storybook/react-vite")return logger8.info(dedent14`
|
|
142
|
+
We've detected you are using Storybook in a Next.js project.
|
|
143
|
+
|
|
144
|
+
In Storybook 7, we introduced a new framework package for Next.js projects: @storybook/nextjs.
|
|
145
|
+
|
|
146
|
+
This package provides a better experience for Next.js users, however it is only compatible with the webpack 5 builder, so we can't automigrate for you, as you are using the Vite builder.
|
|
147
|
+
|
|
148
|
+
If you are interested in using this package, see: ${chalk12.yellow("https://github.com/storybookjs/storybook/blob/next/code/frameworks/nextjs/README.md")}
|
|
149
|
+
`),null;if(frameworkPackageName!=="@storybook/react-webpack5")return null;let addonOptions=getNextjsAddonOptions(main.getFieldValue(["addons"])),frameworkOptions=main.getFieldValue(["framework","options"])||{},addonsToRemove=["storybook-addon-next","storybook-addon-next-router"].filter(dep=>allDeps[dep]);return{main,addonsToRemove,frameworkOptions:{...frameworkOptions,...addonOptions},packageJson}},prompt({addonsToRemove}){let addonsMessage="";return addonsToRemove.length>0&&(addonsMessage=`
|
|
150
|
+
This package also supports features provided by the following packages, which can now be removed:
|
|
151
|
+
${addonsToRemove.map(dep=>`- ${chalk12.cyan(dep)}`).join(", ")}
|
|
152
|
+
`),dedent14`
|
|
153
|
+
We've detected you are using Storybook in a ${chalk12.bold("Next.js")} project.
|
|
154
|
+
|
|
155
|
+
In Storybook 7, we introduced a new framework package for Next.js projects: ${chalk12.magenta("@storybook/nextjs")}.
|
|
156
|
+
|
|
157
|
+
This package is a replacement for ${chalk12.magenta("@storybook/react-webpack5")} and provides a better experience for Next.js users.
|
|
158
|
+
${addonsMessage}
|
|
159
|
+
To learn more about it, see: ${chalk12.yellow("https://github.com/storybookjs/storybook/blob/next/code/frameworks/nextjs/README.md")}
|
|
160
|
+
`},async run({result:{addonsToRemove,main,frameworkOptions,packageJson},packageManager,dryRun}){let dependenciesToRemove=[...addonsToRemove,"@storybook/react-webpack5"];if(dependenciesToRemove.length>0&&(logger8.info(`\u2705 Removing redundant packages: ${dependenciesToRemove.join(", ")}`),!dryRun)){packageManager.removeDependencies({skipInstall:!0,packageJson},dependenciesToRemove);let updatedAddons=main.getFieldValue(["addons"]).filter(addon=>typeof addon=="string"?!addonsToRemove.includes(addon):addon.name?!addonsToRemove.includes(addon.name):!1);main.setFieldValue(["addons"],updatedAddons)}if(logger8.info("\u2705 Installing new dependencies: @storybook/nextjs"),!dryRun){let versionToInstall=getStorybookVersionSpecifier(packageJson);packageManager.addDependencies({installAsDevDependencies:!0,packageJson},[`@storybook/nextjs@${versionToInstall}`])}logger8.info("\u2705 Updating framework field in main.js"),dryRun||(main.setFieldValue(["framework","options"],frameworkOptions),main.setFieldValue(["framework","name"],"@storybook/nextjs"),await writeConfig5(main))}};import chalk13 from"chalk";import dedent15 from"ts-dedent";import semver12 from"semver";import{readConfig as readConfig6,writeConfig as writeConfig6}from"@storybook/csf-tools";import{getStorybookInfo as getStorybookInfo8}from"@storybook/core-common";var logger9=console,packagesMap={"@storybook/react":{webpack5:"@storybook/react-webpack5",vite:"@storybook/react-vite"},"@storybook/preact":{webpack5:"@storybook/preact-webpack5",vite:"@storybook/preact-vite"},"@storybook/server":{webpack5:"@storybook/server-webpack5"},"@storybook/angular":{webpack5:"@storybook/angular"},"@storybook/vue":{webpack5:"@storybook/vue-webpack5"},"@storybook/vue3":{webpack5:"@storybook/vue3-webpack5",vite:"@storybook/vue3-vite"},"@storybook/svelte":{webpack5:"@storybook/svelte-webpack5",vite:"@storybook/svelte-vite"},"@storybook/web-components":{webpack5:"@storybook/web-components-webpack5",vite:"@storybook/web-components-vite"},"@storybook/html":{webpack5:"@storybook/html-webpack5",vite:"@storybook/html-vite"}},getBuilder=builder=>typeof builder=="string"?builder.includes("vite")?"vite":"webpack5":builder?.name.includes("vite")?"vite":"webpack5",getFrameworkOptions=(framework,main)=>{let frameworkOptions={};try{frameworkOptions=main.getFieldValue([`${framework}Options`])}catch(e){logger9.warn(dedent15`
|
|
139
161
|
Unable to get the ${framework}Options field.
|
|
140
162
|
|
|
141
163
|
Please review the changes made to your main.js config and make any necessary changes.
|
|
142
164
|
The ${framework}Options should be moved to the framework.options field.
|
|
143
165
|
|
|
144
166
|
The following error occurred when we tried to get the ${framework}Options field:
|
|
145
|
-
`),console.log(e)}return frameworkOptions||{}},newFrameworks={id:"newFrameworks",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),allDeps={...packageJson.dependencies,...packageJson.devDependencies},{mainConfig,version:storybookVersion,framework}=
|
|
146
|
-
❌ Unable to determine storybook version
|
|
167
|
+
`),console.log(e)}return frameworkOptions||{}},newFrameworks={id:"newFrameworks",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),allDeps={...packageJson.dependencies,...packageJson.devDependencies},{mainConfig,version:storybookVersion,framework}=getStorybookInfo8(packageJson);if(!mainConfig)return logger9.warn("Unable to find storybook main.js config, skipping"),null;let storybookCoerced=storybookVersion&&semver12.coerce(storybookVersion)?.version;if(!storybookCoerced)throw new Error(dedent15`
|
|
168
|
+
❌ Unable to determine storybook version.
|
|
147
169
|
🤔 Are you running automigrate from your project directory?
|
|
148
|
-
`)
|
|
149
|
-
❌
|
|
150
|
-
|
|
151
|
-
`),null;let frameworkOptions=getFrameworkOptions(framework,main),dependenciesToRemove=["@storybook/builder-webpack5","@storybook/manager-webpack5","@storybook/builder-webpack4","@storybook/manager-webpack4","@storybook/builder-vite","storybook-builder-vite"].filter(dep=>allDeps[dep]),dependenciesToAdd=[];return newFrameworkPackage!==frameworkPackage&&dependenciesToAdd.push(newFrameworkPackage),{main,dependenciesToAdd,dependenciesToRemove,frameworkPackage:newFrameworkPackage,frameworkOptions,builderInfo,packageJson}},prompt(){return dedent11`
|
|
170
|
+
`);if(!semver12.gte(storybookCoerced,"7.0.0"))return null;let main=await readConfig6(mainConfig),frameworkPackage=main.getNameFromPath(["framework"]),builder=main.getFieldValue(["core","builder"]);if(!frameworkPackage||!Object.keys(packagesMap).includes(frameworkPackage))return null;let builderInfo={name:getBuilder(builder),options:main.getFieldValue(["core","builder","options"])||{}},newFrameworkPackage=packagesMap[frameworkPackage][builderInfo.name];if(!newFrameworkPackage)return null;let frameworkOptions=newFrameworkPackage==="@storybook/svelte-vite"?{}:getFrameworkOptions(framework,main),dependenciesToRemove=["@storybook/builder-webpack5","@storybook/manager-webpack5","@storybook/builder-webpack4","@storybook/manager-webpack4","@storybook/builder-vite","storybook-builder-vite"].filter(dep=>allDeps[dep]),dependenciesToAdd=[];if(newFrameworkPackage!==frameworkPackage&&dependenciesToAdd.push(newFrameworkPackage),allDeps.vite&&semver12.lt(semver12.coerce(allDeps.vite).version,"3.0.0"))throw new Error(dedent15`
|
|
171
|
+
❌ Your project should be upgraded to use the framework package ${chalk13.bold(newFrameworkPackage)}, but we detected that you are using Vite ${chalk13.bold(allDeps.vite)}, which is unsupported in ${chalk13.bold("Storybook 7.0")}. Please upgrade Vite to ${chalk13.bold("3.0.0 or higher")} and rerun this migration.
|
|
172
|
+
`);return!dependenciesToRemove.length&&!dependenciesToAdd.length?null:{main,dependenciesToAdd,dependenciesToRemove,frameworkPackage:newFrameworkPackage,frameworkOptions,builderInfo,packageJson}},prompt({frameworkPackage,dependenciesToRemove}){return dedent15`
|
|
152
173
|
We've detected you are using an older format of Storybook frameworks and builders.
|
|
153
174
|
|
|
154
175
|
In Storybook 7, frameworks also specify the builder to be used.
|
|
155
176
|
|
|
156
|
-
We can remove the dependencies that are no longer needed
|
|
177
|
+
We can remove the dependencies that are no longer needed: ${chalk13.yellow(dependenciesToRemove.join(", "))}
|
|
178
|
+
|
|
179
|
+
And set up the ${chalk13.magenta(frameworkPackage)} framework that already includes the builder.
|
|
157
180
|
|
|
158
|
-
To learn more about the framework field, see: ${
|
|
181
|
+
To learn more about the framework field, see: ${chalk13.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#framework-field-mandatory")}
|
|
159
182
|
|
|
160
|
-
${
|
|
183
|
+
${chalk13.underline(chalk13.bold(chalk13.cyan("Webpack4 users")))}
|
|
161
184
|
|
|
162
185
|
Unless you're using Storybook's Vite builder, this automigration will install a Webpack5-based framework.
|
|
163
186
|
|
|
164
187
|
If you were using Storybook's Webpack4 builder (default in 6.x, discontinued in 7.0), this could be a breaking
|
|
165
|
-
change--especially if your project has a custom webpack configuration.
|
|
188
|
+
change -- especially if your project has a custom webpack configuration.
|
|
166
189
|
|
|
167
|
-
To learn more about migrating from Webpack4, see: ${
|
|
168
|
-
`},async run({result:{dependenciesToAdd,dependenciesToRemove,main,frameworkPackage,frameworkOptions,builderInfo,packageJson},packageManager,dryRun}){if(logger9.info(`\u2705 Removing legacy dependencies: ${dependenciesToRemove.join(", ")}`),dryRun||packageManager.removeDependencies({skipInstall:dependenciesToAdd.length>0,packageJson},dependenciesToRemove),dependenciesToAdd.length>0&&(logger9.info(`\u2705 Installing new dependencies: ${dependenciesToAdd.join(", ")}`),!dryRun)){let versionToInstall=getStorybookVersionSpecifier(packageJson),depsToAdd=dependenciesToAdd.map(dep=>`${dep}@${versionToInstall}`);packageManager.addDependencies({installAsDevDependencies:!0},depsToAdd)}if(!dryRun){logger9.info("\u2705 Updating framework field in main.js");let currentCore=main.getFieldValue(["core"]);main.setFieldValue(["framework","name"],frameworkPackage),main.setFieldValue(["framework","options"],frameworkOptions),currentCore?.builder&&delete currentCore.builder,Object.keys(builderInfo.options).length>0&&main.setFieldValue(["framework","options","builder"],builderInfo.options),currentCore&&(Object.keys(currentCore).length===0?main.removeField(["core"]):main.setFieldValue(["core"],currentCore)),await
|
|
169
|
-
|
|
190
|
+
To learn more about migrating from Webpack4, see: ${chalk13.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#webpack4-support-discontinued")}
|
|
191
|
+
`},async run({result:{dependenciesToAdd,dependenciesToRemove,main,frameworkPackage,frameworkOptions,builderInfo,packageJson},packageManager,dryRun}){if(logger9.info(`\u2705 Removing legacy dependencies: ${dependenciesToRemove.join(", ")}`),dryRun||packageManager.removeDependencies({skipInstall:dependenciesToAdd.length>0,packageJson},dependenciesToRemove),dependenciesToAdd.length>0&&(logger9.info(`\u2705 Installing new dependencies: ${dependenciesToAdd.join(", ")}`),!dryRun)){let versionToInstall=getStorybookVersionSpecifier(packageJson),depsToAdd=dependenciesToAdd.map(dep=>`${dep}@${versionToInstall}`);packageManager.addDependencies({installAsDevDependencies:!0},depsToAdd)}if(!dryRun){logger9.info("\u2705 Updating framework field in main.js");let currentCore=main.getFieldValue(["core"]);main.setFieldValue(["framework","name"],frameworkPackage),main.setFieldValue(["framework","options"],frameworkOptions),currentCore?.builder&&delete currentCore.builder,frameworkPackage==="@storybook/svelte-vite"&&main.getFieldNode(["svelteOptions"])&&(logger9.info("\u2705 Removing svelteOptions field in main.js"),main.removeField(["svelteOptions"])),Object.keys(builderInfo.options).length>0&&main.setFieldValue(["framework","options","builder"],builderInfo.options),currentCore&&(Object.keys(currentCore).length===0?main.removeField(["core"]):main.setFieldValue(["core"],currentCore)),await writeConfig6(main)}}};import chalk14 from"chalk";import dedent16 from"ts-dedent";import{getStorybookInfo as getStorybookInfo9}from"@storybook/core-common";import{readFile as readFile2}from"fs-extra";var RemovedAPIs=(RemovedAPIs2=>(RemovedAPIs2.addDecorator="addDecorator",RemovedAPIs2.addParameters="addParameters",RemovedAPIs2.addLoader="addLoader",RemovedAPIs2.getStorybook="getStorybook",RemovedAPIs2.setAddon="setAddon",RemovedAPIs2.clearDecorators="clearDecorators",RemovedAPIs2))(RemovedAPIs||{}),removedGlobalClientAPIs={id:"removedglobalclientapis",promptOnly:!0,async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),{previewConfig}=getStorybookInfo9(packageJson);if(previewConfig){let contents=await readFile2(previewConfig,"utf8"),usedAPIs=Object.values(RemovedAPIs).reduce((acc,item)=>(contents.includes(item)&&acc.push(item),acc),[]);if(usedAPIs.length)return{usedAPIs,previewPath:previewConfig}}return null},prompt({usedAPIs,previewPath}){return dedent16`
|
|
192
|
+
${chalk14.bold(chalk14.red("Attention"))}: We could not automatically make this change. You'll need to do it manually.
|
|
193
|
+
|
|
194
|
+
The following APIs (used in "${chalk14.yellow(previewPath)}") have been removed from Storybook:
|
|
170
195
|
|
|
171
|
-
${usedAPIs.map(api=>`- ${
|
|
196
|
+
${usedAPIs.map(api=>`- ${chalk14.cyan(api)}`).join(`
|
|
172
197
|
`)}
|
|
173
198
|
|
|
174
|
-
You'll need to update "${chalk13.yellow(previewPath)}" manually.
|
|
175
|
-
|
|
176
199
|
Please see the migration guide for more information:
|
|
177
|
-
${
|
|
178
|
-
`}
|
|
179
|
-
We've found ${
|
|
200
|
+
${chalk14.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#removed-global-client-apis")}
|
|
201
|
+
`}};import chalk15 from"chalk";import{dedent as dedent17}from"ts-dedent";import{basename}from"path";import fse4 from"fs-extra";import globby from"globby";var MDX1_STYLE_START=/<style>{`/g,MDX1_STYLE_END=/`}<\/style>/g,MDX1_COMMENT=/<!--(.+)-->/g,MDX1_CODEBLOCK=/(?:\n~~~(?:\n|.)*?\n~~~)|(?:\n```(?:\n|.)*?\n```)/g,fixMdxStyleTags=mdx=>mdx.replace(MDX1_STYLE_START,"<style>\n {`").replace(MDX1_STYLE_END," `}\n</style>"),fixMdxComments=mdx=>{let codeblocks=mdx.matchAll(MDX1_CODEBLOCK);return mdx.split(MDX1_CODEBLOCK).map(v=>v.replace(MDX1_COMMENT,(original,group)=>`{/*${group}*/}`)).reduce((acc,item,i)=>{let next=codeblocks.next();return next.done?acc+item:acc+item+next.value[0]},"")},logger10=console,mdx1to2={id:"mdx1to2",async check(){let storiesMdxFiles=await globby("./!(node_modules)**/*.(story|stories).mdx");return storiesMdxFiles.length?{storiesMdxFiles}:void 0},prompt({storiesMdxFiles}){return dedent17`
|
|
202
|
+
We've found ${chalk15.yellow(storiesMdxFiles.length)} '.stories.mdx' files in your project.
|
|
180
203
|
|
|
181
204
|
Storybook has upgraded to MDX2 (https://mdxjs.com/blog/v2/), which contains breaking changes from V1.
|
|
182
|
-
|
|
183
205
|
We can try to automatically upgrade your MDX files to MDX2 format using some common patterns.
|
|
184
206
|
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
207
|
+
Some steps might require manual intervention. You can find a full guide for how to manually upgrade your files here:
|
|
208
|
+
${chalk15.cyan("https://storybook.js.org/docs/7.0/react/writing-docs/mdx#breaking-changes")}
|
|
209
|
+
`},async run({result:{storiesMdxFiles},dryRun}){await Promise.all([...storiesMdxFiles.map(async fname=>{let contents=await fse4.readFile(fname,"utf-8"),updated=fixMdxComments(fixMdxStyleTags(contents));updated===contents?logger10.info(`\u{1F197} Unmodified ${basename(fname)}`):(logger10.info(`\u2705 Modified ${basename(fname)}`),dryRun||await fse4.writeFile(fname,updated))})])}};import chalk16 from"chalk";import{dedent as dedent18}from"ts-dedent";import{readConfig as readConfig7,writeConfig as writeConfig7}from"@storybook/csf-tools";import{getStorybookInfo as getStorybookInfo10}from"@storybook/core-common";var logger11=console,autodocsTrue={id:"autodocsTrue",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),{mainConfig}=getStorybookInfo10(packageJson);if(!mainConfig)return logger11.warn("Unable to find storybook main.js config, skipping"),null;let main=await readConfig7(mainConfig),docs=main.getFieldValue(["docs"]),docsPageToAutodocsMapping={true:"tag",automatic:!0,false:!1};if(docs?.docsPage){let oldValue=docs?.docsPage.toString();if(!(oldValue in docsPageToAutodocsMapping))throw new Error(`Unexpected value for docs.docsPage: ${oldValue}`);return{main,value:docsPageToAutodocsMapping[oldValue]}}return docs?.autodocs===void 0?{main}:null},prompt({value}){let autodocsFormatted=chalk16.cyan(`docs: { autodocs: ${JSON.stringify(value??!0)} }`);return value?dedent18`
|
|
210
|
+
We've changed the configuration of autodocs (previous docsPage), so now the value:
|
|
211
|
+
- docs.autodocs: true -- means automatically create docs for every CSF file
|
|
212
|
+
- docs.autodocs: 'tag' -- means only create autodocs for CSF files with the 'autodocs' tag
|
|
213
|
+
- docs.autodocs: false -- means never create autodocs
|
|
214
|
+
|
|
215
|
+
Based on your prior configuration, we can set the \`docs.autodocs\` to keep your old behaviour:
|
|
192
216
|
|
|
193
|
-
${
|
|
217
|
+
${autodocsFormatted}
|
|
194
218
|
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
219
|
+
${value==="tag"&&"NOTE: it is important you change all CSF files to use the 'autodocs' tag rather than the 'docsPage' tag."}
|
|
220
|
+
|
|
221
|
+
More info: ${chalk16.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#autodocs")}
|
|
222
|
+
`:dedent18`
|
|
223
|
+
We've detected that your main.js configuration file has not configured autodocs. In 6.x we
|
|
224
|
+
we defaulted to having a autodocs for every story, in 7.x you need to opt in per-component.
|
|
225
|
+
However, we can set the \`docs.autodocs\` to true to approximate the old behaviour:
|
|
226
|
+
|
|
227
|
+
${autodocsFormatted}
|
|
228
|
+
|
|
229
|
+
More info: ${chalk16.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#autodocs")}
|
|
230
|
+
`},async run({result:{main,value},dryRun}){logger11.info("\u2705 Setting 'docs.autodocs' to true in main.js"),dryRun||(main.removeField(["docs","docsPage"]),main.setFieldValue(["docs","autodocs"],value??!0),await writeConfig7(main))}};import chalk17 from"chalk";import dedent19 from"ts-dedent";import semver13 from"semver";import{readConfig as readConfig8,writeConfig as writeConfig8}from"@storybook/csf-tools";import{getStorybookInfo as getStorybookInfo11}from"@storybook/core-common";var logger12=console,fixId="sveltekitFramework",sveltekitFramework={id:fixId,async check({packageManager}){let packageJson=packageManager.retrievePackageJson();if(!{...packageJson.dependencies,...packageJson.devDependencies}["@sveltejs/kit"])return null;let{mainConfig,version:storybookVersion}=getStorybookInfo11(packageJson);if(!mainConfig)return logger12.warn("Unable to find storybook main.js config, skipping"),null;let sbVersionCoerced=storybookVersion&&semver13.coerce(storybookVersion)?.version;if(!sbVersionCoerced)throw new Error(dedent19`
|
|
231
|
+
❌ Unable to determine storybook version.
|
|
198
232
|
🤔 Are you running automigrate from your project directory?
|
|
199
|
-
`)
|
|
200
|
-
❌ Unable to determine Storybook framework, skipping ${
|
|
233
|
+
`);if(!semver13.gte(sbVersionCoerced,"7.0.0"))return null;let main=await readConfig8(mainConfig),framework=main.getNameFromPath(["framework"]);if(!framework)return logger12.warn(dedent19`
|
|
234
|
+
❌ Unable to determine Storybook framework, skipping ${chalk17.cyan(fixId)} fix.
|
|
201
235
|
🤔 Are you running automigrate from your project directory?
|
|
202
|
-
`),null;
|
|
236
|
+
`),null;if(framework==="@storybook/sveltekit")return null;if(framework==="@storybook/svelte-vite")return{main,packageJson,dependenciesToRemove:["@storybook/svelte-vite"]};if(framework!=="@storybook/svelte")return logger12.warn(dedent19`
|
|
203
237
|
We've detected you are using Storybook in a SvelteKit project.
|
|
204
238
|
|
|
205
239
|
In Storybook 7, we introduced a new framework package for SvelteKit projects: @storybook/sveltekit.
|
|
206
240
|
|
|
207
241
|
This package provides a better experience for SvelteKit users, however it is only compatible with the Svelte framework and the Vite builder, so we can't automigrate for you, as you are using another framework and builder combination.
|
|
208
242
|
|
|
209
|
-
If you are interested in using this package, see: ${
|
|
210
|
-
`),null;let builder=main.getFieldValue(["core","builder"]);return["@storybook/builder-vite","storybook-builder-vite"].includes(builder)?{main,
|
|
243
|
+
If you are interested in using this package, see: ${chalk17.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#sveltekit-needs-the-storybooksveltekit-framework")}
|
|
244
|
+
`),null;let builder=main.getFieldValue(["core","builder"]);return["@storybook/builder-vite","storybook-builder-vite"].includes(builder)?{main,packageJson,dependenciesToRemove:[builder]}:(logger12.warn(dedent19`
|
|
211
245
|
We've detected you are using Storybook in a SvelteKit project.
|
|
212
246
|
|
|
213
247
|
In Storybook 7, we introduced a new framework package for SvelteKit projects: @storybook/sveltekit.
|
|
214
248
|
|
|
215
249
|
This package provides a better experience for SvelteKit users, however it is only compatible with the Vite builder, so we can't automigrate for you, as you are using another builder.
|
|
216
250
|
|
|
217
|
-
If you are interested in using this package, see: ${
|
|
218
|
-
`),null)},prompt(){return
|
|
251
|
+
If you are interested in using this package, see: ${chalk17.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#sveltekit-needs-the-storybooksveltekit-framework")}
|
|
252
|
+
`),null)},prompt(){return dedent19`
|
|
219
253
|
We've detected you are using Storybook in a SvelteKit project.
|
|
220
254
|
|
|
221
255
|
In Storybook 7, we introduced a new framework package for SvelteKit projects: @storybook/sveltekit
|
|
@@ -223,9 +257,9 @@ Add a project and re-run the installation`)}async function getBaseTsConfigName()
|
|
|
223
257
|
|
|
224
258
|
We can automatically migrate your project to use the new SvelteKit framework package.
|
|
225
259
|
|
|
226
|
-
To learn more about this change, see: ${
|
|
227
|
-
`},async run({result:{main,
|
|
228
|
-
`);return
|
|
260
|
+
To learn more about this change, see: ${chalk17.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#sveltekit-needs-the-storybooksveltekit-framework")}
|
|
261
|
+
`},async run({result:{main,packageJson,dependenciesToRemove},packageManager,dryRun}){if(logger12.info(`\u2705 Removing redundant packages: ${dependenciesToRemove.join(", ")}`),dryRun||packageManager.removeDependencies({skipInstall:!0,packageJson},dependenciesToRemove),logger12.info("\u2705 Installing new dependencies: @storybook/sveltekit"),!dryRun){let versionToInstall=getStorybookVersionSpecifier(packageJson);packageManager.addDependencies({installAsDevDependencies:!0,packageJson},[`@storybook/sveltekit@${versionToInstall}`])}logger12.info("\u2705 Updating framework field in main.js"),main.setFieldValue(["framework"],"@storybook/sveltekit");let currentCore=main.getFieldValue(["core"]);if(currentCore.builder){logger12.info("\u2705 Updating core field in main.js");let{builder,...core}=currentCore;Object.keys(core).length===0?main.removeField(["core"]):main.setFieldValue(["core"],core)}main.getFieldNode(["svelteOptions"])&&(logger12.info("\u2705 Removing svelteOptions field in main.js"),main.removeField(["svelteOptions"])),dryRun||await writeConfig8(main)}};import chalk18 from"chalk";import{dedent as dedent20}from"ts-dedent";var addReact={id:"addReact",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),installedDependencies=new Set(Object.keys({...packageJson.dependencies,...packageJson.devDependencies})),dependents=["@storybook/addon-essentials","@storybook/addon-docs"].filter(pkg2=>installedDependencies.has(pkg2)),additionalDependencies=[];return dependents.length>0&&(installedDependencies.has("react")||additionalDependencies.push("react"),installedDependencies.has("react-dom")||additionalDependencies.push("react-dom")),additionalDependencies.length>0?{dependents,additionalDependencies}:null},prompt({dependents,additionalDependencies}){let dependentsFormatted=dependents.map(pkg2=>chalk18.cyan(pkg2)).join(" & "),additionalDependenciesFormatted=additionalDependencies.map(pkg2=>`- ${chalk18.cyan(pkg2)}`).join(`
|
|
262
|
+
`);return dedent20`
|
|
229
263
|
We've detected that you're using ${dependentsFormatted}.
|
|
230
264
|
|
|
231
265
|
Starting in Storybook 7 we now require the following peer dependencies:
|
|
@@ -234,18 +268,78 @@ Add a project and re-run the installation`)}async function getBaseTsConfigName()
|
|
|
234
268
|
|
|
235
269
|
We can add these for you automatically.
|
|
236
270
|
|
|
237
|
-
More info: ${
|
|
238
|
-
`},async run({packageManager,result:{additionalDependencies},dryRun}){dryRun||packageManager.addDependencies({installAsDevDependencies:!0},additionalDependencies)}};
|
|
239
|
-
|
|
240
|
-
|
|
271
|
+
More info: ${chalk18.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#react-peer-dependencies-required")}
|
|
272
|
+
`},async run({packageManager,result:{additionalDependencies},dryRun}){dryRun||packageManager.addDependencies({installAsDevDependencies:!0},additionalDependencies)}};import chalk19 from"chalk";import dedent21 from"ts-dedent";import semver14 from"semver";import{getStorybookInfo as getStorybookInfo12}from"@storybook/core-common";var nodeJsRequirement={id:"nodejs-requirement",promptOnly:!0,async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),{version:storybookVersion}=getStorybookInfo12(packageJson),storybookCoerced=storybookVersion&&semver14.coerce(storybookVersion)?.version;if(!storybookCoerced)throw new Error(dedent21`
|
|
273
|
+
❌ Unable to determine storybook version.
|
|
274
|
+
🤔 Are you running automigrate from your project directory?
|
|
275
|
+
`);if(!semver14.gte(storybookCoerced,"7.0.0"))return null;let nodeVersion=process.version;return semver14.lt(nodeVersion,"16.0.0")?{nodeVersion}:null},prompt({nodeVersion}){return dedent21`
|
|
276
|
+
${chalk19.bold(chalk19.red("Attention"))}: We could not automatically make this change. You'll need to do it manually.
|
|
277
|
+
|
|
278
|
+
We've detected that you're using Node ${chalk19.bold(nodeVersion)} but Storybook 7 only supports Node ${chalk19.bold("v16.0.0")} and higher. You will either need to upgrade your Node version or keep using an older version of Storybook.
|
|
279
|
+
|
|
280
|
+
Please see the migration guide for more information:
|
|
281
|
+
${chalk19.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-support-for-node-15-and-below")}
|
|
282
|
+
`}};import chalk20 from"chalk";import dedent22 from"ts-dedent";import semver15 from"semver";import{getStorybookInfo as getStorybookInfo13}from"@storybook/core-common";import{loadPartialConfigAsync}from"@babel/core";import{readConfig as readConfig9}from"@storybook/csf-tools";var logger13=console,frameworksThatNeedBabelConfig=["@storybook/react-webpack5","@storybook/vue-webpack5","@storybook/vue3-webpack5","@storybook/html-webpack5"],missingBabelRc={id:"missing-babelrc",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),{mainConfig,version:storybookVersion}=getStorybookInfo13(packageJson),storybookCoerced=storybookVersion&&semver15.coerce(storybookVersion)?.version;if(!storybookCoerced)throw new Error(dedent22`
|
|
283
|
+
❌ Unable to determine storybook version.
|
|
284
|
+
🤔 Are you running automigrate from your project directory?
|
|
285
|
+
`);if(!semver15.gte(storybookCoerced,"7.0.0"))return null;if(!mainConfig)return logger13.warn("Unable to find storybook main.js config, skipping"),null;let main=await readConfig9(mainConfig),frameworkPackage=main.getNameFromPath(["framework"]),addons=main.getNamesFromPath(["addons"]),hasCraPreset=addons&&addons.find(addon=>addon==="@storybook/preset-create-react-app");if(frameworkPackage&&frameworksThatNeedBabelConfig.includes(frameworkPackage)&&!hasCraPreset){let config=await loadPartialConfigAsync({babelrc:!0,filename:"__fake__.js"});if(!config.config&&!config.babelrc&&!packageJson.babel)return{needsBabelRc:!0}}return null},prompt(){return dedent22`
|
|
286
|
+
We detected that your project does not have a babel configuration (.babelrc, babel.config.js, etc.).
|
|
287
|
+
|
|
288
|
+
In version 6.x, Storybook provided its own babel settings out of the box. Now, Storybook re-uses ${chalk20.bold("your project's babel configuration")}, with small, incremental updates from Storybook addons.
|
|
289
|
+
|
|
290
|
+
If your project does not have a babel configuration file, we can generate one that's equivalent to the 6.x defaults for you. Keep in mind that this can affect your project if it uses babel, and you may need to make additional changes based on your projects needs.
|
|
291
|
+
|
|
292
|
+
We can create a ${chalk20.blue(".babelrc.json")} file with some basic configuration and add any necessary package devDependencies.
|
|
293
|
+
|
|
294
|
+
Please see the migration guide for more information:
|
|
295
|
+
${chalk20.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#babel-mode-v7-exclusively")}
|
|
296
|
+
`},async run(){logger13.info(),await generateStorybookBabelConfigInCWD()}};var fixes=[nodeJsRequirement,cra5,webpack5,angular12,vue3,mainjsFramework,eslintPlugin,sveltekitFramework,builderVite,sbBinary,sbScripts,newFrameworks,nextjsFramework,removedGlobalClientAPIs,mdx1to2,autodocsTrue,addReact,missingBabelRc];import{EOL}from"os";var cleanLog=str=>str.replace(/\u001b\[.*?m/g,"").replace(/╮│/g,`\u256E
|
|
297
|
+
\u2502`).replace(/││/g,`\u2502
|
|
298
|
+
\u2502`).replace(/│╰/g,`\u2502
|
|
299
|
+
\u2570`).replace(/⚠️ {2}failed to check/g,`${EOL}\u26A0\uFE0F failed to check`);var logger14=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=fixes.map(f=>chalk21.yellow(f.id)).join(", ");logger14.info(`
|
|
300
|
+
The following migrations are available: ${availableFixes}`)},automigrate=async({fixId:fixId2,dryRun,yes,useNpm,packageManager:pkgMgr,list}={})=>{if(list)return logAvailableMigrations(),null;useNpm&&(useNpmWarning(),pkgMgr="npm");let fixes2=fixId2?fixes.filter(f=>f.id===fixId2):fixes;if(fixId2&&fixes2.length===0)return logger14.info(`\u{1F4ED} No migrations found for ${chalk21.magenta(fixId2)}.`),logAvailableMigrations(),null;augmentLogsToFile();let packageManager=JsPackageManagerFactory.getPackageManager({force:pkgMgr});logger14.info("\u{1F50E} checking possible migrations..");let fixResults={},fixSummary={succeeded:[],failed:{},manual:[],skipped:[]};for(let i=0;i<fixes2.length;i+=1){let f=fixes2[i],result;try{result=await f.check({packageManager})}catch(error){logger14.info(`\u26A0\uFE0F failed to check fix ${chalk21.bold(f.id)}`),logger14.error(`
|
|
301
|
+
${error.stack}`),fixSummary.failed[f.id]=error.message,fixResults[f.id]="check_failed"}if(result){logger14.info(`
|
|
302
|
+
\u{1F50E} found a '${chalk21.cyan(f.id)}' migration:`);let message=f.prompt(result);logger14.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),logger14.info();let{shouldContinue}=await prompts3({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 prompts3({type:"confirm",name:"fix",message:`Do you want to run the '${chalk21.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}),logger14.info(`\u2705 ran ${chalk21.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,logger14.info(`\u274C error when running ${chalk21.cyan(f.id)} migration`),logger14.info(error),logger14.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),logger14.info(),logger14.info(getMigrationSummary(fixResults,fixSummary,LOG_FILE_PATH)),logger14.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?`
|
|
303
|
+
${chalk21.bold("Successful migrations:")}
|
|
304
|
+
|
|
305
|
+
${fixSummary.succeeded.map(m=>chalk21.green(m)).join(", ")}
|
|
306
|
+
`:"",failedFixesMessage=Object.keys(fixSummary.failed).length>0?`
|
|
307
|
+
${chalk21.bold("Failed migrations:")}
|
|
308
|
+
${Object.entries(fixSummary.failed).reduce((acc,[id,error])=>`${acc}
|
|
309
|
+
${chalk21.redBright(id)}:
|
|
310
|
+
${error}
|
|
311
|
+
`,"")}
|
|
312
|
+
|
|
313
|
+
You can find the full logs in ${chalk21.cyan(logFile)}
|
|
314
|
+
`:"",manualFixesMessage=fixSummary.manual.length>0?`
|
|
315
|
+
${chalk21.bold("Manual migrations:")}
|
|
316
|
+
|
|
317
|
+
${fixSummary.manual.map(m=>fixResults[m]==="manual_succeeded"?chalk21.green(m):chalk21.blue(m)).join(", ")}
|
|
318
|
+
`:"",skippedFixesMessage=fixSummary.skipped.length>0?`
|
|
319
|
+
${chalk21.bold("Skipped migrations:")}
|
|
320
|
+
|
|
321
|
+
${fixSummary.skipped.map(m=>chalk21.cyan(m)).join(", ")}
|
|
322
|
+
`:"",summaryMessage=dedent23`
|
|
323
|
+
${successfulFixesMessage}${manualFixesMessage}${failedFixesMessage}${skippedFixesMessage}${hasNoFixes?"":`
|
|
324
|
+
\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
|
|
325
|
+
|
|
326
|
+
`}If you'd like to run the migrations again, you can do so by running '${chalk21.cyan("npx storybook@next automigrate")}'
|
|
327
|
+
|
|
328
|
+
The automigrations try to migrate common patterns in your project, but might not contain everything needed to migrate to the latest version of Storybook.
|
|
329
|
+
|
|
330
|
+
Please check the changelog and migration guide for manual migrations and more information: ${chalk21.yellow("https://storybook.js.org/migration-guides/7.0")}
|
|
331
|
+
And reach out on Discord if you need help: ${chalk21.yellow("https://discord.gg/storybook")}
|
|
332
|
+
`;return boxen(summaryMessage,{borderStyle:"round",padding:1,title,borderColor:hasFailures?"red":"green"})}var logger15=console,installStorybook=(projectType,packageManager,options)=>{let npmOptions={installAsDevDependencies:!0,skipInstall:options.skipInstall},packageJson;try{packageJson=packageManager.readPackageJson()}catch{}let generatorOptions={language:detectLanguage(packageJson),builder:options.builder||detectBuilder(packageManager),linkable:!!options.linkable,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
|
|
333
|
+
`));case"REACT_NATIVE":return(options.yes?Promise.resolve({server:!0}):prompts4([{type:"confirm",name:"server",message:"Do you want to install dependencies necessary to run Storybook server? You can manually do it later by install @storybook/react-native-server",initial:!1}])).then(({server})=>REACT_NATIVE_default(packageManager,npmOptions,server)).then(commandLog(`Adding Storybook support to your "React Native" app
|
|
334
|
+
`));case"QWIK":return QWIK_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Qwik" app
|
|
241
335
|
`));case"WEBPACK_REACT":return WEBPACK_REACT_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Webpack React" app
|
|
242
336
|
`));case"REACT_PROJECT":return REACT_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "React" library
|
|
243
337
|
`));case"NEXTJS":return NEXTJS_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Next" app
|
|
244
338
|
`));case"SFC_VUE":return SFC_VUE_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Single File Components Vue" app
|
|
245
339
|
`));case"VUE":return VUE_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Vue" app
|
|
246
340
|
`));case"VUE3":return VUE3_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Vue 3" app
|
|
247
|
-
`));case"ANGULAR":return
|
|
248
|
-
`));case"EMBER":return EMBER_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Ember" app
|
|
341
|
+
`));case"ANGULAR":return commandLog(`Adding Storybook support to your "Angular" app
|
|
342
|
+
`),ANGULAR_default(packageManager,npmOptions,generatorOptions,options);case"EMBER":return EMBER_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Ember" app
|
|
249
343
|
`));case"MITHRIL":return MITHRIL_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Mithril" app
|
|
250
344
|
`));case"MARIONETTE":return MARIONETTE_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Marionette.js" app
|
|
251
345
|
`));case"MARKO":return MARKO_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Marko" app
|
|
@@ -258,90 +352,69 @@ Add a project and re-run the installation`)}async function getBaseTsConfigName()
|
|
|
258
352
|
`));case"RAX":return RAX_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Rax" app
|
|
259
353
|
`));case"AURELIA":return AURELIA_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Aurelia" app
|
|
260
354
|
`));case"SERVER":return SERVER_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Server" app
|
|
261
|
-
`));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"),
|
|
262
|
-
${
|
|
355
|
+
`));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"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"),logger15.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"),logger15.log(),projectTypeInquirer(options,packageManager)}})().catch(ex=>{logger15.error(`
|
|
356
|
+
${chalk22.red(ex.stack)}`),process.exit(1)})},projectTypeInquirer=async(options,packageManager)=>{let manualAnswer=options.yes?!0:await prompts4([{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 prompts4([{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.";logger15.log(chalk22.inverse(`
|
|
263
357
|
${welcomeMessage}
|
|
264
|
-
`));let{default:updateNotifier}=await import("update-notifier");updateNotifier({pkg:pkg2,updateCheckInterval:1e3*60*60})
|
|
358
|
+
`));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}`),logger15.log(`
|
|
265
359
|
The project types currently supported by Storybook are:
|
|
266
|
-
`),installableProjectTypes.sort().forEach(framework=>paddedLog(`- ${framework}`)),
|
|
360
|
+
`),installableProjectTypes.sort().forEach(framework=>paddedLog(`- ${framework}`)),logger15.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"){logger15.log(),paddedLog("There seems to be a Storybook already available in this project."),paddedLog(`Apply following command to force:
|
|
361
|
+
`),codeLog(["sb init [options] -f"]),logger15.log();return}let installResult=await installStorybook(projectType,packageManager,options).catch(e=>{process.exit()});if(!options.skipInstall&&!storybookInstalled&&packageManager.installDependencies(),options.disableTelemetry||telemetry("init",{projectType}),await automigrate({yes:options.yes||process.env.CI==="true",packageManager:pkgMgr}),logger15.log(`
|
|
267
362
|
To run your Storybook, type:
|
|
268
|
-
`),codeLog([packageManager.getRunStorybookCommand()]),
|
|
269
|
-
For more information visit:`,
|
|
270
|
-
`),codeLog(["export {default} from './storybook';"]),
|
|
363
|
+
`),projectType==="ANGULAR"?codeLog([`ng run ${installResult.projectName}:storybook`]):codeLog([packageManager.getRunStorybookCommand()]),logger15.log(`
|
|
364
|
+
For more information visit:`,chalk22.cyan("https://storybook.js.org")),projectType==="REACT_NATIVE"){let REACT_NATIVE_REPO="https://github.com/storybookjs/react-native";logger15.log(),logger15.log(chalk22.red("NOTE: installation is not 100% automated.")),logger15.log(`To quickly run Storybook, replace contents of your app entry with:
|
|
365
|
+
`),codeLog(["export {default} from './storybook';"]),logger15.log(`
|
|
271
366
|
For more in information, see the github readme:
|
|
272
|
-
`),
|
|
367
|
+
`),logger15.log(chalk22.cyan(REACT_NATIVE_REPO)),logger15.log()}logger15.log()}async function initiate(options,pkg2){await withTelemetry("init",{cliOptions:options},()=>doInitiate(options,pkg2))}import path5 from"path";import fs5 from"fs";import{sync as spawnSync}from"cross-spawn";import{getStorybookInfo as getStorybookInfo14}from"@storybook/core-common";import{readConfig as readConfig10,writeConfig as writeConfig9}from"@storybook/csf-tools";var logger16=console,LEGACY_CONFIGS=["addons","config","presets"],postinstallAddon=async(addonName,isOfficialAddon)=>{let skipMsg=null;isOfficialAddon?fs5.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=path5.join(".storybook",`${config}.ts`);fs5.existsSync(configFile)||(configFile=path5.join(".storybook",`${config}.js`),fs5.existsSync(configFile)||fs5.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}=getStorybookInfo14(packageJson);if(!mainConfig){logger16.error("Unable to find storybook main.js config");return}let main=await readConfig10(mainConfig),addons=main.getFieldValue(["addons"]);addons&&!Array.isArray(addons)&&logger16.error("Expected addons array in main.js config"),logger16.log(`Verifying ${addonName}`);let latestVersion=packageManager.latestVersion(addonName);latestVersion||logger16.error(`Unknown addon ${addonName}`);let isStorybookAddon=addonName.startsWith("@storybook/"),addonWithVersion=`${addonName}@${versionSpecifier||(isStorybookAddon?storybookVersion:latestVersion)}`;logger16.log(`Installing ${addonWithVersion}`),packageManager.addDependencies({installAsDevDependencies:!0},[addonWithVersion]),logger16.log(`Adding '${addon}' to main.js addons field.`);let updatedAddons=[...addons||[],addonName];main.setFieldValue(["addons"],updatedAddons),await writeConfig9(main),options.skipPostinstall||await postinstallAddon(addon,isStorybookAddon)}import{listCodemods,runCodemod}from"@storybook/codemod";async function migrate(migration,{glob,dryRun,list,rename,logger:logger24,parser}){if(list)listCodemods().forEach(key=>logger24.log(key));else if(migration)await runCodemod(migration,{glob,dryRun,logger:logger24,rename,parser});else throw new Error("Migrate: please specify a migration name or --list")}import path6 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 logger17}from"@storybook/node-logger";var read=async url=>{let browser=await usePuppeteerBrowser(),page=await browser.newPage();await page.goto(url),await page.waitForFunction(`
|
|
273
368
|
(window.__STORYBOOK_PREVIEW__ && window.__STORYBOOK_PREVIEW__.extract && window.__STORYBOOK_PREVIEW__.extract()) ||
|
|
274
369
|
(window.__STORYBOOK_STORY_STORE__ && window.__STORYBOOK_STORY_STORE__.extract && window.__STORYBOOK_STORY_STORE__.extract())
|
|
275
|
-
`);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(
|
|
276
|
-
`).map(getStorybookVersion).filter(Boolean).filter(pkg2=>isCorePackage(pkg2.package));if(!storybookPackages.length){
|
|
277
|
-
> ${command2}
|
|
278
|
-
`);return}return logger18.debug(command2),new Promise((resolve2,reject)=>{let defaultOptions2={silent:!1},child=shell2.exec(command2,{...defaultOptions2,...options,async:!0,silent:!1});child.stderr.pipe(process.stderr),child.on("exit",code=>{code===0?resolve2(void 0):(logger18.error(chalk20.red(`An error occurred while executing: \`${command2}\``)),logger18.log(errorMessage),reject(new Error(`command exited with code: ${code}: `)))})})},addPackageResolutions=async({cwd})=>{logger18.info("\u{1F522} Adding package resolutions:");let packageJsonPath=path11.join(cwd,"package.json"),packageJson=await readJSON(packageJsonPath);packageJson.resolutions=versions_default,await writeJSON(packageJsonPath,packageJson,{spaces:2})},addLocalPackageResolutions=async({cwd})=>{logger18.info("\u{1F522} Adding package resolutions:");let packageJsonPath=path11.join(cwd,"package.json"),packageJson=await readJSON(packageJsonPath),workspaceDir=path11.join(__dirname,"..","..","..","..",".."),{stdout}=await command("yarn workspaces list --json",{cwd:workspaceDir});console.log({stdout,workspaceDir});let workspaces=JSON.parse(`[${stdout.split(`
|
|
279
|
-
`).join(",")}]`);console.log({workspaces}),packageJson.resolutions=Object.keys(versions_default).reduce((acc,key)=>({...acc,[key]:path11.join(workspaceDir,workspaces.find(item=>item.name===key).location)}),{}),await writeJSON(packageJsonPath,packageJson,{spaces:2})},installYarn2=async({cwd,pnp,name})=>{let command2=["yarn set version berry","yarn config set enableGlobalCache true",`yarn config set nodeLinker ${pnp?"pnp":"node-modules"}`];[cra.name,cra_typescript.name].includes(name)&&command2.push(`yarn config set packageExtensions --json '{ "babel-preset-react-app@10.0.x": { "dependencies": { "@babel/plugin-proposal-private-property-in-object": "^7.16.0" } } }'`),await exec(command2.join(" && "),{cwd},{startMessage:"\u{1F9F6} Installing Yarn 2",errorMessage:"\u{1F6A8} Installing Yarn 2 failed"})},configureYarn2ForE2E=async({cwd})=>{let command2=[`yarn config set npmScopes --json '{ "storybook": { "npmRegistryServer": "http://localhost:6001/" } }'`,`yarn config set unsafeHttpWhitelist --json '["localhost"]'`,"yarn config set pnpFallbackMode none","yarn config set enableImmutableInstalls false",`yarn config set logFilters --json '[ { "code": "YN0013", "level": "discard" } ]'`].join(" && ");await exec(command2,{cwd},{startMessage:"\u{1F39B} Configuring Yarn 2",errorMessage:"\u{1F6A8} Configuring Yarn 2 failed"})},generate=async({cwd,name,appName,version,generator:generator23})=>{let command2=generator23.replace(/{{appName}}/g,appName).replace(/{{version}}/g,version);await exec(command2,{cwd},{startMessage:`\u{1F3D7} Bootstrapping ${name} project (this might take a few minutes)`,errorMessage:`\u{1F6A8} Bootstrapping ${name} failed`})},addAdditionalFiles=async({additionalFiles,cwd})=>{logger18.info("\u2935\uFE0F Adding required files"),await Promise.all(additionalFiles.map(async file=>{await outputFile(path11.resolve(cwd,file.path),file.contents,{encoding:"UTF-8"})}))},initStorybook=async({cwd,autoDetect=!0,name,e2e,pnp})=>{let flags=["--yes"];autoDetect||flags.push(`--type ${name}`),e2e&&flags.push("--linkable"),pnp&&flags.push("--use-pnp");let command2=`${`node ${__filename}`} init ${flags.join(" ")}`;await exec(command2,{cwd},{startMessage:"\u{1F3A8} Initializing Storybook with @storybook/cli",errorMessage:"\u{1F6A8} Storybook initialization failed"})},addRequiredDeps=async({cwd,additionalDeps})=>{shell2.rm("-f",path11.join(cwd,"package-lock.json"),path11.join(cwd,"yarn.lock"));let command2=additionalDeps&&additionalDeps.length>0?`yarn add -D ${additionalDeps.join(" ")}`:"yarn install";await exec(command2,{cwd},{startMessage:"\u{1F30D} Adding needed deps & installing all deps",errorMessage:"\u{1F6A8} Dependencies installation failed"})},addTypescript=async({cwd})=>{logger18.info("\u{1F46E} Adding typescript and tsconfig.json");try{await exec("yarn add -D typescript@latest",{cwd});let tsConfig={compilerOptions:{baseUrl:".",esModuleInterop:!0,jsx:"preserve",skipLibCheck:!0,strict:!0},include:["src/*"]},tsConfigJsonPath=path11.resolve(cwd,"tsconfig.json");await writeJSON(tsConfigJsonPath,tsConfig,{encoding:"utf8",spaces:2})}catch(e){throw logger18.error("\u{1F6A8} Creating tsconfig.json failed"),e}},doTask=async(task,options,condition=!0)=>{condition&&(await task(options),logger18.log())},registryUrlNPM=url=>exec(`npm ${["config","set","registry",url].join(" ")}`,{cwd:path11.join(process.cwd(),"..")}),registryUrlYarn=url=>exec(`yarn ${["config","set","npmRegistryServer",url].join(" ")}`,{cwd:path11.join(__dirname,"..")}),createAndInit=async(cwd,{name,version,...rest},{e2e,pnp,local,registry})=>{let options={name,version,appName:path11.basename(cwd),creationPath:path11.join(cwd,".."),cwd,e2e,pnp,...rest};logger18.log(),logger18.info(`\u{1F3C3} Starting for ${name} ${version}`),logger18.log(),await doTask(generate,{...options,cwd:options.creationPath}),await doTask(addAdditionalFiles,{...options,cwd},!!options.additionalFiles),e2e&&await doTask(addPackageResolutions,options),local&&await doTask(addLocalPackageResolutions,options),await doTask(installYarn2,options),e2e&&await doTask(configureYarn2ForE2E,options,e2e),await doTask(addTypescript,options,!!options.typescript),await doTask(addRequiredDeps,options),registry&&(await registryUrlNPM(registry),await registryUrlYarn(registry)),await doTask(initStorybook,options)};var logger19=console,TEMPLATES=configs_exports,CURATED_TEMPLATES=Object.fromEntries(Object.entries(configs_exports).filter(entry=>entry[0]!=="react_in_yarn_workspace")),RENDERERS=Object.values(CURATED_TEMPLATES).reduce((acc,cur)=>(acc[cur.renderer]=[...acc[cur.renderer]||[],cur],acc),{}),repro=async({outputDirectory,list,template,renderer,generator:generator23,e2e,local,registry,pnp})=>{if(logger19.info(boxen2(dedent17`
|
|
280
|
-
🤗 Welcome to ${chalk21.yellow("sb repro")}! 🤗
|
|
370
|
+
`);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(path6.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`;logger17.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 logger17.info("installing puppeteer..."),new Promise((resolve,reject)=>{__require("child_process").exec(`node ${__require.resolve(path6.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 semver16 from"semver";import{logger as logger18}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||!semver16.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=>logger18.warn(`- ${formatPackage(pkg2)}`)),checkVersionConsistency=()=>{let storybookPackages=spawnSync2("npm",["ls"],{stdio:"pipe",shell:!0}).output.toString().split(`
|
|
371
|
+
`).map(getStorybookVersion).filter(Boolean).filter(pkg2=>isCorePackage(pkg2.package));if(!storybookPackages.length){logger18.warn("No storybook core packages found."),logger18.warn("'npm ls | grep storybook' can show if multiple versions are installed.");return}storybookPackages.sort((a,b)=>semver16.rcompare(a.version,b.version));let latestVersion=storybookPackages[0].version,outdated=storybookPackages.filter(pkg2=>pkg2.version!==latestVersion);outdated.length>0&&(logger18.warn(`Found ${outdated.length} outdated packages (relative to '${formatPackage(storybookPackages[0])}')`),logger18.warn("Please make sure your packages are updated to ensure a consistent experience."),warnPackages(outdated)),deprecatedPackages.forEach(({minVersion,url,deprecations})=>{if(semver16.gte(latestVersion,minVersion)){let deprecated=storybookPackages.filter(pkg2=>deprecations.includes(pkg2.package));deprecated.length>0&&(logger18.warn(`Found ${deprecated.length} deprecated packages since ${minVersion}`),logger18.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&&semver16.satisfies(semver16.coerce(pkgVersion),specifier)?[...acc,...extra]:acc},[...flags]),doUpgrade=async({tag,prerelease,skipCheck,useNpm,packageManager:pkgMgr,dryRun,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();logger18.info(check);let checkSb=spawnSync2("npx",["npm-check-updates@latest","sb",...flags],{stdio:"pipe",shell:!0}).output.toString();logger18.info(checkSb),dryRun||(commandLog("Installing upgrades"),packageManager.installDependencies());let automigrationResults;if(skipCheck||(checkVersionConsistency(),automigrationResults=await automigrate({dryRun,yes,packageManager:pkgMgr})),!options.disableTelemetry){let afterVersion=await getStorybookCoreVersion();telemetry2("upgrade",{prerelease,tag,automigrationResults,beforeVersion,afterVersion})}};async function upgrade(options){await withTelemetry2("upgrade",{cliOptions:options},()=>doUpgrade(options))}import prompts5 from"prompts";import path7 from"path";import chalk23 from"chalk";import boxen2 from"boxen";import{dedent as dedent24}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 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 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"}},"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';
|
|
281
372
|
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
After the reproduction is ready, we'll guide you through the next steps.
|
|
288
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),list){logger19.info("\u{1F308} Available templates"),Object.entries(RENDERERS).forEach(([r,templates])=>{logger19.info(r),templates.forEach(t=>logger19.info(`- ${t.name}`)),r==="other"&&logger19.info("- blank")});return}let selectedTemplate=template,selectedRenderer=renderer;if(!selectedTemplate&&!generator23){if(!selectedRenderer){let{renderer:rendererOpt}=await prompts4({type:"select",message:"\u{1F308} Select the repro renderer",name:"renderer",choices:Object.keys(RENDERERS).map(f=>({title:f,value:f}))});selectedRenderer=rendererOpt}if(!selectedRenderer)throw new Error("\u{1F6A8} Repro: please select a renderer!");selectedTemplate=(await prompts4({type:"select",message:"\u{1F4DD} Select the repro base template",name:"template",choices:RENDERERS[selectedRenderer].map(f=>({title:f.name,value:f.name}))})).template}let selectedConfig=generator23?{name:"custom",version:"custom",generator:generator23}:TEMPLATES[selectedTemplate];if(!selectedConfig)throw new Error("\u{1F6A8} Repro: please specify a valid template type");let selectedDirectory=outputDirectory;if(!selectedDirectory){let{directory}=await prompts4({type:"text",message:"Enter the output directory",name:"directory",initial:selectedConfig.name,validate:directoryName=>fs7.existsSync(directoryName)?`${directoryName} already exists. Please choose another name.`:!0});selectedDirectory=directory}try{let cwd=path12.isAbsolute(selectedDirectory)?selectedDirectory:path12.join(process.cwd(),selectedDirectory);logger19.info(`\u{1F3C3} Running ${selectedTemplate} into ${cwd}`),await createAndInit(cwd,selectedConfig,{registry,e2e:!!e2e,pnp:!!pnp,local:!!local}),e2e||await initGitRepo(cwd),logger19.info(boxen2(dedent17`
|
|
289
|
-
🎉 Your Storybook reproduction project is ready to use! 🎉
|
|
373
|
+
export default {
|
|
374
|
+
plugins: [vue2()]
|
|
375
|
+
};" > 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"},inDevelopment:!0},"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"},inDevelopment:!0},"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",inDevelopment:!0,skipTasks:["e2e-tests"],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)",inDevelopment:!0,isInternal:!0,modifications:{mainConfig:{features:{storyStoreV7:!1}}}},"internal/ssv6-webpack":{...baseTemplates["react-webpack/18-ts"],name:"StoryStore v6 (react-webpack/18-ts)",inDevelopment:!0,isInternal:!0,modifications:{mainConfig:{features:{storyStoreV7:!1}}}}},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","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"];var logger19=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&&(logger19.info(boxen2(dedent24`
|
|
376
|
+
🔎 You filtered out all templates. 🔍
|
|
290
377
|
|
|
291
|
-
|
|
292
|
-
${chalk21.yellow("yarn storybook")}
|
|
378
|
+
After filtering all the templates with "${chalk23.yellow(filterValue)}", we found no results. Please try again with a different filter.
|
|
293
379
|
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
380
|
+
Available templates:
|
|
381
|
+
${keys.map(key=>chalk23.blue`- ${key}`).join(`
|
|
382
|
+
`)}
|
|
383
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),process.exit(1)),choices.length===1?[selectedTemplate]=choices:(logger19.info(boxen2(dedent24`
|
|
384
|
+
🤗 Welcome to ${chalk23.yellow("sb sandbox")}! 🤗
|
|
299
385
|
|
|
300
|
-
|
|
301
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}))}catch(error){throw logger19.error("\u{1F6A8} Failed to create repro"),error}},initGitRepo=async cwd=>{await exec("git init",{cwd}),await exec('echo "node_modules" >> .gitignore',{cwd}),await exec("git add --all",{cwd}),await exec('git commit -am "added storybook"',{cwd}),await exec("git tag repro-base",{cwd})};import prompts5 from"prompts";import path13 from"path";import chalk22 from"chalk";import boxen3 from"boxen";import{dedent as dedent18}from"ts-dedent";import{downloadTemplate}from"giget";import{existsSync as existsSync2}from"fs-extra";var allTemplates={"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 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 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"}},"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';
|
|
386
|
+
Create a ${chalk23.green("new project")} to minimally reproduce Storybook issues.
|
|
302
387
|
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
};" > 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"},inDevelopment:!0},"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"},inDevelopment:!0},"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"}},"angular-cli/13-ts":{name:"Angular CLI (Version 13)",script:"npx -p @angular/cli@13 ng new angular-v13 --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":{inDevelopment:!0,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":{inDevelopment:!0,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"}}},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","angular-cli/13-ts","preact-webpack5/default-ts","html-webpack/default"],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/default-js","preact-webpack5/default-js"];var logger20=console,toChoices=c=>({title:allTemplates[c].name,value:c}),reproNext=async({output:outputDirectory,filterValue,branch,init})=>{let keys=Object.keys(allTemplates),choices=keys.reduce((acc,group)=>{let current=allTemplates[group],filterRegex=new RegExp(filterValue,"i");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},[]);choices.length===0&&(logger20.info(boxen3(dedent18`
|
|
306
|
-
🔎 You filtered out all templates. 🔍
|
|
307
|
-
|
|
308
|
-
After filtering all the templates with "${chalk22.yellow(filterValue)}", we found no results. Please try again with a different filter.
|
|
388
|
+
1. select an environment that most closely matches your project setup.
|
|
389
|
+
2. select a location for the reproduction, outside of your project.
|
|
309
390
|
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
`)}
|
|
313
|
-
|
|
314
|
-
🤗 Welcome to ${chalk22.yellow("sb repro NEXT")}! 🤗
|
|
315
|
-
|
|
316
|
-
Create a ${chalk22.green("new project")} to minimally reproduce Storybook issues.
|
|
317
|
-
|
|
318
|
-
1. select an environment that most closely matches your project setup.
|
|
319
|
-
2. select a location for the reproduction, outside of your project.
|
|
320
|
-
|
|
321
|
-
After the reproduction is ready, we'll guide you through the next steps.
|
|
322
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),selectedTemplate=await promptSelectedTemplate(choices)),!!!(selectedTemplate??null)){logger20.error("Somehow we got no templates. Please rerun this command!");return}let selectedConfig=allTemplates[selectedTemplate];if(!selectedConfig)throw new Error("\u{1F6A8} Repro: please specify a valid template type");let selectedDirectory=outputDirectory,outputDirectoryName=outputDirectory||selectedTemplate;if(selectedDirectory&&existsSync2(`${selectedDirectory}`)&&logger20.info(`\u26A0\uFE0F ${selectedDirectory} already exists! Overwriting...`),!selectedDirectory){let{directory}=await prompts5({type:"text",message:"Enter the output directory",name:"directory",initial:outputDirectoryName,validate:async directoryName=>existsSync2(directoryName)?`${directoryName} already exists. Please choose another name.`:!0});selectedDirectory=directory}try{let templateDestination=path13.isAbsolute(selectedDirectory)?selectedDirectory:path13.join(process.cwd(),selectedDirectory);logger20.info(`\u{1F3C3} Adding ${selectedConfig.name} into ${templateDestination}`),logger20.log("\u{1F4E6} Downloading repro template...");try{await downloadTemplate(`github:storybookjs/repro-templates-temp/${selectedTemplate}/${init?"after-storybook":"before-storybook"}#${branch}`,{force:!0,dir:templateDestination})}catch(err){throw logger20.error(`\u{1F6A8} Failed to download repro template: ${err.message}`),err}let initMessage=init?chalk22.yellow(`yarn install
|
|
323
|
-
yarn storybook`):`Recreate your setup, then ${chalk22.yellow("run npx storybook init")}`;logger20.info(boxen3(dedent18`
|
|
391
|
+
After the reproduction is ready, we'll guide you through the next steps.
|
|
392
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),selectedTemplate=await promptSelectedTemplate(choices)),!!!(selectedTemplate??null)){logger19.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}`)&&logger19.info(`\u26A0\uFE0F ${selectedDirectory} already exists! Overwriting...`),!selectedDirectory){let{directory}=await prompts5({type:"text",message:"Enter the output directory",name:"directory",initial:outputDirectoryName,validate:async directoryName=>existsSync(directoryName)?`${directoryName} already exists. Please choose another name.`:!0},{onCancel:()=>{logger19.log("Command cancelled by the user. Exiting..."),process.exit(1)}});selectedDirectory=directory}try{let templateDestination=path7.isAbsolute(selectedDirectory)?selectedDirectory:path7.join(process.cwd(),selectedDirectory);logger19.info(`\u{1F3C3} Adding ${selectedConfig.name} into ${templateDestination}`),logger19.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(dedent24`Template downloaded from ${chalk23.blue(gitPath)} is empty.
|
|
393
|
+
Are you use it exists? Or did you want to set ${chalk23.yellow(selectedTemplate)} to inDevelopment first?`)}catch(err){throw logger19.error(`\u{1F6A8} Failed to download sandbox template: ${err.message}`),err}let initMessage=init?chalk23.yellow(`yarn install
|
|
394
|
+
yarn storybook`):`Recreate your setup, then ${chalk23.yellow("run npx storybook init")}`;logger19.info(boxen2(dedent24`
|
|
324
395
|
🎉 Your Storybook reproduction project is ready to use! 🎉
|
|
325
396
|
|
|
326
|
-
${
|
|
397
|
+
${chalk23.yellow(`cd ${selectedDirectory}`)}
|
|
327
398
|
${initMessage}
|
|
328
399
|
|
|
329
400
|
Once you've recreated the problem you're experiencing, please:
|
|
330
|
-
|
|
331
|
-
1. Document any additional steps in ${
|
|
401
|
+
|
|
402
|
+
1. Document any additional steps in ${chalk23.cyan("README.md")}
|
|
332
403
|
2. Publish the repository to github
|
|
333
404
|
3. Link to the repro repository in your issue
|
|
334
405
|
|
|
335
406
|
Having a clean repro helps us solve your issue faster! 🙏
|
|
336
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}))}catch(error){throw
|
|
407
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}))}catch(error){throw logger19.error("\u{1F6A8} Failed to create sandbox"),error}};async function promptSelectedTemplate(choices){let{template}=await prompts5({type:"select",message:"\u{1F308} Select the template",name:"template",choices:choices.map(toChoices)},{onCancel:()=>{logger19.log("Command cancelled by the user. Exiting..."),process.exit(1)}});return template||null}import fse5 from"fs-extra";import path8 from"path";import{sync as spawnSync3}from"cross-spawn";import{logger as logger20}from"@storybook/node-logger";import shell2 from"shelljs";import chalk24 from"chalk";var exec=async(command2,options={},{startMessage,errorMessage,dryRun}={})=>{if(startMessage&&logger20.info(startMessage),dryRun){logger20.info(`
|
|
408
|
+
> ${command2}
|
|
409
|
+
`);return}return logger20.info(command2),new Promise((resolve,reject)=>{let defaultOptions2={silent:!1},child=shell2.exec(command2,{...defaultOptions2,...options,async:!0,silent:!1});child.stderr.pipe(process.stderr),child.on("exit",code=>{code===0?resolve(void 0):(logger20.error(chalk24.red(`An error occurred while executing: \`${command2}\``)),logger20.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=path8.basename(target);if(!local){let reprosDir=path8.join(storybookDir,"../storybook-repros");logger20.info(`Ensuring directory ${reprosDir}`),await fse5.ensureDir(reprosDir),logger20.info(`Cloning ${target}`),await exec(`git clone ${target}`,{cwd:reprosDir}),reproName=path8.basename(target,path8.extname(target)),reproDir=path8.join(reprosDir,reproName)}let reproPackageJson=await fse5.readJSON(path8.join(reproDir,"package.json")),version=spawnSync3("yarn",["--version"],{cwd:reproDir,stdio:"pipe",shell:!0}).stdout.toString();if(!/^[23]\./.test(version)){logger20.warn(`\u{1F6A8} Expected yarn 2 or 3 in ${reproDir}!`),logger20.warn(""),logger20.warn("Please set it up with `yarn set version berry`,"),logger20.warn(`then link '${reproDir}' with the '--local' flag.`);return}logger20.info(`Linking ${reproDir}`),await exec(`yarn link --all ${storybookDir}`,{cwd:reproDir}),logger20.info(`Installing ${reproName}`),await exec("yarn install",{cwd:reproDir}),reproPackageJson.devDependencies?.vite||(logger20.info("Magic stuff related to @storybook/preset-create-react-app, we need to fix peerDependencies"),await exec("yarn add -D webpack-hot-middleware",{cwd:reproDir})),await exec("yarn add @types/node@16",{cwd:reproDir}),start&&(logger20.info(`Running ${reproName} storybook`),await exec("yarn run storybook",{cwd:reproDir}))};import{dedent as dedent25}from"ts-dedent";import{sync as readUpSync}from"read-pkg-up";import{logger as logger21,instance as npmLog}from"@storybook/node-logger";import{buildDevStandalone,withTelemetry as withTelemetry3}from"@storybook/core-server";import{cache}from"@storybook/core-common";var dev=async cliOptions=>{process.env.NODE_ENV=process.env.NODE_ENV||"development";try{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},()=>buildDevStandalone(options))}catch(error){npmLog.heading="",error instanceof Error?error.error?logger21.error(error.error):error.stats&&error.stats.compilation.errors?error.stats.compilation.errors.forEach(e=>logger21.plain(e)):logger21.error(error):error.compilation?.errors&&error.compilation.errors.forEach(e=>logger21.plain(e)),logger21.line(),logger21.warn(error.close?dedent25`
|
|
337
410
|
FATAL broken build!, will close the process,
|
|
338
411
|
Fix the error below and restart storybook.
|
|
339
|
-
`:
|
|
412
|
+
`:dedent25`
|
|
340
413
|
Broken build, fix the error above.
|
|
341
414
|
You may need to refresh the browser.
|
|
342
|
-
`),
|
|
343
|
-
Environment Info:`)),envinfo.run({System:["OS","CPU"],Binaries:["Node","Yarn","npm"],Browsers:["Chrome","Edge","Firefox","Safari"],npmPackages:"@storybook/*",npmGlobalPackages:"@storybook/*"}).then(consoleLogger.log)});
|
|
344
|
-
`)),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})});
|
|
415
|
+
`),logger21.line(),process.exit(1)}};import{sync as readUpSync2}from"read-pkg-up";import{logger as logger22}from"@storybook/node-logger";import{buildStaticStandalone,withTelemetry as withTelemetry4}from"@storybook/core-server";import{cache as cache2}from"@storybook/core-common";var build=async cliOptions=>{try{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))}catch(err){logger22.error(err),process.exit(1)}};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(err=>{logger23.error(err),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").action(options=>upgrade(options));command("info").description("Prints debugging information about the local environment").action(()=>{consoleLogger.log(chalk25.bold(`
|
|
416
|
+
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=>{logger23.error(err),process.exit(1)})});command("extract [location] [output]").description("extract stories.json from a built version").action((location="storybook-static",output=path9.join(location,"stories.json"))=>extract(location,output).catch(e=>{logger23.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=>{logger23.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=>{logger23.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").action(async(fixId2,options)=>{await automigrate({fixId:fixId2,...options}).catch(e=>{logger23.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(options=>{logger23.setLevel(program.loglevel),consoleLogger.log(chalk25.bold(`${pkg.name} v${pkg.version}`)+chalk25.reset(`
|
|
417
|
+
`)),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",logger23.setLevel(program.loglevel),consoleLogger.log(chalk25.bold(`${pkg.name} v${pkg.version}
|
|
345
418
|
`)),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.
|
|
346
419
|
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(`
|
|
347
420
|
Did you mean ${suggestion}?`),process.exit(1)});program.usage("<command> [options]").version(pkg.version).parse(process.argv);
|