@storybook/cli 7.0.0-beta.9 → 7.0.0-rc.1
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/.eslintrc.js +1 -0
- package/bin/index.js +6 -1
- package/dist/chunk-QSZMPUNV.mjs +16 -0
- package/dist/generate.d.ts +1 -0
- package/dist/generate.js +297 -274
- package/dist/generate.mjs +287 -279
- package/dist/index.d.ts +134 -0
- package/dist/index.js +10 -0
- package/dist/index.mjs +1 -0
- package/package.json +33 -17
- 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/templates/react-native/template-csf/storybook/addons.js +0 -3
- package/templates/react-native/template-csf/storybook/index.js +0 -29
- package/templates/react-native/template-csf/storybook/rn-addons.js +0 -2
- package/templates/react-native/template-csf/storybook/stories/Button/Button.stories.js +0 -20
- package/templates/react-native/template-csf/storybook/stories/Button/index.js +0 -17
- package/templates/react-native/template-csf/storybook/stories/CenterView/index.js +0 -16
- package/templates/react-native/template-csf/storybook/stories/CenterView/style.js +0 -8
- package/templates/react-native/template-csf/storybook/stories/Welcome/Welcome.stories.js +0 -6
- package/templates/react-native/template-csf/storybook/stories/Welcome/index.js +0 -57
- package/templates/react-native/template-csf/storybook/stories/index.js +0 -2
- package/templates/server/template-csf/.storybook/preview.js +0 -5
package/dist/generate.mjs
CHANGED
|
@@ -1,47 +1,42 @@
|
|
|
1
|
-
var __defProp=Object.defineProperty;var __require=(x=>typeof require<"u"?require:typeof Proxy<"u"?new Proxy(x,{get:(a,b)=>(typeof require<"u"?require:a)[b]}):x)(function(x){if(typeof require<"u")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})};import program from"commander";import path15 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 logger27}from"@storybook/node-logger";import chalk21 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.9","@storybook/addon-actions":"7.0.0-beta.9","@storybook/addon-backgrounds":"7.0.0-beta.9","@storybook/addon-controls":"7.0.0-beta.9","@storybook/addon-docs":"7.0.0-beta.9","@storybook/addon-essentials":"7.0.0-beta.9","@storybook/addon-highlight":"7.0.0-beta.9","@storybook/addon-interactions":"7.0.0-beta.9","@storybook/addon-jest":"7.0.0-beta.9","@storybook/addon-links":"7.0.0-beta.9","@storybook/addon-measure":"7.0.0-beta.9","@storybook/addon-outline":"7.0.0-beta.9","@storybook/addon-storyshots":"7.0.0-beta.9","@storybook/addon-storyshots-puppeteer":"7.0.0-beta.9","@storybook/addon-storysource":"7.0.0-beta.9","@storybook/addon-toolbars":"7.0.0-beta.9","@storybook/addon-viewport":"7.0.0-beta.9","@storybook/addons":"7.0.0-beta.9","@storybook/angular":"7.0.0-beta.9","@storybook/manager-api":"7.0.0-beta.9","@storybook/blocks":"7.0.0-beta.9","@storybook/builder-manager":"7.0.0-beta.9","@storybook/builder-vite":"7.0.0-beta.9","@storybook/builder-webpack5":"7.0.0-beta.9","@storybook/channel-postmessage":"7.0.0-beta.9","@storybook/channel-websocket":"7.0.0-beta.9","@storybook/channels":"7.0.0-beta.9","@storybook/cli":"7.0.0-beta.9","@storybook/client-api":"7.0.0-beta.9","@storybook/client-logger":"7.0.0-beta.9","@storybook/codemod":"7.0.0-beta.9","@storybook/components":"7.0.0-beta.9","@storybook/core-client":"7.0.0-beta.9","@storybook/core-common":"7.0.0-beta.9","@storybook/core-events":"7.0.0-beta.9","@storybook/core-server":"7.0.0-beta.9","@storybook/core-webpack":"7.0.0-beta.9","@storybook/csf-tools":"7.0.0-beta.9","@storybook/docs-tools":"7.0.0-beta.9","@storybook/ember":"7.0.0-beta.9","@storybook/html":"7.0.0-beta.9","@storybook/html-webpack5":"7.0.0-beta.9","@storybook/html-vite":"7.0.0-beta.9","@storybook/instrumenter":"7.0.0-beta.9","@storybook/nextjs":"7.0.0-beta.9","@storybook/node-logger":"7.0.0-beta.9","@storybook/postinstall":"7.0.0-beta.9","@storybook/preact":"7.0.0-beta.9","@storybook/preact-webpack5":"7.0.0-beta.9","@storybook/preset-html-webpack":"7.0.0-beta.9","@storybook/preset-preact-webpack":"7.0.0-beta.9","@storybook/preset-react-webpack":"7.0.0-beta.9","@storybook/preset-server-webpack":"7.0.0-beta.9","@storybook/preset-svelte-webpack":"7.0.0-beta.9","@storybook/preset-vue-webpack":"7.0.0-beta.9","@storybook/preset-vue3-webpack":"7.0.0-beta.9","@storybook/preset-web-components-webpack":"7.0.0-beta.9","@storybook/preview":"7.0.0-beta.9","@storybook/preview-api":"7.0.0-beta.9","@storybook/preview-web":"7.0.0-beta.9","@storybook/react":"7.0.0-beta.9","@storybook/react-vite":"7.0.0-beta.9","@storybook/react-webpack5":"7.0.0-beta.9","@storybook/router":"7.0.0-beta.9","@storybook/server":"7.0.0-beta.9","@storybook/server-webpack5":"7.0.0-beta.9","@storybook/source-loader":"7.0.0-beta.9","@storybook/store":"7.0.0-beta.9","@storybook/svelte":"7.0.0-beta.9","@storybook/sveltekit":"7.0.0-beta.9","@storybook/svelte-vite":"7.0.0-beta.9","@storybook/svelte-webpack5":"7.0.0-beta.9","@storybook/telemetry":"7.0.0-beta.9","@storybook/theming":"7.0.0-beta.9","@storybook/manager":"7.0.0-beta.9","@storybook/vue":"7.0.0-beta.9","@storybook/vue-vite":"7.0.0-beta.9","@storybook/vue-webpack5":"7.0.0-beta.9","@storybook/vue3":"7.0.0-beta.9","@storybook/vue3-vite":"7.0.0-beta.9","@storybook/vue3-webpack5":"7.0.0-beta.9","@storybook/web-components":"7.0.0-beta.9","@storybook/web-components-webpack5":"7.0.0-beta.9","@storybook/web-components-vite":"7.0.0-beta.9",sb:"7.0.0-beta.9",storybook:"7.0.0-beta.9"};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(
|
|
6
|
-
`)
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
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`
|
|
22
|
-
${prefix}
|
|
23
|
-
export const parameters = {
|
|
24
|
-
actions: { argTypesRegex: "^on[A-Z].*" },
|
|
25
|
-
controls: {
|
|
26
|
-
matchers: {
|
|
27
|
-
color: /(background|color)$/i,
|
|
28
|
-
date: /Date$/,
|
|
1
|
+
import{JsPackageManagerFactory,SUPPORTED_RENDERERS,__require,codeLog,commandLog,copyTemplate,copyTemplateFiles,externalFrameworks,getBabelDependencies,getBowerJson,getCliDir,getPackageDetails,getStorybookVersionSpecifier,installableProjectTypes,isNxProject,paddedLog,readFileAsJson,supportedTemplates,unsupportedTemplate,useNpmWarning,versions_default,writeFileAsJson}from"./chunk-QSZMPUNV.mjs";import program from"commander";import path8 from"path";import chalk26 from"chalk";import envinfo from"envinfo";import leven from"leven";import{sync as readUpSync3}from"read-pkg-up";import{logger as logger26}from"@storybook/node-logger";import chalk23 from"chalk";import prompts6 from"prompts";import{telemetry}from"@storybook/telemetry";import{withTelemetry}from"@storybook/core-server";import fs from"fs";import findUp from"find-up";import semver from"semver";import{logger}from"@storybook/node-logger";import{pathExistsSync}from"fs-extra";import{join}from"path";var detectWebpack=packageManager=>{try{let out="";if(packageManager.type==="npm")try{out=packageManager.executeCommand("npm",["ls","webpack"])}catch{out=packageManager.executeCommand("npm",["why","webpack"])}else out=packageManager.executeCommand("yarn",["why","webpack"]);if(out.includes("webpack@4")||out.includes("webpack@npm:4"))return 4;if(out.includes("webpack@5")||out.includes("webpack@npm:5"))return 5}catch{}return!1};var viteConfigFiles=["vite.config.ts","vite.config.js","vite.config.mjs"],hasDependency=(packageJson,name,matcher)=>{let version=packageJson.dependencies?.[name]||packageJson.devDependencies?.[name];return version&&typeof matcher=="function"?matcher(version):!!version},hasPeerDependency=(packageJson,name,matcher)=>{let version=packageJson.peerDependencies?.[name];return version&&typeof matcher=="function"?matcher(version):!!version},getFrameworkPreset=(packageJson,framework)=>{let matcher={dependencies:[!1],peerDependencies:[!1],files:[!1]},{preset,files,dependencies,peerDependencies,matcherFunction}=framework,dependencySearches=[];Array.isArray(dependencies)?dependencySearches=dependencies.map(name=>[name,void 0]):typeof dependencies=="object"&&(dependencySearches=Object.entries(dependencies)),dependencySearches.length>0&&(matcher.dependencies=dependencySearches.map(([name,matchFn])=>hasDependency(packageJson,name,matchFn)));let peerDependencySearches=[];return Array.isArray(peerDependencies)?peerDependencySearches=peerDependencies.map(name=>[name,void 0]):typeof peerDependencies=="object"&&(peerDependencySearches=Object.entries(peerDependencies)),peerDependencySearches.length>0&&(matcher.peerDependencies=peerDependencySearches.map(([name,matchFn])=>hasPeerDependency(packageJson,name,matchFn))),Array.isArray(files)&&files.length>0&&(matcher.files=files.map(name=>fs.existsSync(name))),matcherFunction(matcher)?preset:null};function detectFrameworkPreset(packageJson={}){let result=[...supportedTemplates,unsupportedTemplate].find(framework=>getFrameworkPreset(packageJson,framework)!==null);return result?result.preset:"UNDETECTED"}function detectBuilder(packageManager,projectType){if(findUp.sync(viteConfigFiles))return paddedLog("Detected Vite project. Setting builder to Vite"),"vite";if(detectWebpack(packageManager))return paddedLog("Detected webpack project. Setting builder to webpack"),"webpack5";switch(projectType){case"SVELTE":case"SVELTEKIT":case"VUE":case"VUE3":case"SFC_VUE":return"vite";default:return"webpack5"}}function isStorybookInstalled(dependencies,force){return dependencies?!!(!force&&dependencies.devDependencies&&SUPPORTED_RENDERERS.reduce((storybookPresent,framework)=>storybookPresent||!!dependencies.devDependencies[`@storybook/${framework}`],!1)):!1}function detectPnp(){return pathExistsSync(join(process.cwd(),".pnp.cjs"))}function detectLanguage(packageJson){let language="javascript";return!packageJson||fs.existsSync("jsconfig.json")||(hasDependency(packageJson,"typescript",version=>semver.gte(semver.coerce(version),"4.9.0"))&&(!hasDependency(packageJson,"prettier")||hasDependency(packageJson,"prettier",version=>semver.gte(semver.coerce(version),"2.8.0")))&&(!hasDependency(packageJson,"@babel/plugin-transform-typescript")||hasDependency(packageJson,"@babel/plugin-transform-typescript",version=>semver.gte(semver.coerce(version),"7.20.0")))&&(!hasDependency(packageJson,"@typescript-eslint/parser")||hasDependency(packageJson,"@typescript-eslint/parser",version=>semver.gte(semver.coerce(version),"5.44.0")))&&(!hasDependency(packageJson,"eslint-plugin-storybook")||hasDependency(packageJson,"eslint-plugin-storybook",version=>semver.gte(semver.coerce(version),"0.6.8")))?language="typescript-4-9":hasDependency(packageJson,"typescript",version=>semver.gte(semver.coerce(version),"3.8.0"))?language="typescript-3-8":hasDependency(packageJson,"typescript",version=>semver.lt(semver.coerce(version),"3.8.0"))&&logger.warn("Detected TypeScript < 3.8, populating with JavaScript examples")),language}function detect(packageJson,options={}){let bowerJson=getBowerJson();return!packageJson&&!bowerJson?"UNDETECTED":isNxProject(packageJson)?"NX":options.html?"HTML":detectFrameworkPreset(packageJson||bowerJson)}import{join as join2}from"path";import semver2 from"semver";import path2 from"path";import fse2 from"fs-extra";import{dedent as dedent2}from"ts-dedent";import fse from"fs-extra";import{dedent}from"ts-dedent";var logger2=console,sanitizeFramework=framework=>{let matches=framework.match(/(@storybook\/\w+(?:-\w+)*)|(storybook-(\w+(?:-\w+)*))/g);if(matches)return matches[0]};async function configureMain({addons,extensions=["js","jsx","ts","tsx"],storybookConfigFolder,language,...custom}){let prefix=await fse.pathExists("./src")?"../src":"../stories",config={stories:[`${prefix}/**/*.mdx`,`${prefix}/**/*.stories.@(${extensions.join("|")})`],addons,...custom},isTypescript=language==="typescript-4-9"||language==="typescript-3-8",mainConfigTemplate=dedent`<<import>>const config<<type>> = <<mainContents>>;
|
|
2
|
+
export default config;`,frameworkPackage=sanitizeFramework(custom.framework?.name);frameworkPackage||(mainConfigTemplate=mainConfigTemplate.replace("<<import>>","").replace("<<type>>",""),logger2.warn("Could not find framework package name"));let mainContents=JSON.stringify(config,null,2).replace(/['"]%%/g,"").replace(/%%['"]/g,""),imports=[];custom.framework?.name.includes("path.dirname(")&&imports.push("import path from 'path';"),isTypescript?imports.push(`import type { StorybookConfig } from '${frameworkPackage}';`):imports.push(`/** @type { import('${frameworkPackage}').StorybookConfig } */`);let mainJsContents=mainConfigTemplate.replace("<<import>>",`${imports.join(`
|
|
3
|
+
|
|
4
|
+
`)}
|
|
5
|
+
`).replace("<<type>>",isTypescript?": StorybookConfig":"").replace("<<mainContents>>",mainContents),prettier=(await import("prettier")).default,mainPath=`./${storybookConfigFolder}/main.${isTypescript?"ts":"js"}`,prettyMain=prettier.format(dedent(mainJsContents),{...prettier.resolveConfig.sync(process.cwd()),filepath:mainPath});await fse.writeFile(mainPath,prettyMain,{encoding:"utf8"})}async function configurePreview(options){let{prefix:frameworkPrefix=""}=options.frameworkPreviewParts||{},isTypescript=options.language==="typescript-4-9"||options.language==="typescript-3-8",rendererPackage=options.rendererId&&!externalFrameworks.map(({name})=>name).includes(options.rendererId)?`@storybook/${options.rendererId}`:null,previewPath=`./${options.storybookConfigFolder}/preview.${isTypescript?"ts":"js"}`;if(await fse.pathExists(previewPath))return;let prefix=[isTypescript&&rendererPackage?`import type { Preview } from '${rendererPackage}'`:"",frameworkPrefix].filter(Boolean).join(`
|
|
6
|
+
`),preview=dedent`
|
|
7
|
+
${prefix}${prefix.length>0?`
|
|
8
|
+
`:""}
|
|
9
|
+
${!isTypescript&&rendererPackage?`/** @type { import('${rendererPackage}').Preview } */
|
|
10
|
+
`:""}const preview${isTypescript?": Preview":""} = {
|
|
11
|
+
parameters: {
|
|
12
|
+
backgrounds: {
|
|
13
|
+
default: 'light',
|
|
14
|
+
},
|
|
15
|
+
actions: { argTypesRegex: '^on[A-Z].*' },
|
|
16
|
+
controls: {
|
|
17
|
+
matchers: {
|
|
18
|
+
color: /(background|color)$/i,
|
|
19
|
+
date: /Date$/,
|
|
20
|
+
},
|
|
29
21
|
},
|
|
30
22
|
},
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
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,pathExists as pathExists2}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 fileName=".babelrc.json",location=path5.join(target,fileName);if(await pathExists2(location)){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}}let{typescript,jsx}=await prompts([{type:"confirm",initial:!0,name:"typescript",message:"Do you want to add the TypeScript preset?"},{type:"confirm",initial:!0,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);logger3.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&&(logger3.info("Installing dependencies..."),JsPackageManagerFactory.getPackageManager().addDependencies({installAsDevDependencies:!0},added))};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"].includes(framework);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`
|
|
23
|
+
};
|
|
24
|
+
|
|
25
|
+
export default preview;
|
|
26
|
+
`.replace(`
|
|
27
|
+
`,"").trim(),prettier=(await import("prettier")).default,prettyPreview=prettier.format(preview,{...prettier.resolveConfig.sync(process.cwd()),filepath:previewPath});await fse.writeFile(previewPath,prettyPreview,{encoding:"utf8"})}import{writeFile,pathExists}from"fs-extra";import{logger as logger3}from"@storybook/node-logger";import path from"path";import prompts from"prompts";import chalk from"chalk";var generateStorybookBabelConfigInCWD=async()=>{let target=process.cwd();return generateStorybookBabelConfig({target})},generateStorybookBabelConfig=async({target})=>{logger3.info(`Generating the storybook default babel config at ${target}`);let fileName=".babelrc.json",location=path.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){logger3.warn("Cancelled, babel config file was NOT written to file-system.");return}}logger3.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);logger3.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?(logger3.info("Installing dependencies..."),JsPackageManagerFactory.getPackageManager().addDependencies({installAsDevDependencies:!0},added)):logger3.info(`\u26A0\uFE0F Please remember to install the required dependencies yourself: (${added.join(", ")})`)};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=>framework!==void 0&&(exFramework.name===framework||exFramework.packageName===framework||exFramework?.frameworks?.some?.(item=>item===framework))),getFrameworkPackage=(framework,renderer,builder)=>{let externalFramework=getExternalFramework(framework);return externalFramework===void 0?framework?`@storybook/${framework}`:`@storybook/${renderer}-${builder}`:externalFramework.frameworks!==void 0?externalFramework.frameworks.find(item=>item.match(new RegExp(`-${builder}`))):externalFramework.packageName},getRendererPackage=(framework,renderer)=>{let externalFramework=getExternalFramework(framework);return externalFramework!==void 0?externalFramework.renderer||externalFramework.packageName:`@storybook/${renderer}`},wrapForPnp=packageName=>`%%path.dirname(require.resolve(path.join('${packageName}', 'package.json')))%%`,getFrameworkDetails=(renderer,builder,pnp,framework)=>{let frameworkPackage=getFrameworkPackage(framework,renderer,builder),frameworkPackagePath=pnp?wrapForPnp(frameworkPackage):frameworkPackage,rendererPackage=getRendererPackage(framework,renderer),rendererPackagePath=pnp?wrapForPnp(rendererPackage):rendererPackage,builderPackage=getBuilderDetails(builder),builderPackagePath=pnp?wrapForPnp(builderPackage):builderPackage,isKnownFramework=!!getExternalFramework(frameworkPackage)||!!versions_default[frameworkPackage],isKnownRenderer=!!versions_default[rendererPackage];if(isKnownFramework)return{packages:[rendererPackage,frameworkPackage],framework:frameworkPackagePath,rendererId:renderer,type:"framework"};if(isKnownRenderer)return{packages:[rendererPackage,builderPackage],builder:builderPackagePath,renderer:rendererPackagePath,rendererId:renderer,type:"renderer"};throw new Error(`Could not find the framework (${frameworkPackage}) or renderer (${rendererPackage}) package`)},stripVersions=addons=>addons.map(addon=>getPackageDetails(addon)[0]),hasInteractiveStories=rendererId=>["react","angular","preact","svelte","vue","vue3","html","solid"].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:frameworkPackages3,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
28
|
Sorry, for now, you can not do this, please use a framework such as @storybook/react-webpack5
|
|
38
29
|
|
|
39
30
|
https://github.com/storybookjs/storybook/issues/18360
|
|
40
|
-
`);let packages=["storybook"
|
|
31
|
+
`);let packages=["storybook",getExternalFramework(rendererId)?void 0:`@storybook/${rendererId}`,...frameworkPackages3,...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:[path2.join("..",staticDir)]}:null,...extraMain,...type!=="framework"?{core:{builder:builderInclude}}:{}}),await configurePreview({frameworkPreviewParts,storybookConfigFolder,language,rendererId}),frameworkPackages3.find(pkg2=>pkg2.match(/^(@storybook\/|storybook).*-vite$/)||pkg2==="@storybook/sveltekit"||pkg2==="")){let previewHead=dedent2`
|
|
41
32
|
<script>
|
|
42
33
|
window.global = window;
|
|
43
34
|
</script>
|
|
44
|
-
`;await
|
|
35
|
+
`;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 copyTemplateFiles({renderer:templateLocation,packageManager,language,destination:componentsDestinationPath})}}import fs2 from"fs";import prompts2 from"prompts";import dedent3 from"ts-dedent";var ANGULAR_JSON_PATH="angular.json",compoDocPreviewPrefix=dedent3`
|
|
36
|
+
import { setCompodocJson } from "@storybook/addon-docs/angular";
|
|
37
|
+
import docJson from "../documentation.json";
|
|
38
|
+
setCompodocJson(docJson);
|
|
39
|
+
`.trimStart(),promptForCompoDocs=async()=>{let{useCompoDoc}=await prompts2({type:"confirm",name:"useCompoDoc",message:"Do you want to use Compodoc for documentation?"});return useCompoDoc},AngularJSON=class{constructor(){if(!fs2.existsSync(ANGULAR_JSON_PATH))throw commandLog("An angular.json file was not found in the current directory. Storybook needs it to work properly."),new Error("No angular.json file found");let jsonContent=fs2.readFileSync(ANGULAR_JSON_PATH,"utf8");this.json=JSON.parse(jsonContent)}get projects(){return this.json.projects}get projectsWithoutStorybook(){return Object.keys(this.projects).filter(projectName=>{let{architect}=this.projects[projectName];return!architect.storybook})}get hasStorybookBuilder(){return Object.keys(this.projects).some(projectName=>{let{architect}=this.projects[projectName];return Object.keys(architect).some(key=>architect[key].builder==="@storybook/angular:start-storybook")})}get rootProject(){let rootProjectName=Object.keys(this.projects).find(projectName=>{let{root}=this.projects[projectName];return root===""||root==="."});return rootProjectName?this.projects[rootProjectName]:null}getProjectSettingsByName(projectName){return this.projects[projectName]}async getProjectName(){if(this.projectsWithoutStorybook.length>1){let{projectName}=await prompts2({type:"select",name:"projectName",message:"For which project do you want to generate Storybook configuration?",choices:this.projectsWithoutStorybook.map(name=>({title:name,value:name}))});return projectName}return this.projectsWithoutStorybook[0]}addStorybookEntries({angularProjectName,storybookFolder,useCompodoc,root}){let{architect}=this.projects[angularProjectName],baseOptions={configDir:storybookFolder,browserTarget:`${angularProjectName}:build`,compodoc:useCompodoc,...useCompodoc&&{compodocArgs:["-e","json","-d",root||"."]}};architect.storybook||(architect.storybook={builder:"@storybook/angular:start-storybook",options:{...baseOptions,port:6006}}),architect["build-storybook"]||(architect["build-storybook"]={builder:"@storybook/angular:build-storybook",options:{...baseOptions,outputDir:Object.keys(this.projects).length===1?"storybook-static":`dist/storybook/${angularProjectName}`}})}write(){fs2.writeFileSync(ANGULAR_JSON_PATH,JSON.stringify(this.json,null,2))}};var generator=async(packageManager,npmOptions,options,commandOptions)=>{let angularVersionFromDependencies=semver2.coerce(packageManager.retrievePackageJson().dependencies["@angular/core"])?.version,angularVersionFromDevDependencies=semver2.coerce(packageManager.retrievePackageJson().devDependencies["@angular/core"])?.version,angularVersion=angularVersionFromDependencies||angularVersionFromDevDependencies,updatedOptions=semver2.gte(angularVersion,"12.0.0")?{...options,builder:"webpack5"}:options,angularJSON=new AngularJSON;if(angularJSON.projectsWithoutStorybook.length===0)return paddedLog("Every project in your workspace is already set up with Storybook. There is nothing to do!"),Promise.reject();let angularProjectName=await angularJSON.getProjectName();paddedLog(`Adding Storybook support to your "${angularProjectName}" project`);let{root}=angularJSON.getProjectSettingsByName(angularProjectName),{projects}=angularJSON,useCompodoc=commandOptions.yes?!0:await promptForCompoDocs(),storybookFolder=root?`${root}/.storybook`:".storybook";angularJSON.addStorybookEntries({angularProjectName,storybookFolder,useCompodoc,root}),angularJSON.write(),await baseGenerator(packageManager,npmOptions,{...updatedOptions,...useCompodoc&&{frameworkPreviewParts:{prefix:compoDocPreviewPrefix}}},"angular",{...useCompodoc&&{extraPackages:["@compodoc/compodoc"]},addScripts:!1,componentsDestinationPath:root?`${root}/src/stories`:void 0,storybookConfigFolder:storybookFolder},"angular"),Object.keys(projects).length===1&&packageManager.addScripts({storybook:`ng run ${angularProjectName}:storybook`,"build-storybook":`ng run ${angularProjectName}:build-storybook`});let templateDir=join2(getCliDir(),"templates","angular");return copyTemplate(templateDir,root||void 0),{projectName:angularProjectName}},ANGULAR_default=generator;import{join as join3}from"path";function addStorybookExcludeGlobToTsConfig(){let tsConfigJson=readFileAsJson("tsconfig.json",!0),glob="**/*.stories.ts";if(!tsConfigJson)return;let{exclude=[]}=tsConfigJson;exclude.includes(glob)||(tsConfigJson.exclude=[...exclude,glob],writeFileAsJson("tsconfig.json",tsConfigJson))}var generator2=async(packageManager,npmOptions,options)=>{addStorybookExcludeGlobToTsConfig(),await baseGenerator(packageManager,npmOptions,options,"aurelia",{extraPackages:["aurelia"]});let templateDir=join3(getCliDir(),"templates","aurelia");copyTemplate(templateDir)},AURELIA_default=generator2;var generator3=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"ember",{extraPackages:["babel-plugin-ember-modules-api-polyfill","babel-plugin-htmlbars-inline-precompile"],staticDir:"dist"})},EMBER_default=generator3;var generator4=async(packageManager,npmOptions,options)=>{let extraPackages=detectLanguage()==="javascript"?["prop-types"]:[];await baseGenerator(packageManager,npmOptions,options,"react",{extraPackages})},REACT_default=generator4;var generator5=async(packageManager,npmOptions)=>{let packageJson=packageManager.retrievePackageJson(),missingReactDom=!packageJson.dependencies["react-dom"]&&!packageJson.devDependencies["react-dom"],reactVersion=packageJson.dependencies.react,packagesToResolve=["react-native-safe-area-context","@react-native-async-storage/async-storage","@react-native-community/datetimepicker","@react-native-community/slider"],packagesWithFixedVersion=["@storybook/addon-actions@^6.5.14","@storybook/addon-controls@^6.5.14","@storybook/addon-ondevice-controls@6.5.0-rc.0","@storybook/addon-ondevice-actions@6.5.0-rc.0","@storybook/react-native@6.5.0-rc.0"],resolvedPackages=await packageManager.getVersionedPackages(packagesToResolve),packages=[...await getBabelDependencies(packageManager,packageJson),...packagesWithFixedVersion,...resolvedPackages,missingReactDom&&reactVersion&&`react-dom@${reactVersion}`].filter(Boolean);packageManager.addDependencies({...npmOptions,packageJson},packages),packageManager.addScripts({"storybook-generate":"sb-rn-get-stories","storybook-watch":"sb-rn-watcher"});let storybookConfigFolder=".storybook";await copyTemplateFiles({packageManager,renderer:"react-native",language:"javascript",destination:storybookConfigFolder,includeCommonAssets:!1})},REACT_NATIVE_default=generator5;import path3 from"path";import fs3 from"fs";import semver3 from"semver";import dedent4 from"ts-dedent";var generator6=async(packageManager,npmOptions,options)=>{let monorepoRootPath=path3.join(__dirname,"..","..","..","..","..",".."),extraMain=options.linkable?{webpackFinal:`%%(config) => {
|
|
45
40
|
// add monorepo root as a valid directory to import modules from
|
|
46
41
|
config.resolve.plugins.forEach((p) => {
|
|
47
42
|
if (Array.isArray(p.appSrcs)) {
|
|
@@ -50,256 +45,311 @@ Add a project and re-run the installation`)}async function getBaseTsConfigName()
|
|
|
50
45
|
});
|
|
51
46
|
return config;
|
|
52
47
|
}
|
|
53
|
-
%%`}:{},craVersion=
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
48
|
+
%%`}:{},craVersion=semver3.coerce(packageManager.retrievePackageJson().dependencies["react-scripts"])?.version,isCra5OrHigher=craVersion&&semver3.gte(craVersion,"5.0.0"),updatedOptions=isCra5OrHigher?{...options,builder:"webpack5"}:options,extraPackages=[];isCra5OrHigher&&(extraPackages.push("webpack"),extraPackages.push("babel-plugin-named-exports-order"),extraPackages.push("prop-types"));let extraAddons=[`@storybook/preset-create-react-app@${versions_default["@storybook/preset-create-react-app"]}`];if(!isCra5OrHigher)throw new Error(dedent4`
|
|
49
|
+
Storybook 7.0+ doesn't support react-scripts@<5.0.0.
|
|
50
|
+
|
|
51
|
+
https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#create-react-app-dropped-cra4-support
|
|
52
|
+
`);await baseGenerator(packageManager,npmOptions,updatedOptions,"react",{extraAddons,extraPackages,staticDir:fs3.existsSync(path3.resolve("./public"))?"public":void 0,addBabel:!1,addESLint:!0,extraMain})},REACT_SCRIPTS_default=generator6;var generator7=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"react",void 0,"nextjs")},NEXTJS_default=generator7;var generator8=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"vue")},SFC_VUE_default=generator8;var generator9=async(packageManager,npmOptions,options)=>{let extraPackages=options.builder==="webpack5"?["vue-loader@^15.7.0"]:[];await baseGenerator(packageManager,npmOptions,options,"vue",{extraPackages})},VUE_default=generator9;var generator10=async(packageManager,npmOptions,options)=>{let extraPackages=options.builder==="webpack5"?["vue-loader@^17.0.0","@vue/compiler-sfc@^3.2.0"]:[];await baseGenerator(packageManager,npmOptions,options,"vue3",{extraPackages})},VUE3_default=generator10;var generator11=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"react")},WEBPACK_REACT_default=generator11;var generator12=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"mithril")},MITHRIL_default=generator12;var generator13=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"marionette")},MARIONETTE_default=generator13;var generator14=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"marko")},MARKO_default=generator14;var generator15=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"html")},HTML_default=generator15;var generator16=async(packageManager,npmOptions,options)=>baseGenerator(packageManager,npmOptions,options,"web-components",{extraPackages:["lit"]}),WEB_COMPONENTS_default=generator16;var generator17=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"riot",{extraPackages:["riot-tag-loader"]})},RIOT_default=generator17;var generator18=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"preact")},PREACT_default=generator18;var generator19=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"svelte",{extensions:["js","jsx","ts","tsx","svelte"]})},SVELTE_default=generator19;var generator20=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"qwik",{},"qwik")},QWIK_default=generator20;var generator21=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"svelte",void 0,"sveltekit")},SVELTEKIT_default=generator21;var generator22=async(packageManager,npmOptions,options)=>{let[latestRaxVersion]=await packageManager.getVersions("rax"),packageJson=packageManager.retrievePackageJson(),raxVersion=packageJson.dependencies.rax||latestRaxVersion;packageJson.dependencies.rax=packageJson.dependencies.rax||raxVersion,packageJson.dependencies["rax-image"]=packageJson.dependencies["rax-image"]||raxVersion,packageJson.dependencies["rax-link"]=packageJson.dependencies["rax-link"]||raxVersion,packageJson.dependencies["rax-text"]=packageJson.dependencies["rax-text"]||raxVersion,packageJson.dependencies["rax-view"]=packageJson.dependencies["rax-view"]||raxVersion,packageManager.writePackageJson(packageJson),await baseGenerator(packageManager,npmOptions,options,"rax",{extraPackages:["rax"]})},RAX_default=generator22;var generator23=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"solid",{},"solid")},SOLID_default=generator23;import{join as join4}from"path";var generator24=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"server",{extensions:["json"]});let templateDir=join4(getCliDir(),"templates","server");copyTemplate(templateDir)},SERVER_default=generator24;import prompts5 from"prompts";import chalk22 from"chalk";import boxen from"boxen";import{createWriteStream,move,remove}from"fs-extra";import tempy from"tempy";import dedent26 from"ts-dedent";import{join as join5}from"path";import{getStorybookInfo as getStorybookInfo3,loadMainConfig as loadMainConfig2}from"@storybook/core-common";import semver19 from"semver";import chalk5 from"chalk";import{dedent as dedent8}from"ts-dedent";import semver7 from"semver";import chalk4 from"chalk";import{dedent as dedent7}from"ts-dedent";import semver6 from"semver";import chalk3 from"chalk";import semver5 from"semver";import dedent6 from"ts-dedent";import{getStorybookInfo,loadMainConfig}from"@storybook/core-common";import{readConfig,writeConfig as writeConfigFile}from"@storybook/csf-tools";import chalk2 from"chalk";import semver4 from"semver";import dedent5 from"ts-dedent";var logger4=console,getStorybookData=async({packageManager,configDir:userDefinedConfigDir})=>{let packageJson=packageManager.retrievePackageJson(),{mainConfig:mainConfigPath,version:storybookVersionSpecifier,configDir:configDirFromScript,previewConfig:previewConfigPath}=getStorybookInfo(packageJson,userDefinedConfigDir),storybookVersion=storybookVersionSpecifier&&semver4.coerce(storybookVersionSpecifier)?.version,configDir=userDefinedConfigDir||configDirFromScript||".storybook",mainConfig;try{mainConfig=await loadMainConfig({configDir,noCache:!0})}catch(err){throw new Error(dedent5`Unable to find or evaluate ${chalk2.blue(mainConfigPath)}: ${err.message}`)}return{configDir,mainConfig,storybookVersionSpecifier,storybookVersion,mainConfigPath,previewConfigPath}},updateMainConfig=async({mainConfigPath,dryRun},callback)=>{try{let main=await readConfig(mainConfigPath);await callback(main),dryRun||await writeConfigFile(main)}catch(e){logger4.info(`\u274C The migration failed to update your ${chalk2.blue(mainConfigPath)} on your behalf because of the following error:
|
|
53
|
+
${e}
|
|
54
|
+
`),logger4.info(`\u26A0\uFE0F Storybook automigrations are based on AST parsing and it's possible that your ${chalk2.blue(mainConfigPath)} file contains a non-standard format (e.g. your export is not an object) or that there was an error when parsing dynamic values (e.g. "require" calls, or usage of environment variables). When your main config is non-standard, automigrations are unfortunately not possible. Please follow the instructions given previously and follow the documentation to make the updates manually.`)}};var logger5=console,checkWebpack5Builder=async({configDir,packageManager})=>{let{mainConfig,storybookVersion}=await getStorybookData({configDir,packageManager});if(semver5.lt(storybookVersion,"6.3.0"))return logger5.warn(dedent6`
|
|
55
|
+
Detected SB 6.3 or below, please upgrade storybook to use webpack5.
|
|
58
56
|
|
|
59
|
-
|
|
57
|
+
To upgrade to the latest stable release, run this from your project directory:
|
|
60
58
|
|
|
61
|
-
|
|
59
|
+
${chalk3.cyan("npx storybook upgrade")}
|
|
62
60
|
|
|
63
|
-
|
|
64
|
-
|
|
61
|
+
Add the ${chalk3.cyan("--prerelease")} flag to get the latest prerelease.
|
|
62
|
+
`.trim()),null;if(semver5.gte(storybookVersion,"7.0.0"))return null;if(!mainConfig)return logger5.warn("Unable to find storybook main.js config"),null;let builder=mainConfig.core?.builder;return builder&&builder!=="webpack4"?(logger5.info(`Found builder ${builder}, skipping`),null):{storybookVersion}};var logger6=console,webpack5={id:"webpack5",async check({configDir,packageManager}){let webpackVersion=packageManager.retrievePackageJson().dependencies.webpack,webpackCoerced=semver6.coerce(webpackVersion)?.version;if(!webpackCoerced||semver6.lt(webpackCoerced,"5.0.0")||semver6.gte(webpackCoerced,"6.0.0"))return null;let builderInfo=await checkWebpack5Builder({configDir,packageManager});return builderInfo?{webpackVersion,...builderInfo}:null},prompt({webpackVersion}){let webpackFormatted=chalk4.cyan(`webpack ${webpackVersion}`);return dedent7`
|
|
65
63
|
We've detected you're running ${webpackFormatted}.
|
|
66
64
|
Your Storybook's main.js files specifies webpack4, which is incompatible.
|
|
67
65
|
|
|
68
66
|
To run Storybook in webpack5-mode, we can install Storybook's ${chalk4.cyan("@storybook/builder-webpack5")} for you.
|
|
69
67
|
|
|
70
68
|
More info: ${chalk4.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#webpack-5-manager-build")}
|
|
71
|
-
`},async run({result:{
|
|
69
|
+
`},async run({result:{storybookVersion,webpackVersion},packageManager,dryRun,mainConfigPath}){let deps=[`@storybook/builder-webpack5@${storybookVersion}`];webpackVersion||deps.push("webpack@5"),logger6.info(`\u2705 Adding dependencies: ${deps}`),dryRun||packageManager.addDependencies({installAsDevDependencies:!0},deps),logger6.info("\u2705 Setting `core.builder` to `@storybook/builder-webpack5` in main.js"),dryRun||await updateMainConfig({mainConfigPath,dryRun},async main=>{main.setFieldValue(["core","builder"],"@storybook/builder-webpack5")})}};var cra5={id:"cra5",async check({packageManager,configDir}){let craVersion=packageManager.getAllDependencies()["react-scripts"],craCoerced=semver7.coerce(craVersion)?.version;if(!craCoerced||semver7.lt(craCoerced,"5.0.0"))return null;let builderInfo=await checkWebpack5Builder({configDir,packageManager});return builderInfo?{craVersion,...builderInfo}:null},prompt({craVersion}){let craFormatted=chalk5.cyan(`Create React App (CRA) ${craVersion}`);return dedent8`
|
|
72
70
|
We've detected you are running ${craFormatted} which is powered by webpack5.
|
|
73
71
|
Your Storybook's main.js files specifies webpack4, which is incompatible.
|
|
74
72
|
|
|
75
73
|
In order to work with your version of CRA, we need to install Storybook's ${chalk5.cyan("@storybook/builder-webpack5")}.
|
|
76
74
|
|
|
77
75
|
More info: ${chalk5.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#cra5-upgrade")}
|
|
78
|
-
`},async run(options){return webpack5.run({...options,result:{webpackVersion:null,...options.result}})}};import chalk6 from"chalk";import{dedent as
|
|
76
|
+
`},async run(options){return webpack5.run({...options,result:{webpackVersion:null,...options.result}})}};import chalk6 from"chalk";import{dedent as dedent9}from"ts-dedent";import semver8 from"semver";var angular12={id:"angular12",async check({packageManager,configDir}){let angularVersion=packageManager.getAllDependencies()["@angular/core"],angularCoerced=semver8.coerce(angularVersion)?.version;if(!angularCoerced||semver8.lt(angularCoerced,"12.0.0"))return null;let builderInfo=await checkWebpack5Builder({packageManager,configDir});return builderInfo?{angularVersion,...builderInfo}:null},prompt({angularVersion}){let angularFormatted=chalk6.cyan(`Angular ${angularVersion}`);return dedent9`
|
|
79
77
|
We've detected you are running ${angularFormatted} which is powered by webpack5.
|
|
80
78
|
Your Storybook's main.js files specifies webpack4, which is incompatible.
|
|
81
79
|
|
|
82
80
|
In order to work with your version of Angular, we need to install Storybook's ${chalk6.cyan("@storybook/builder-webpack5")}.
|
|
83
81
|
|
|
84
82
|
More info: ${chalk6.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#angular12-upgrade")}
|
|
85
|
-
`},async run(options){return webpack5.run({...options,result:{webpackVersion:null,...options.result}})}};import chalk7 from"chalk";import{dedent as
|
|
83
|
+
`},async run(options){return webpack5.run({...options,result:{webpackVersion:null,...options.result}})}};import chalk7 from"chalk";import{dedent as dedent10}from"ts-dedent";import semver9 from"semver";var vue3={id:"vue3",async check({configDir,packageManager}){let vueVersion=packageManager.getAllDependencies().vue,vueCoerced=semver9.coerce(vueVersion)?.version;if(!vueCoerced||semver9.lt(vueCoerced,"3.0.0"))return null;let builderInfo=await checkWebpack5Builder({configDir,packageManager});return builderInfo?{vueVersion,...builderInfo}:null},prompt({vueVersion,storybookVersion}){let vueFormatted=chalk7.cyan(`Vue ${vueVersion}`),sbFormatted=chalk7.cyan(`Storybook ${storybookVersion}`);return dedent10`
|
|
86
84
|
We've detected you are running ${vueFormatted} with Storybook.
|
|
87
85
|
${sbFormatted} runs webpack4 by default, which is incompatible.
|
|
88
86
|
|
|
89
87
|
In order to work with your version of Vue, we need to install Storybook's ${chalk7.cyan("webpack5 builder")}.
|
|
90
88
|
|
|
91
89
|
More info: ${chalk7.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#vue3-upgrade")}
|
|
92
|
-
`},async run(options){return webpack5.run({...options,result:{webpackVersion:null,...options.result}})}};import
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
More info: ${chalk8.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#mainjs-framework-field")}
|
|
103
|
-
`},async run({result:{main,framework},dryRun}){logger5.info(`\u2705 Setting 'framework' to '${framework}' in main.js`),dryRun||(main.setFieldValue(["framework"],framework),await writeConfig2(main))}};import chalk9 from"chalk";import{dedent as dedent8}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 fse4 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=>fse4.existsSync(`${filePrefix}.${ext}`));if(unsupportedExtension)throw new Error(unsupportedExtension);let extension=SUPPORTED_ESLINT_EXTENSIONS.find(ext=>fse4.existsSync(`${filePrefix}.${ext}`));return extension?`${filePrefix}.${extension}`:null};var logger6=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 logger6.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 logger6.warn("Unable to find .eslintrc config file, skipping"),null;let main=await readConfig3(mainConfig);return{eslintFile,main,unsupportedExtension}},prompt(){return dedent8`
|
|
90
|
+
`},async run(options){return webpack5.run({...options,result:{webpackVersion:null,...options.result}})}};import{dedent as dedent11}from"ts-dedent";import semver10 from"semver";var logger7=console,mdxgfm={id:"github-flavored-markdown-mdx",async check({configDir,packageManager}){let{mainConfig,storybookVersion}=await getStorybookData({packageManager,configDir});return!semver10.gte(storybookVersion,"7.0.0")||mainConfig?.features?.legacyMdx1===!0||!1||!!mainConfig.addons?.find(item=>item==="@storybook/addon-mdx-gfm"?!0:typeof item=="string"?!1:item.name==="@storybook/addon-docs"?item.options?.mdxPluginOptions?.mdxCompileOptions?.remarkPlugins?.length>0:!1)?null:{}},prompt(){return dedent11`
|
|
91
|
+
In MDX1 you had the option of using GitHub flavored markdown.
|
|
92
|
+
|
|
93
|
+
Storybook 7.0 uses MDX2 for compiling MDX, and thus no longer supports GFM out of the box.
|
|
94
|
+
Because of this you need to explicitly add the GFM plugin in the addon-docs options:
|
|
95
|
+
https://storybook.js.org/docs/7.0/react/writing-docs/mdx#lack-of-github-flavored-markdown-gfm
|
|
96
|
+
|
|
97
|
+
We recommend you follow the guide on the link above, however we can add a temporary storybook addon that helps make this migration easier.
|
|
98
|
+
We'll install the addon and add it to your storybook config.
|
|
99
|
+
`},async run({packageManager,dryRun,mainConfigPath,skipInstall}){if(!dryRun){let packageJson=packageManager.retrievePackageJson(),versionToInstall=getStorybookVersionSpecifier(packageManager.retrievePackageJson());await packageManager.addDependencies({installAsDevDependencies:!0,skipInstall,packageJson},[`@storybook/addon-mdx-gfm@${versionToInstall}`]),await updateMainConfig({mainConfigPath,dryRun},async main=>{let addonsToAdd=["@storybook/addon-mdx-gfm"],updatedAddons=[...main.getFieldValue(["addons"]),...addonsToAdd];logger7.info('\u2705 Adding "@storybook/addon-mdx-gfm" addon'),dryRun||main.setFieldValue(["addons"],updatedAddons)})}}};import chalk8 from"chalk";import{dedent as dedent12}from"ts-dedent";import{readConfig as readConfig2,writeConfig}from"@storybook/csf-tools";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 logger8=console,eslintPlugin={id:"eslintPlugin",async check({packageManager}){let allDependencies=packageManager.getAllDependencies(),eslintPluginStorybook=allDependencies["eslint-plugin-storybook"],eslintDependency=allDependencies.eslint;if(eslintPluginStorybook||!eslintDependency)return null;let eslintFile,unsupportedExtension;try{eslintFile=findEslintFile()}catch(err){unsupportedExtension=err.message}return!eslintFile&&!unsupportedExtension?(logger8.warn("Unable to find .eslintrc config file, skipping"),null):{eslintFile,unsupportedExtension}},prompt(){return dedent12`
|
|
104
100
|
We've detected you are not using our eslint-plugin.
|
|
105
101
|
|
|
106
102
|
In order to have the best experience with Storybook and follow best practices, we advise you to install eslint-plugin-storybook.
|
|
107
103
|
|
|
108
|
-
More info: ${
|
|
109
|
-
`},async run({result:{eslintFile,unsupportedExtension},packageManager,dryRun}){let deps=["eslint-plugin-storybook"];if(
|
|
104
|
+
More info: ${chalk8.yellow("https://github.com/storybookjs/eslint-plugin-storybook#readme")}
|
|
105
|
+
`},async run({result:{eslintFile,unsupportedExtension},packageManager,dryRun,skipInstall}){let deps=["eslint-plugin-storybook"];if(logger8.info(`\u2705 Adding dependencies: ${deps}`),dryRun||packageManager.addDependencies({installAsDevDependencies:!0,skipInstall},deps),!dryRun&&unsupportedExtension){logger8.info(dedent12`
|
|
110
106
|
⚠️ The plugin was successfully installed but failed to configure.
|
|
111
107
|
|
|
112
108
|
Found an eslint config file with an unsupported automigration format: .eslintrc.${unsupportedExtension}.
|
|
113
109
|
The supported formats for this automigration are: ${SUPPORTED_ESLINT_EXTENSIONS.join(", ")}.
|
|
114
110
|
|
|
115
111
|
Please refer to https://github.com/storybookjs/eslint-plugin-storybook#usage to finish setting up the plugin manually.
|
|
116
|
-
`);return}if(
|
|
112
|
+
`);return}if(logger8.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 readConfig2(eslintFile),extendsConfig=eslint.getFieldValue(["extends"])||[],existingConfigValue=Array.isArray(extendsConfig)?extendsConfig:[extendsConfig];eslint.setFieldValue(["extends"],[...existingConfigValue,"plugin:storybook/recommended"]),await writeConfig(eslint)}}};import chalk9 from"chalk";import{dedent as dedent13}from"ts-dedent";import{writeConfig as writeConfig2}from"@storybook/csf-tools";var logger9=console,builderVite={id:"builder-vite",async check({configDir,packageManager}){let packageJson=packageManager.retrievePackageJson(),{mainConfig}=await getStorybookData({configDir,packageManager}),builder=mainConfig.core?.builder;return(typeof builder=="string"?builder:builder?.name)!=="storybook-builder-vite"?null:{builder,packageJson}},prompt({builder}){let builderFormatted=chalk9.cyan(JSON.stringify(builder,null,2));return dedent13`
|
|
117
113
|
We've detected you're using the community vite builder: ${builderFormatted}
|
|
118
114
|
|
|
119
|
-
'storybook-builder-vite' is deprecated and now located at ${
|
|
115
|
+
'storybook-builder-vite' is deprecated and now located at ${chalk9.cyan("@storybook/builder-vite")}.
|
|
120
116
|
|
|
121
117
|
We can upgrade your project to use the new builder automatically.
|
|
122
118
|
|
|
123
|
-
More info: ${
|
|
124
|
-
`},async run({result:{builder,
|
|
125
|
-
|
|
126
|
-
🤔 Are you running automigrate from your project directory?
|
|
127
|
-
`);if(semver10.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=chalk11.cyan(`Storybook ${storybookVersion}`),newScriptsMessage=Object.keys(storybookScripts).reduce((acc,scriptKey)=>(acc.push([chalk11.bold(scriptKey),"from:",chalk11.cyan(storybookScripts[scriptKey].before),"to:",chalk11.cyan(storybookScripts[scriptKey].after)].join(`
|
|
128
|
-
`)),acc),[]);return dedent10`
|
|
119
|
+
More info: ${chalk9.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#vite-builder-renamed")}
|
|
120
|
+
`},async run({result:{builder,packageJson},packageManager,dryRun,mainConfigPath}){let{dependencies={},devDependencies={}}=packageJson;logger9.info("\u2705 Removing existing 'storybook-builder-vite' dependency"),dryRun||(delete dependencies["storybook-builder-vite"],delete devDependencies["storybook-builder-vite"],packageManager.writePackageJson(packageJson)),logger9.info("\u2705 Adding '@storybook/builder-vite' as dev dependency"),dryRun||packageManager.addDependencies({installAsDevDependencies:!0},["@storybook/builder-vite"]),logger9.info("\u2705 Updating main.js to use vite builder"),dryRun||await updateMainConfig({dryRun,mainConfigPath},async main=>{let updatedBuilder=typeof builder=="string"?"@storybook/builder-vite":{name:"@storybook/builder-vite",options:builder.options};main.setFieldValue(["core","builder"],updatedBuilder),await writeConfig2(main)})}};import chalk10 from"chalk";import{dedent as dedent14}from"ts-dedent";import semver11 from"semver";var logger10=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,configDir}){let packageJson=packageManager.retrievePackageJson(),{scripts={}}=packageJson,{storybookVersion}=await getStorybookData({packageManager,configDir});if(semver11.lt(storybookVersion,"7.0.0"))return null;let storybookScripts=getStorybookScripts(scripts);return Object.keys(storybookScripts).length===0?null:{packageJson,storybookScripts,storybookVersion}},prompt({storybookVersion,storybookScripts}){let sbFormatted=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(`
|
|
121
|
+
`)),acc),[]);return dedent14`
|
|
129
122
|
We've detected you are using ${sbFormatted} with scripts from previous versions of Storybook.
|
|
130
|
-
Starting in Storybook 7, the ${
|
|
123
|
+
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.
|
|
131
124
|
In order to work with ${sbFormatted}, your storybook scripts have to be adjusted to use the binary. We can adjust them for you:
|
|
132
125
|
|
|
133
126
|
${newScriptsMessage.join(`
|
|
134
127
|
|
|
135
128
|
`)}
|
|
136
129
|
|
|
137
|
-
In case this migration did not cover all of your scripts, or you'd like more info: ${
|
|
138
|
-
`},async run({result:{storybookScripts},packageManager,dryRun}){if(
|
|
139
|
-
❌ Unable to determine storybook version.
|
|
140
|
-
🤔 Are you running automigrate from your project directory?
|
|
141
|
-
`);if(semver11.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=chalk12.cyan(`Storybook ${storybookVersion}`),storybookBinaryMessage=hasStorybookBinary?"":`We've detected you are using ${sbFormatted} without Storybook's ${chalk12.magenta("storybook")} binary. Starting in Storybook 7.0, it has to be installed.`;return dedent11`
|
|
130
|
+
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")}
|
|
131
|
+
`},async run({result:{storybookScripts},packageManager,dryRun}){if(logger10.info("\u2705 Updating scripts in package.json"),logger10.log(),!dryRun){let newScripts=Object.keys(storybookScripts).reduce((acc,scriptKey)=>(acc[scriptKey]=storybookScripts[scriptKey].after,acc),{});logger10.log(),packageManager.addScripts(newScripts)}}};import chalk11 from"chalk";import{dedent as dedent15}from"ts-dedent";import semver12 from"semver";var logger11=console,sbBinary={id:"storybook-binary",async check({packageManager,configDir}){let packageJson=packageManager.retrievePackageJson(),allDependencies=packageManager.getAllDependencies(),{storybookVersion}=await getStorybookData({packageManager,configDir});if(allDependencies["@nrwl/storybook"]||semver12.lt(storybookVersion,"7.0.0"))return null;let hasSbBinary=!!allDependencies.sb,hasStorybookBinary=!!allDependencies.storybook;return!hasSbBinary&&hasStorybookBinary?null:{hasSbBinary,hasStorybookBinary,storybookVersion,packageJson}},prompt({storybookVersion,hasSbBinary,hasStorybookBinary}){let sbFormatted=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 dedent15`
|
|
142
132
|
${storybookBinaryMessage}
|
|
143
133
|
${hasSbBinary?`You're using the 'sb' binary and it should be replaced, as 'storybook' is the recommended way to run Storybook.
|
|
144
134
|
`:""}
|
|
145
135
|
|
|
146
|
-
More info: ${
|
|
147
|
-
`},async run({result:{packageJson,hasSbBinary,hasStorybookBinary},packageManager,dryRun}){if(hasSbBinary&&(
|
|
148
|
-
❌
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
`),
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
This package is a replacement for ${chalk13.magenta("@storybook/react-webpack5")} and provides a better experience for Next.js users.
|
|
167
|
-
${addonsMessage}
|
|
168
|
-
To learn more about it, see: ${chalk13.yellow("https://github.com/storybookjs/storybook/blob/next/code/frameworks/nextjs/README.md")}
|
|
169
|
-
`},async run({result:{addonsToRemove,main,frameworkOptions,packageJson},packageManager,dryRun}){let dependenciesToRemove=[...addonsToRemove,"@storybook/react-webpack5"];if(dependenciesToRemove.length>0&&(logger10.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(logger10.info("\u2705 Installing new dependencies: @storybook/nextjs"),!dryRun){let versionToInstall=getStorybookVersionSpecifier(packageJson);packageManager.addDependencies({installAsDevDependencies:!0,packageJson},[`@storybook/nextjs@${versionToInstall}`])}logger10.info("\u2705 Updating framework field in main.js"),dryRun||(main.setFieldValue(["framework","options"],frameworkOptions),main.setFieldValue(["framework","name"],"@storybook/nextjs"),await writeConfig5(main))}};import chalk14 from"chalk";import dedent13 from"ts-dedent";import semver13 from"semver";import{readConfig as readConfig6,writeConfig as writeConfig6}from"@storybook/csf-tools";import{getStorybookInfo as getStorybookInfo8}from"@storybook/core-common";var logger11=console,packagesMap={"@storybook/react":{webpack5:"@storybook/react-webpack5",vite:"@storybook/react-vite"},"@storybook/preact":{webpack5:"@storybook/preact-webpack5"},"@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){logger11.warn(dedent13`
|
|
170
|
-
Unable to get the ${framework}Options field.
|
|
171
|
-
|
|
172
|
-
Please review the changes made to your main.js config and make any necessary changes.
|
|
173
|
-
The ${framework}Options should be moved to the framework.options field.
|
|
136
|
+
More info: ${chalk11.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#start-storybook--build-storybook-binaries-removed")}
|
|
137
|
+
`},async run({result:{packageJson,hasSbBinary,hasStorybookBinary},packageManager,dryRun,skipInstall}){if(hasSbBinary&&(logger11.info("\u2705 Removing 'sb' dependency"),dryRun||packageManager.removeDependencies({skipInstall:skipInstall||!hasStorybookBinary,packageJson},["sb"])),!hasStorybookBinary&&(logger11.log(),logger11.info("\u2705 Adding 'storybook' as dev dependency"),logger11.log(),!dryRun)){let versionToInstall=getStorybookVersionSpecifier(packageJson);packageManager.addDependencies({installAsDevDependencies:!0,packageJson,skipInstall},[`storybook@${versionToInstall}`])}}};import chalk12 from"chalk";import dedent16 from"ts-dedent";import findUp3 from"find-up";import semver13 from"semver";import{frameworkPackages as frameworkPackages2,rendererPackages as rendererPackages2}from"@storybook/core-common";import{rendererPackages}from"@storybook/core-common";import prompts3 from"prompts";var detectRenderer=async packageJson=>{let allDependencies={...packageJson.dependencies,...packageJson.devDependencies,...packageJson.peerDependencies},matches=Object.keys(rendererPackages).filter(pkg2=>!!allDependencies[pkg2]),[rendererPackage]=matches;return matches.length>1&&(rendererPackage=(await prompts3([{type:"select",name:"rendererPackage",hint:"> - Use arrow-keys. Return to submit. To automate this next time, you can pass the renderer to the CLI via the --renderer flag",message:"Tried to detect a Storybook renderer in your project but found multiple. This could happen in monorepos, when projects contain multiple Storybook packages in package.json. Please select the correct one:",choices:matches.map(type=>({title:type,value:type}))}])).rendererPackage),rendererPackage};import{frameworkPackages}from"@storybook/core-common";import findUp2 from"find-up";var logger12=console,packagesMap={"@storybook/react":{webpack5:"@storybook/react-webpack5",vite:"@storybook/react-vite"},"@storybook/preact":{webpack5:"@storybook/preact-webpack5",vite:"@storybook/preact-vite"},"@storybook/server":{webpack5:"@storybook/server-webpack5"},"@storybook/ember":{webpack5:"@storybook/ember"},"@storybook/angular":{webpack5:"@storybook/angular"},"@storybook/vue":{webpack5:"@storybook/vue-webpack5",vite:"@storybook/vue-vite"},"@storybook/vue3":{webpack5:"@storybook/vue3-webpack5",vite:"@storybook/vue3-vite"},"@storybook/svelte":{webpack5:"@storybook/svelte-webpack5",vite:"@storybook/svelte-vite"},"@storybook/web-components":{webpack5:"@storybook/web-components-webpack5",vite:"@storybook/web-components-vite"},"@storybook/html":{webpack5:"@storybook/html-webpack5",vite:"@storybook/html-vite"}},communityFrameworks={vite:["storybook-framework-qwik","storybook-solidjs-vite"],webpack5:[]},viteConfigFiles2=["vite.config.js","vite.config.cjs","vite.config.mjs","vite.config.ts"],webpackConfigFiles=["webpack.config.js","webpack.config.cjs","webpack.config.mjs","webpack.config.ts"],detectBuilderInfo=async({mainConfig,configDir,packageDependencies})=>{let builderOptions={},builderName,builderOrFrameworkName,{core={},framework}=mainConfig,{builder}=core;if(builder)typeof builder=="string"?builderOrFrameworkName=builder:(builderOrFrameworkName=builder.name,builderOptions=builder.options||{});else if(framework){let frameworkName=typeof framework=="string"?framework:framework.name;Object.keys(frameworkPackages).includes(frameworkName)&&(builderOrFrameworkName=frameworkName,builderOptions=typeof framework=="object"?framework.options?.builder:{})}if(!builderOrFrameworkName){let viteConfigFile=await findUp2(viteConfigFiles2,{cwd:configDir});if(viteConfigFile)logger12.info(`No builder or framework field, detected Storybook builder via: ${viteConfigFile}`),builderOrFrameworkName="vite";else{let webpackConfigFile=await findUp2(webpackConfigFiles,{cwd:configDir});webpackConfigFile&&(logger12.info(`No builder or framework field, detected Storybook builder via: ${webpackConfigFile}`),builderOrFrameworkName="webpack5")}}return builderOrFrameworkName||(packageDependencies["@storybook/builder-vite"]||packageDependencies["storybook-builder-vite"]?builderOrFrameworkName="vite":(packageDependencies["@storybook/builder-webpack5"]||packageDependencies["@storybook/manager-webpack5"])&&(builderOrFrameworkName="webpack5")),builderOrFrameworkName?.includes("vite")||communityFrameworks.vite.includes(builderOrFrameworkName)?builderName="vite":(builderOrFrameworkName?.includes("webpack")||communityFrameworks.webpack5.includes(builderOrFrameworkName),builderName="webpack5"),{name:builderName,options:builderOptions}},getNextjsAddonOptions=addons=>{let nextjsAddon=addons?.find(addon=>typeof addon=="string"?addon==="storybook-addon-next":addon.name==="storybook-addon-next");return!nextjsAddon||typeof nextjsAddon=="string"?{}:nextjsAddon.options||{}};var logger13=console,nextJsConfigFiles=["next.config.js","next.config.cjs","next.config.mjs","next.config.ts"],newFrameworks={id:"new-frameworks",async check({rendererPackage:userDefinedRendererPackage,configDir:userDefinedConfigDir,packageManager}){let packageJson=packageManager.retrievePackageJson(),{storybookVersion,mainConfig,mainConfigPath,configDir}=await getStorybookData({packageManager,configDir:userDefinedConfigDir});if(!semver13.gte(storybookVersion,"7.0.0"))return null;let frameworkPackage=typeof mainConfig.framework=="string"?mainConfig.framework:mainConfig.framework?.name,hasFrameworkInMainConfig=!!frameworkPackage,rendererPackage=userDefinedRendererPackage;rendererPackage||(frameworkPackage&&Object.keys(rendererPackages2).includes(frameworkPackage)?rendererPackage=frameworkPackage:frameworkPackage&&Object.values(rendererPackages2).includes(frameworkPackage)?(rendererPackage=Object.keys(rendererPackages2).find(k=>rendererPackages2[k]===frameworkPackage),hasFrameworkInMainConfig=!1):rendererPackage=await detectRenderer(packageJson));let builderConfig=mainConfig.core?.builder;if(!Object.keys(packagesMap).includes(rendererPackage))return null;let allDependencies=packageManager.getAllDependencies(),builderInfo=await detectBuilderInfo({mainConfig,configDir,packageDependencies:allDependencies}),newFrameworkPackage=Object.keys(frameworkPackages2).find(pkg2=>pkg2===frameworkPackage);if(newFrameworkPackage||(newFrameworkPackage=packagesMap[rendererPackage]&&packagesMap[rendererPackage][builderInfo.name]),!newFrameworkPackage)return null;let renderer=rendererPackages2[rendererPackage],rendererOptions=mainConfig[`${renderer}Options`]||{},frameworkOptions=typeof mainConfig.framework=="string"?{}:mainConfig.framework?.options,dependenciesToRemove=["@storybook/builder-webpack5","@storybook/manager-webpack5","@storybook/builder-webpack4","@storybook/manager-webpack4","@storybook/builder-vite","storybook-builder-vite"],addonsToRemove=[],addonOptions={},metaFramework;if(rendererPackage==="@storybook/react"&&allDependencies.next){let nextConfigFile=await findUp3(nextJsConfigFiles,{cwd:configDir}),nextAddonOptions=getNextjsAddonOptions(mainConfig.addons);(semver13.gte(semver13.coerce(allDependencies.next).version,"12.0.0")&&nextConfigFile||Object.keys(nextAddonOptions).length>0)&&(metaFramework="nextjs",(newFrameworkPackage==="@storybook/react-webpack5"||newFrameworkPackage==="@storybook/nextjs")&&(newFrameworkPackage="@storybook/nextjs",addonsToRemove=["storybook-addon-next","storybook-addon-next-router"].filter(dep=>allDependencies[dep]||mainConfig.addons?.find(addon=>typeof addon=="string"?dep===addon:dep===addon.name)),addonOptions=nextAddonOptions,dependenciesToRemove.push("@storybook/react-webpack5","storybook-addon-next","storybook-addon-next-router")))}else rendererPackage==="@storybook/svelte"&&allDependencies["@sveltejs/kit"]&&semver13.gte(semver13.coerce(allDependencies["@sveltejs/kit"]).version,"1.0.0")&&(metaFramework="sveltekit",newFrameworkPackage==="@storybook/svelte-vite"&&(newFrameworkPackage="@storybook/sveltekit",rendererOptions={},dependenciesToRemove.push("@storybook/svelte-vite")));let dependenciesToAdd=[newFrameworkPackage].filter(dep=>!allDependencies[dep]).filter(Boolean);if(dependenciesToRemove=dependenciesToRemove.filter(dep=>allDependencies[dep]).filter(Boolean),hasFrameworkInMainConfig&&!builderConfig&&!Object.keys(rendererOptions).length&&!Object.keys(addonOptions).length&&!dependenciesToRemove.length&&!dependenciesToAdd.length)return null;if(allDependencies.vite&&semver13.lt(semver13.coerce(allDependencies.vite).version,"3.0.0"))throw new Error(dedent16`
|
|
138
|
+
❌ Your project should be upgraded to use the framework package ${chalk12.bold(newFrameworkPackage)}, but we detected that you are using Vite ${chalk12.bold(allDependencies.vite)}, which is unsupported in ${chalk12.bold("Storybook 7.0")}. Please upgrade Vite to ${chalk12.bold("3.0.0 or higher")} and rerun this migration.
|
|
139
|
+
`);return{mainConfigPath,dependenciesToAdd,dependenciesToRemove,frameworkPackage:newFrameworkPackage,hasFrameworkInMainConfig,frameworkOptions:{...frameworkOptions,...rendererOptions,...addonOptions},rendererOptions,addonOptions,addonsToRemove,builderInfo,packageJson,renderer,builderConfig,metaFramework}},prompt({dependenciesToRemove,dependenciesToAdd,hasFrameworkInMainConfig,mainConfigPath,frameworkPackage,addonOptions,renderer,rendererOptions,builderConfig,addonsToRemove,metaFramework}){let disclaimer="",migrationSteps="";return dependenciesToRemove.length>0&&(migrationSteps+=`- Remove the following dependencies:
|
|
140
|
+
${dependenciesToRemove.map(dep=>`- * ${chalk12.cyan(dep)}`).join(`
|
|
141
|
+
`)}
|
|
142
|
+
`),dependenciesToAdd.length>0&&(migrationSteps+=`- Add the following dependencies:
|
|
143
|
+
${dependenciesToAdd.map(dep=>`- * ${chalk12.cyan(dep)}`).join(`
|
|
144
|
+
`)}
|
|
145
|
+
`),hasFrameworkInMainConfig||(migrationSteps+=`- Update or specify the ${chalk12.yellow("framework")} field in ${chalk12.blue(mainConfigPath)} with the value of "${chalk12.cyan(frameworkPackage)}".
|
|
146
|
+
`),Object.keys(rendererOptions).length>0&&(migrationSteps+=`- Move the ${chalk12.yellow(`${renderer}Options`)} field in ${chalk12.blue(mainConfigPath)} to ${chalk12.yellow("framework.options")}, and remove that field entirely.
|
|
147
|
+
More info: ${chalk12.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#frameworkoptions-renamed")}
|
|
148
|
+
`),addonsToRemove.length>0&&(migrationSteps+=`- Remove the following addons from your ${chalk12.blue(mainConfigPath)}, as the new framework also supports features provided by them:
|
|
149
|
+
${addonsToRemove.map(dep=>`- * ${chalk12.cyan(dep)}`).join(`
|
|
150
|
+
`)}
|
|
151
|
+
`),Object.keys(addonOptions).length>0&&(migrationSteps+=`- Move the addon options "${chalk12.yellow(Object.keys(addonOptions).join(", "))}" in ${chalk12.blue(mainConfigPath)} to the ${chalk12.yellow("framework.options")} field.
|
|
152
|
+
`),builderConfig&&(typeof builderConfig=="object"&&Object.keys(builderConfig.options||{}).length>0&&(migrationSteps+=`- Move the ${chalk12.yellow("core.builder.options")} field in ${chalk12.blue(mainConfigPath)} to ${chalk12.yellow("framework.options.builder")}
|
|
153
|
+
`),migrationSteps+=`- Remove the ${chalk12.yellow("core.builder")} field in ${chalk12.blue(mainConfigPath)}.
|
|
154
|
+
`),(dependenciesToRemove.includes("@storybook/builder-webpack4")||dependenciesToRemove.includes("@storybook/manager-webpack4"))&&(disclaimer=dedent16`\n\n
|
|
155
|
+
${chalk12.underline(chalk12.bold(chalk12.cyan("Webpack 4 users")))}
|
|
174
156
|
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
157
|
+
Unless you're using Storybook's Vite builder, this automigration will install a Webpack 5 based framework.
|
|
158
|
+
|
|
159
|
+
Given you were using Storybook's Webpack 4 builder (default in 6.x, discontinued in 7.0), this could be a breaking change -- especially if your project has a custom webpack configuration.
|
|
160
|
+
|
|
161
|
+
To learn more about migrating from Webpack4, see: ${chalk12.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#webpack4-support-discontinued")}`),metaFramework==="nextjs"&&(dependenciesToRemove.includes("storybook-addon-next-router")&&(migrationSteps+=`- Migrate the usage of the ${chalk12.cyan("storybook-addon-next-router")} addon to use the APIs from the ${chalk12.magenta("@storybook/nextjs")} framework package instead. Follow the instructions below.`),frameworkPackage==="@storybook/react-vite"?disclaimer=dedent16`\n\n
|
|
162
|
+
${chalk12.bold("Important")}: We've detected you are using Storybook in a Next.js project.
|
|
163
|
+
|
|
164
|
+
This migration is set to update your project to use the ${chalk12.magenta("@storybook/react-vite")} framework, but Storybook provides a framework package specifically for Next.js projects: ${chalk12.magenta("@storybook/nextjs")}.
|
|
165
|
+
|
|
166
|
+
This package provides a better, out of the box 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. If you switch this project to use Webpack 5 and rerun this migration, we can update your project.
|
|
167
|
+
|
|
168
|
+
If you are interested in using this package, see: ${chalk12.yellow("https://github.com/storybookjs/storybook/blob/next/code/frameworks/nextjs/README.md")}
|
|
169
|
+
`:frameworkPackage==="@storybook/nextjs"&&(disclaimer=dedent16`\n\n
|
|
170
|
+
The ${chalk12.magenta("@storybook/nextjs")} package provides great user experience for Next.js users, and we highly recommend you to read more about it at ${chalk12.yellow("https://github.com/storybookjs/storybook/blob/next/code/frameworks/nextjs/README.md")}
|
|
171
|
+
`)),metaFramework==="sveltekit"&&(frameworkPackage==="@storybook/svelte-webpack5"?disclaimer=dedent16`\n\n
|
|
172
|
+
${chalk12.bold("Important")}: We've detected you are using Storybook in a SvelteKit project.
|
|
173
|
+
|
|
174
|
+
This migration is set to update your project to use the ${chalk12.magenta("@storybook/svelte-webpack5")} framework, but Storybook provides a framework package specifically for SvelteKit projects: ${chalk12.magenta("@storybook/sveltekit")}.
|
|
175
|
+
|
|
176
|
+
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 the Webpack builder.
|
|
177
|
+
|
|
178
|
+
If you are interested in using this package, see: ${chalk12.yellow("https://github.com/storybookjs/storybook/blob/next/code/frameworks/sveltekit/README.md")}
|
|
179
|
+
`:(migrationSteps+=`- Remove the ${chalk12.yellow(`${renderer}Options`)} field from ${chalk12.blue(mainConfigPath)}.
|
|
180
|
+
More info: ${chalk12.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#vite-builder-uses-vite-config-automatically")}
|
|
181
|
+
`,disclaimer=dedent16`\n\n
|
|
182
|
+
The ${chalk12.magenta("@storybook/sveltekit")} package provides great user experience for SvelteKit users, and we highly recommend you to read more about it at ${chalk12.yellow("https://github.com/storybookjs/storybook/blob/next/code/frameworks/sveltekit/README.md")}
|
|
183
|
+
`)),dedent16`
|
|
184
|
+
We've detected your project is not fully setup with Storybook's 7 new framework format.
|
|
183
185
|
|
|
184
|
-
|
|
186
|
+
Storybook 7 introduced the concept of frameworks, which abstracts configuration for renderers (e.g. React, Vue), builders (e.g. Webpack, Vite) and defaults to make integrations easier.
|
|
185
187
|
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
And set up the ${chalk14.magenta(frameworkPackage)} framework that already includes the builder.
|
|
188
|
+
Your project should be updated to use Storybook's framework: ${chalk12.magenta(frameworkPackage)}. We can attempt to do this for you automatically.
|
|
189
189
|
|
|
190
|
-
|
|
190
|
+
Here are the steps this migration will do to migrate your project:
|
|
191
|
+
${migrationSteps}
|
|
191
192
|
|
|
192
|
-
${
|
|
193
|
+
To learn more about the new framework format, see: ${chalk12.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md##new-framework-api")}${disclaimer}
|
|
194
|
+
`},async run({result:{dependenciesToAdd,dependenciesToRemove,frameworkPackage,frameworkOptions,builderInfo,packageJson,renderer,addonsToRemove},packageManager,dryRun,mainConfigPath,skipInstall}){if(dependenciesToRemove.length>0&&(logger13.info(`\u2705 Removing dependencies: ${dependenciesToRemove.join(", ")}`),dryRun||packageManager.removeDependencies({skipInstall:skipInstall||dependenciesToAdd.length>0,packageJson},dependenciesToRemove)),dependenciesToAdd.length>0&&(logger13.info(`\u2705 Installing new dependencies: ${dependenciesToAdd.join(", ")}`),!dryRun)){let versionToInstall=getStorybookVersionSpecifier(packageJson),depsToAdd=dependenciesToAdd.map(dep=>`${dep}@${versionToInstall}`);packageManager.addDependencies({installAsDevDependencies:!0,skipInstall,packageJson},depsToAdd)}await updateMainConfig({mainConfigPath,dryRun},async main=>{logger13.info("\u2705 Updating main.js"),logger13.info('\u2705 Updating "framework" field'),dryRun||main.setFieldValue(["framework","name"],frameworkPackage),dryRun||main.setFieldValue(["framework","options"],frameworkOptions),main.getFieldNode([`${renderer}Options`])&&(logger13.info(`\u2705 Moving "${renderer}Options" to "framework.options"`),dryRun||main.removeField([`${renderer}Options`])),main.getFieldNode(["core","builder"])&&(logger13.info('\u2705 Removing "core.builder" field'),dryRun||main.removeField(["core","builder"])),Object.keys(builderInfo.options).length>0&&(logger13.info('\u2705 Moving "core.builder.options" into "framework.options.builder"'),dryRun||main.setFieldValue(["framework","options","builder"],builderInfo.options));let currentCore=main.getFieldValue(["core"]);if(currentCore&&Object.keys(currentCore).length===0&&(logger13.info('\u2705 Removing "core" field'),dryRun||main.removeField(["core"])),addonsToRemove.length>0){let updatedAddons=main.getFieldValue(["addons"]).filter(addon=>typeof addon=="string"?!addonsToRemove.includes(addon):addon.name?!addonsToRemove.includes(addon.name):!1);logger13.info("\u2705 Removing unnecessary addons"),dryRun||main.setFieldValue(["addons"],updatedAddons)}})}};import chalk13 from"chalk";import dedent17 from"ts-dedent";import{getStorybookInfo as getStorybookInfo2}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,configDir}){let packageJson=packageManager.retrievePackageJson(),{previewConfig}=getStorybookInfo2(packageJson,configDir);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 dedent17`
|
|
195
|
+
${chalk13.bold(chalk13.red("Attention"))}: We could not automatically make this change. You'll need to do it manually.
|
|
193
196
|
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
If you were using Storybook's Webpack4 builder (default in 6.x, discontinued in 7.0), this could be a breaking
|
|
197
|
-
change -- especially if your project has a custom webpack configuration.
|
|
198
|
-
|
|
199
|
-
To learn more about migrating from Webpack4, see: ${chalk14.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#webpack4-support-discontinued")}
|
|
200
|
-
`},async run({result:{dependenciesToAdd,dependenciesToRemove,main,frameworkPackage,frameworkOptions,builderInfo,packageJson},packageManager,dryRun}){if(logger11.info(`\u2705 Removing legacy dependencies: ${dependenciesToRemove.join(", ")}`),dryRun||packageManager.removeDependencies({skipInstall:dependenciesToAdd.length>0,packageJson},dependenciesToRemove),dependenciesToAdd.length>0&&(logger11.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){logger11.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"])&&(logger11.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 chalk15 from"chalk";import dedent14 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",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 dedent14`
|
|
201
|
-
The following APIs (used in "${chalk15.yellow(previewPath)}") have been removed from Storybook:
|
|
197
|
+
The following APIs (used in "${chalk13.yellow(previewPath)}") have been removed from Storybook:
|
|
202
198
|
|
|
203
|
-
${usedAPIs.map(api=>`- ${
|
|
199
|
+
${usedAPIs.map(api=>`- ${chalk13.cyan(api)}`).join(`
|
|
204
200
|
`)}
|
|
205
201
|
|
|
206
|
-
You'll need to update "${chalk15.yellow(previewPath)}" manually.
|
|
207
|
-
|
|
208
202
|
Please see the migration guide for more information:
|
|
209
|
-
${
|
|
210
|
-
`}
|
|
211
|
-
We've found ${
|
|
203
|
+
${chalk13.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#removed-global-client-apis")}
|
|
204
|
+
`}};import chalk14 from"chalk";import{dedent as dedent18}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]},"")},logger14=console,mdx1to2={id:"mdx1to2",async check(){let storiesMdxFiles=await globby("./!(node_modules)**/*.(story|stories).mdx");return storiesMdxFiles.length?{storiesMdxFiles}:void 0},prompt({storiesMdxFiles}){return dedent18`
|
|
205
|
+
We've found ${chalk14.yellow(storiesMdxFiles.length)} '.stories.mdx' files in your project.
|
|
212
206
|
|
|
213
|
-
Storybook has upgraded to MDX2 (https://mdxjs.com/blog/v2/), which contains breaking changes from
|
|
214
|
-
|
|
207
|
+
Storybook has upgraded to MDX2 (https://mdxjs.com/blog/v2/), which contains breaking changes from MDX1.
|
|
215
208
|
We can try to automatically upgrade your MDX files to MDX2 format using some common patterns.
|
|
216
209
|
|
|
217
|
-
|
|
210
|
+
After this install completes, and before you start Storybook, we strongly recommend reading the MDX2 section
|
|
211
|
+
of the 7.0 migration guide. It contains useful tools for detecting and fixing any remaining issues.
|
|
218
212
|
|
|
219
|
-
${
|
|
220
|
-
`},async run({result:{storiesMdxFiles},dryRun}){await Promise.all(storiesMdxFiles.map(async fname=>{let contents=await
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
`
|
|
235
|
-
|
|
213
|
+
${chalk14.cyan("https://storybook.js.org/migration-guides/7.0")}
|
|
214
|
+
`},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?logger14.info(`\u{1F197} Unmodified ${basename(fname)}`):(logger14.info(`\u2705 Modified ${basename(fname)}`),dryRun||await fse4.writeFile(fname,updated))})])}};import chalk15 from"chalk";import{dedent as dedent19}from"ts-dedent";var logger15=console,autodocsTrue={id:"autodocsTrue",async check({packageManager,configDir}){let{mainConfig}=await getStorybookData({packageManager,configDir}),{docs}=mainConfig,docsPageToAutodocsMapping={true:"tag",automatic:!0,false:!1};if(docs?.docsPage){let oldValue=docs?.docsPage.toString();if(!(oldValue in docsPageToAutodocsMapping))throw new Error(`Unexpected value for docs.docsPage: ${oldValue}`);return{value:docsPageToAutodocsMapping[oldValue]}}return docs?.autodocs===void 0?{value:!0}:null},prompt({value}){let autodocsFormatted=chalk15.cyan(`docs: { autodocs: ${JSON.stringify(value??!0)} }`),tagWarning=dedent19`
|
|
215
|
+
NOTE: if you're upgrading from an older 7.0-beta using the 'docsPage' tag,
|
|
216
|
+
please update your story files to use the 'autodocs' tag instead.
|
|
217
|
+
`;return value?dedent19`
|
|
218
|
+
We've changed the configuration of autodocs (previous docsPage), so now the value:
|
|
219
|
+
- docs.autodocs: true -- means automatically create docs for every CSF file
|
|
220
|
+
- docs.autodocs: 'tag' -- means only create autodocs for CSF files with the 'autodocs' tag
|
|
221
|
+
- docs.autodocs: false -- means never create autodocs
|
|
222
|
+
|
|
223
|
+
Based on your prior configuration, we can set the \`docs.autodocs\` to keep your old behaviour:
|
|
224
|
+
|
|
225
|
+
${autodocsFormatted}
|
|
226
|
+
${value==="tag"?tagWarning:""}
|
|
227
|
+
More info: ${chalk15.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#autodocs-changes")}
|
|
228
|
+
`:dedent19`
|
|
229
|
+
We've detected that your main.js configuration file has not configured autodocs. In 6.x we
|
|
230
|
+
we defaulted to having a autodocs for every story, in 7.x you need to opt in per-component.
|
|
231
|
+
However, we can set the \`docs.autodocs\` to true to approximate the old behaviour:
|
|
232
|
+
|
|
233
|
+
${autodocsFormatted}
|
|
234
|
+
|
|
235
|
+
More info: ${chalk15.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#autodocs-changes")}
|
|
236
|
+
`},async run({result:{value},dryRun,mainConfigPath}){logger15.info("\u2705 Setting 'docs.autodocs' to true in main.js"),dryRun||await updateMainConfig({mainConfigPath,dryRun},async main=>{main.removeField(["docs","docsPage"]),main.setFieldValue(["docs","autodocs"],value??!0)})}};import chalk16 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=>chalk16.cyan(pkg2)).join(" & "),additionalDependenciesFormatted=additionalDependencies.map(pkg2=>`- ${chalk16.cyan(pkg2)}`).join(`
|
|
237
|
+
`);return dedent20`
|
|
238
|
+
We've detected that you're using ${dependentsFormatted}.
|
|
236
239
|
|
|
237
|
-
|
|
240
|
+
Starting in Storybook 7, we now require these peer dependencies to render docs:
|
|
241
|
+
|
|
242
|
+
${additionalDependenciesFormatted}
|
|
243
|
+
|
|
244
|
+
We can add these for you automatically as dev dependencies.
|
|
238
245
|
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
`),null;let builder=main.getFieldValue(["core","builder"]);return["@storybook/builder-vite","storybook-builder-vite"].includes(builder)?{main,packageJson,dependenciesToRemove:[builder]}:(logger14.warn(dedent17`
|
|
243
|
-
We've detected you are using Storybook in a SvelteKit project.
|
|
244
|
-
|
|
245
|
-
In Storybook 7, we introduced a new framework package for SvelteKit projects: @storybook/sveltekit.
|
|
246
|
-
|
|
247
|
-
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.
|
|
248
|
-
|
|
249
|
-
If you are interested in using this package, see: ${chalk18.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#sveltekit-needs-the-storybooksveltekit-framework")}
|
|
250
|
-
`),null)},prompt(){return dedent17`
|
|
251
|
-
We've detected you are using Storybook in a SvelteKit project.
|
|
246
|
+
More info: ${chalk16.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#react-peer-dependencies-required")}
|
|
247
|
+
`},async run({packageManager,result:{additionalDependencies},dryRun}){dryRun||packageManager.addDependencies({installAsDevDependencies:!0},additionalDependencies)}};import chalk17 from"chalk";import dedent21 from"ts-dedent";import semver14 from"semver";var nodeJsRequirement={id:"nodejs-requirement",promptOnly:!0,async check({packageManager,configDir}){let{storybookVersion}=await getStorybookData({packageManager,configDir});if(!semver14.gte(storybookVersion,"7.0.0"))return null;let nodeVersion=process.version;return semver14.lt(nodeVersion,"16.0.0")?{nodeVersion}:null},prompt({nodeVersion}){return dedent21`
|
|
248
|
+
${chalk17.bold(chalk17.red("Attention"))}: We could not automatically make this change. You'll need to do it manually.
|
|
252
249
|
|
|
253
|
-
|
|
254
|
-
This package is a replacement for @storybook/svelte-vite and provides a better experience for SvelteKit users.
|
|
250
|
+
We've detected that you're using Node ${chalk17.bold(nodeVersion)} but Storybook 7 only supports Node ${chalk17.bold("v16.0.0")} and higher. You will either need to upgrade your Node version or keep using an older version of Storybook.
|
|
255
251
|
|
|
256
|
-
|
|
252
|
+
Please see the migration guide for more information:
|
|
253
|
+
${chalk17.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-support-for-node-15-and-below")}
|
|
254
|
+
`}};import chalk18 from"chalk";import dedent22 from"ts-dedent";import semver15 from"semver";import{loadPartialConfigAsync}from"@babel/core";var logger16=console,frameworksThatNeedBabelConfig=["@storybook/react-webpack5","@storybook/vue-webpack5","@storybook/vue3-webpack5","@storybook/html-webpack5"],missingBabelRc={id:"missing-babelrc",async check({configDir,packageManager}){let packageJson=packageManager.retrievePackageJson(),{mainConfig,storybookVersion}=await getStorybookData({configDir,packageManager});if(!semver15.gte(storybookVersion,"7.0.0"))return null;let{framework,addons}=mainConfig,frameworkPackage=typeof framework=="string"?framework:framework.name,hasCraPreset=addons&&addons.find(addon=>addon==="@storybook/preset-create-react-app");if(frameworkPackage&&frameworksThatNeedBabelConfig.includes(frameworkPackage)&&!hasCraPreset){let config=await loadPartialConfigAsync({babelrc:!0,filename:"__fake__.js"});if(!config.config&&!config.babelrc&&!packageJson.babel)return{needsBabelRc:!0}}return null},prompt(){return dedent22`
|
|
255
|
+
We detected that your project does not have a babel configuration (.babelrc, babel.config.js, etc.).
|
|
257
256
|
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
257
|
+
In version 6.x, Storybook provided its own babel settings out of the box. Now, Storybook re-uses ${chalk18.bold("your project's babel configuration")}, with small, incremental updates from Storybook addons.
|
|
258
|
+
|
|
259
|
+
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.
|
|
260
|
+
|
|
261
|
+
We can create a ${chalk18.blue(".babelrc.json")} file with some basic configuration and add any necessary package devDependencies.
|
|
262
|
+
|
|
263
|
+
Please see the migration guide for more information:
|
|
264
|
+
${chalk18.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#babel-mode-v7-exclusively")}
|
|
265
|
+
`},async run(){logger16.info(),await generateStorybookBabelConfigInCWD()}};import chalk19 from"chalk";import dedent23 from"ts-dedent";import semver16 from"semver";var logger17=console,getNextGlob=glob=>{let extGlobsRegex=new RegExp(/(.*\.)(stories\.@.*)(\|mdx|mdx\|)(.*)$/i);if(glob.match(extGlobsRegex))return glob.replace(extGlobsRegex,"$1@(mdx|$2$4)");let allStoriesExtensionsRegex=new RegExp(/(.*\.)(stories\.\*)$/i);return glob.match(allStoriesExtensionsRegex)?glob.replace(allStoriesExtensionsRegex,"$1@(mdx|$2)"):glob.replaceAll(".stories.mdx",".mdx")},bareMdxStoriesGlob={id:"bare-mdx-stories-glob",async check({packageManager,configDir}){let{storybookVersion,mainConfig}=await getStorybookData({configDir,packageManager});if(!semver16.gte(storybookVersion,"7.0.0"))return null;let existingStoriesEntries=mainConfig.stories;if(!existingStoriesEntries)throw new Error(dedent23`
|
|
266
|
+
❌ Unable to determine Storybook stories globs in ${chalk19.blue(mainConfig)}, skipping ${chalk19.cyan(this.id)} fix.
|
|
262
267
|
|
|
263
|
-
|
|
268
|
+
In Storybook 7, we have deprecated defining stories in MDX files, and consequently have changed the suffix to simply .mdx.
|
|
264
269
|
|
|
265
|
-
|
|
270
|
+
We were unable to automatically migrate your 'stories' config to include any .mdx file instead of just .stories.mdx.
|
|
271
|
+
We suggest you make this change manually.
|
|
266
272
|
|
|
267
|
-
|
|
273
|
+
To learn more about this change, see: ${chalk19.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#mdx-docs-files")}
|
|
274
|
+
`);let nextStoriesEntries=existingStoriesEntries.map(entry=>{let isSpecifier=typeof entry!="string",glob=isSpecifier?entry.files:entry;if(!glob)return entry;let nextGlob=getNextGlob(glob);return isSpecifier?{...entry,files:nextGlob}:nextGlob});return existingStoriesEntries.length===nextStoriesEntries.length&&existingStoriesEntries.every((entry,index)=>{let nextEntry=nextStoriesEntries[index];return typeof entry=="string"?entry===nextEntry:typeof nextEntry=="string"?!1:entry.files===nextEntry.files})?null:{existingStoriesEntries,nextStoriesEntries}},prompt({existingStoriesEntries,nextStoriesEntries}){let prettyExistingStoriesEntries=existingStoriesEntries.map(entry=>JSON.stringify(entry,null,2)).join(`
|
|
275
|
+
`),prettyNextStoriesEntries=nextStoriesEntries.map(entry=>JSON.stringify(entry,null,2)).join(`
|
|
276
|
+
`);return dedent23`
|
|
277
|
+
We've detected your project has one or more globs in your 'stories' config that matches .stories.mdx files:
|
|
278
|
+
${chalk19.cyan(prettyExistingStoriesEntries)}
|
|
279
|
+
|
|
280
|
+
In Storybook 7, we have deprecated defining stories in MDX files, and consequently have changed the suffix to simply .mdx.
|
|
281
|
+
|
|
282
|
+
We can automatically migrate your 'stories' config to include any .mdx file instead of just .stories.mdx.
|
|
283
|
+
That would result in the following 'stories' config:
|
|
284
|
+
${chalk19.cyan(prettyNextStoriesEntries)}
|
|
285
|
+
|
|
286
|
+
To learn more about this change, see: ${chalk19.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#mdx-docs-files")}
|
|
287
|
+
`},async run({dryRun,mainConfigPath,result:{nextStoriesEntries}}){logger17.info(dedent23`✅ Setting 'stories' config:
|
|
288
|
+
${JSON.stringify(nextStoriesEntries,null,2)}`),dryRun||await updateMainConfig({mainConfigPath,dryRun},async main=>{main.setFieldValue(["stories"],nextStoriesEntries)})}};import{dedent as dedent24}from"ts-dedent";import semver17 from"semver";import chalk20 from"chalk";import prompts4 from"prompts";var angularBuilders={id:"angular-builders",async check({packageManager,configDir}){let packageJSON=packageManager.retrievePackageJson();if(isNxProject(packageJSON))return null;let angularVersion=packageManager.getAllDependencies()["@angular/core"],angularCoerced=semver17.coerce(angularVersion)?.version;if(!angularCoerced)return null;if(semver17.lt(angularCoerced,"14.0.0"))throw new Error(dedent24`
|
|
289
|
+
❌ Your project uses Angular < 14.0.0. Storybook 7.0 for Angular requires Angular 14.0.0 or higher.
|
|
290
|
+
Please upgrade your Angular version to at least version 14.0.0 to use Storybook 7.0 in your project.
|
|
291
|
+
`);let angularJSON=new AngularJSON,{hasStorybookBuilder}=angularJSON;if(hasStorybookBuilder||!angularJSON.rootProject&&Object.keys(angularJSON.projects).length>1)return null;let{mainConfig}=await getStorybookData({configDir,packageManager});return{mainConfig,packageManager}},prompt(){return dedent24`
|
|
292
|
+
We have detected that your project does not use the Storybook Angular builder yet. In Storybook 6.4 we have deprecated calling Storybook directly (npm run storybook) for Angular. In Storybook 7.0, we've removed it entirely.
|
|
268
293
|
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
${chalk20.bold("Migrations that succeeded:")}
|
|
294
|
+
In order to use the Storybook Angular builder, we need to add a few entries to your angular.json file. Additionally, we will add the @compodoc/compodoc package to your devDependencies if you want and we will add a few scripts to your package.json file.
|
|
295
|
+
|
|
296
|
+
Also feel free to remove the Compodoc script from your package.json file if you don't use it apart from Storybook anymore. Storybook uses Compodoc internally and you don't have to call in separately anymore.
|
|
273
297
|
|
|
274
|
-
${
|
|
298
|
+
Read more about the Angular builder here: ${chalk20.yellow("https://storybook.js.org/docs/angular/configure/storybook-builders")}
|
|
299
|
+
`},async run({result}){let angularJSON=new AngularJSON,{packageManager}=result,{useCompoDoc}=await prompts4({type:"confirm",name:"useCompoDoc",message:"Have you set up compodoc in Storybook previously?"}),angularProjectName=await angularJSON.getProjectName();angularJSON.addStorybookEntries({angularProjectName,storybookFolder:".storybook",useCompodoc:useCompoDoc,root:"."}),angularJSON.write(),packageManager.addScripts({storybook:`ng run ${angularProjectName}:storybook`,"build-storybook":`ng run ${angularProjectName}:build-storybook`})}};import{dedent as dedent25}from"ts-dedent";import semver18 from"semver";import chalk21 from"chalk";var angularBuildersMultiproject={id:"angular-builders-multiproject",promptOnly:!0,async check({packageManager,configDir}){let packageJSON=packageManager.retrievePackageJson();if(isNxProject(packageJSON))return null;let angularVersion=packageManager.getAllDependencies()["@angular/core"],angularCoerced=semver18.coerce(angularVersion)?.version;if(!angularCoerced||semver18.lt(angularCoerced,"14.0.0"))return null;let angularJSON=new AngularJSON,{hasStorybookBuilder}=angularJSON;return hasStorybookBuilder||angularJSON.rootProject||Object.keys(angularJSON.projects).length===1?null:{}},prompt(){return dedent25`
|
|
300
|
+
In Storybook 6.4 we have deprecated calling Storybook directly (npm run storybook) for Angular. In Storybook 7.0, we've removed it entirely. Instead you have to set up the Storybook builder in your ${chalk21.yellow("angular.json")} and execute ${chalk21.yellow("ng run <your-project>:storybook")} to start Storybook.
|
|
301
|
+
|
|
302
|
+
❌ Your Angular workspace uses multiple projects defined in the ${chalk21.yellow("angular.json")} file and we were not able to detect a root project. Therefore we are not able to automigrate to use Angular Storybook builder. Instead, please visit ${chalk21.yellow("https://github.com/storybookjs/storybook/tree/next/code/frameworks/angular")} to do the migration manually.
|
|
303
|
+
`}};var allFixes=[nodeJsRequirement,cra5,webpack5,angular12,vue3,eslintPlugin,builderVite,sbBinary,sbScripts,newFrameworks,removedGlobalClientAPIs,mdx1to2,mdxgfm,bareMdxStoriesGlob,autodocsTrue,addReact,missingBabelRc,angularBuildersMultiproject,angularBuilders],initFixes=[missingBabelRc,eslintPlugin];import{EOL}from"os";var ansiRegex=({onlyFirst=!1}={})=>{let pattern=["[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)","(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))"].join("|");return new RegExp(pattern,onlyFirst?void 0:"g")},cleanLog=str=>str.replace(ansiRegex(),"").replace(/╮│/g,`\u256E
|
|
304
|
+
\u2502`).replace(/││/g,`\u2502
|
|
305
|
+
\u2502`).replace(/│╰/g,`\u2502
|
|
306
|
+
\u2570`).replace(/⚠️ {2}failed to check/g,`${EOL}\u26A0\uFE0F failed to check`);var logger18=console,LOG_FILE_NAME="migration-storybook.log",LOG_FILE_PATH=join5(process.cwd(),LOG_FILE_NAME),TEMP_LOG_FILE_PATH="",originalStdOutWrite=process.stdout.write.bind(process.stdout),originalStdErrWrite=process.stderr.write.bind(process.stdout),augmentLogsToFile=()=>{TEMP_LOG_FILE_PATH=tempy.file({name:LOG_FILE_NAME});let logStream=createWriteStream(TEMP_LOG_FILE_PATH);process.stdout.write=d=>(originalStdOutWrite(d),logStream.write(cleanLog(d))),process.stderr.write=d=>logStream.write(cleanLog(d))},cleanup=()=>{process.stdout.write=originalStdOutWrite,process.stderr.write=originalStdErrWrite};var logAvailableMigrations=()=>{let availableFixes=allFixes.map(f=>chalk22.yellow(f.id)).join(", ");logger18.info(`
|
|
307
|
+
The following migrations are available: ${availableFixes}`)},automigrate=async({fixId,fixes:inputFixes,dryRun,yes,useNpm,packageManager:pkgMgr,list,configDir:userSpecifiedConfigDir,renderer:rendererPackage,skipInstall}={})=>{if(list)return logAvailableMigrations(),null;useNpm&&(useNpmWarning(),pkgMgr="npm");let selectedFixes=inputFixes||allFixes,fixes=fixId?selectedFixes.filter(f=>f.id===fixId):selectedFixes;if(fixId&&fixes.length===0)return logger18.info(`\u{1F4ED} No migrations found for ${chalk22.magenta(fixId)}.`),logAvailableMigrations(),null;augmentLogsToFile();let packageManager=JsPackageManagerFactory.getPackageManager({force:pkgMgr}),{configDir:inferredConfigDir,mainConfig:mainConfigPath,version:storybookVersion}=getStorybookInfo3(packageManager.retrievePackageJson(),userSpecifiedConfigDir);if(!(storybookVersion&&semver19.coerce(storybookVersion)?.version))return logger18.info(dedent26`
|
|
308
|
+
[Storybook automigrate] ❌ Unable to determine storybook version so the automigrations will be skipped.
|
|
309
|
+
🤔 Are you running automigrate from your project directory? Please specify your Storybook config directory with the --config-dir flag.
|
|
310
|
+
`),{preCheckFailure:"undetected_sb_version"};let configDir=userSpecifiedConfigDir||inferredConfigDir||".storybook";try{await loadMainConfig2({configDir})}catch(err){return err.message.includes("No configuration files have been found")?(logger18.info(dedent26`[Storybook automigrate] Could not find or evaluate your Storybook main.js config directory at ${chalk22.blue(configDir)} so the automigrations will be skipped. You might be running this command in a monorepo or a non-standard project structure. If that is the case, please rerun this command by specifying the path to your Storybook config directory via the --config-dir option.`),{preCheckFailure:"mainjs_not_found"}):(logger18.info(dedent26`[Storybook automigrate] ❌ Failed trying to evaluate ${chalk22.blue(mainConfigPath)} with the following error: ${err.message}`),logger18.info("Please fix the error and try again."),{preCheckFailure:"mainjs_evaluation_error"})}logger18.info("\u{1F50E} checking possible migrations..");let fixResults={},fixSummary={succeeded:[],failed:{},manual:[],skipped:[]};for(let i=0;i<fixes.length;i+=1){let f=fixes[i],result;try{result=await f.check({packageManager,configDir,rendererPackage})}catch(error){logger18.info(`\u26A0\uFE0F failed to check fix ${chalk22.bold(f.id)}`),logger18.error(`
|
|
311
|
+
${error.stack}`),fixSummary.failed[f.id]=error.message,fixResults[f.id]="check_failed"}if(result){logger18.info(`
|
|
312
|
+
\u{1F50E} found a '${chalk22.cyan(f.id)}' migration:`);let message=f.prompt(result);logger18.info(boxen(message,{borderStyle:"round",padding:1,borderColor:"#F1618C",title:f.promptOnly?"Manual migration detected":"Automigration detected"}));let runAnswer;try{if(dryRun)runAnswer={fix:!1};else if(yes)runAnswer={fix:!0},f.promptOnly&&(fixResults[f.id]="manual_succeeded",fixSummary.manual.push(f.id));else if(f.promptOnly){fixResults[f.id]="manual_succeeded",fixSummary.manual.push(f.id),logger18.info();let{shouldContinue}=await prompts5({type:"toggle",name:"shouldContinue",message:"Select continue once you have made the required changes, or quit to exit the migration process",initial:!0,active:"continue",inactive:"quit"},{onCancel:()=>{throw new Error}});if(!shouldContinue){fixResults[f.id]="manual_skipped";break}}else runAnswer=await prompts5({type:"confirm",name:"fix",message:`Do you want to run the '${chalk22.cyan(f.id)}' migration on your project?`,initial:!0},{onCancel:()=>{throw new Error}})}catch{break}if(!f.promptOnly)if(runAnswer.fix)try{await f.run({result,packageManager,dryRun,mainConfigPath,skipInstall}),logger18.info(`\u2705 ran ${chalk22.cyan(f.id)} migration`),fixResults[f.id]="succeeded",fixSummary.succeeded.push(f.id)}catch(error){fixResults[f.id]="failed",fixSummary.failed[f.id]=error.message,logger18.info(`\u274C error when running ${chalk22.cyan(f.id)} migration`),logger18.info(error),logger18.info()}else fixResults[f.id]="skipped",fixSummary.skipped.push(f.id)}else fixResults[f.id]=fixResults[f.id]||"unnecessary"}return Object.values(fixResults).some(r=>r==="failed"||r==="check_failed")?await move(TEMP_LOG_FILE_PATH,join5(process.cwd(),LOG_FILE_NAME),{overwrite:!0}):await remove(TEMP_LOG_FILE_PATH),logger18.info(),logger18.info(getMigrationSummary(fixResults,fixSummary,LOG_FILE_PATH)),logger18.info(),cleanup(),fixResults};function getMigrationSummary(fixResults,fixSummary,logFile){let hasNoFixes=Object.values(fixResults).every(r=>r==="unnecessary"),hasFailures=Object.values(fixResults).some(r=>r==="failed"||r==="check_failed"),title=hasNoFixes?"No migrations were applicable to your project":hasFailures?"Migration check ran with failures":"Migration check ran successfully",successfulFixesMessage=fixSummary.succeeded.length>0?`
|
|
313
|
+
${chalk22.bold("Successful migrations:")}
|
|
314
|
+
|
|
315
|
+
${fixSummary.succeeded.map(m=>chalk22.green(m)).join(", ")}
|
|
275
316
|
`:"",failedFixesMessage=Object.keys(fixSummary.failed).length>0?`
|
|
276
|
-
${
|
|
317
|
+
${chalk22.bold("Failed migrations:")}
|
|
277
318
|
${Object.entries(fixSummary.failed).reduce((acc,[id,error])=>`${acc}
|
|
278
|
-
${
|
|
319
|
+
${chalk22.redBright(id)}:
|
|
279
320
|
${error}
|
|
280
321
|
`,"")}
|
|
281
322
|
|
|
282
|
-
|
|
283
|
-
|
|
323
|
+
You can find the full logs in ${chalk22.cyan(logFile)}
|
|
324
|
+
`:"",manualFixesMessage=fixSummary.manual.length>0?`
|
|
325
|
+
${chalk22.bold("Manual migrations:")}
|
|
326
|
+
|
|
327
|
+
${fixSummary.manual.map(m=>fixResults[m]==="manual_succeeded"?chalk22.green(m):chalk22.blue(m)).join(", ")}
|
|
328
|
+
`:"",skippedFixesMessage=fixSummary.skipped.length>0?`
|
|
329
|
+
${chalk22.bold("Skipped migrations:")}
|
|
330
|
+
|
|
331
|
+
${fixSummary.skipped.map(m=>chalk22.cyan(m)).join(", ")}
|
|
332
|
+
`:"",summaryMessage=dedent26`
|
|
333
|
+
${successfulFixesMessage}${manualFixesMessage}${failedFixesMessage}${skippedFixesMessage}${hasNoFixes?"":`
|
|
284
334
|
\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500
|
|
285
335
|
|
|
286
|
-
`}If you'd like to run the migrations again, you can do so by running '${
|
|
336
|
+
`}If you'd like to run the migrations again, you can do so by running '${chalk22.cyan("npx storybook@next automigrate")}'
|
|
287
337
|
|
|
288
338
|
The automigrations try to migrate common patterns in your project, but might not contain everything needed to migrate to the latest version of Storybook.
|
|
289
339
|
|
|
290
|
-
Please check the changelog and migration guide for manual migrations and more information: ${
|
|
291
|
-
And reach out on Discord if you need help: ${
|
|
292
|
-
`;return boxen(summaryMessage,{borderStyle:"round",padding:1,title,borderColor:hasFailures?"red":"green"})}var
|
|
293
|
-
`)
|
|
294
|
-
`));case"
|
|
340
|
+
Please check the changelog and migration guide for manual migrations and more information: ${chalk22.yellow("https://storybook.js.org/migration-guides/7.0")}
|
|
341
|
+
And reach out on Discord if you need help: ${chalk22.yellow("https://discord.gg/storybook")}
|
|
342
|
+
`;return boxen(summaryMessage,{borderStyle:"round",padding:1,title,borderColor:hasFailures?"red":"green"})}var logger19=console,installStorybook=(projectType,packageManager,options)=>{let npmOptions={installAsDevDependencies:!0,skipInstall:options.skipInstall},packageJson;try{packageJson=packageManager.readPackageJson()}catch{}let language=detectLanguage(packageJson),pnp=detectPnp(),generatorOptions={language,builder:options.builder||detectBuilder(packageManager,projectType),linkable:!!options.linkable,pnp:pnp||options.usePnp};return(async()=>{switch(projectType){case"REACT_SCRIPTS":return REACT_SCRIPTS_default(packageManager,npmOptions,generatorOptions).then(commandLog('Adding Storybook support to your "Create React App" based project'));case"REACT":return REACT_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "React" app
|
|
343
|
+
`));case"REACT_NATIVE":return REACT_NATIVE_default(packageManager,npmOptions).then(commandLog(`Adding Storybook support to your "React Native" app
|
|
344
|
+
`));case"QWIK":return QWIK_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Qwik" app
|
|
295
345
|
`));case"WEBPACK_REACT":return WEBPACK_REACT_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Webpack React" app
|
|
296
346
|
`));case"REACT_PROJECT":return REACT_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "React" library
|
|
297
347
|
`));case"NEXTJS":return NEXTJS_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Next" app
|
|
298
348
|
`));case"SFC_VUE":return SFC_VUE_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Single File Components Vue" app
|
|
299
349
|
`));case"VUE":return VUE_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Vue" app
|
|
300
350
|
`));case"VUE3":return VUE3_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Vue 3" app
|
|
301
|
-
`));case"ANGULAR":return
|
|
302
|
-
`));case"EMBER":return EMBER_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Ember" app
|
|
351
|
+
`));case"ANGULAR":return commandLog(`Adding Storybook support to your "Angular" app
|
|
352
|
+
`),ANGULAR_default(packageManager,npmOptions,generatorOptions,options);case"EMBER":return EMBER_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Ember" app
|
|
303
353
|
`));case"MITHRIL":return MITHRIL_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Mithril" app
|
|
304
354
|
`));case"MARIONETTE":return MARIONETTE_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Marionette.js" app
|
|
305
355
|
`));case"MARKO":return MARKO_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Marko" app
|
|
@@ -312,117 +362,75 @@ ${error}
|
|
|
312
362
|
`));case"RAX":return RAX_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Rax" app
|
|
313
363
|
`));case"AURELIA":return AURELIA_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Aurelia" app
|
|
314
364
|
`));case"SERVER":return SERVER_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Server" app
|
|
315
|
-
`));case"
|
|
316
|
-
|
|
365
|
+
`));case"NX":return paddedLog("We have detected Nx in your project. Please use `nx g @nrwl/storybook:configuration` to add Storybook to your project."),paddedLog("For more information, please see https://nx.dev/packages/storybook"),Promise.reject();case"SOLID":return SOLID_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "SolidJS" app
|
|
366
|
+
`));case"UNSUPPORTED":return paddedLog("We detected a project type that we don't support yet."),paddedLog("If you'd like your framework to be supported, please let use know about it at https://github.com/storybookjs/storybook/issues"),logger19.log(),Promise.resolve();default:return paddedLog(`We couldn't detect your project type. (code: ${projectType})`),paddedLog("You can specify a project type explicitly via `sb init --type <type>`, see our docs on how to configure Storybook for your framework: https://storybook.js.org/docs/react/get-started/install"),logger19.log(),projectTypeInquirer(options,packageManager)}})().catch(ex=>{logger19.error(`
|
|
367
|
+
${chalk23.red(ex.stack)}`),process.exit(1)})},projectTypeInquirer=async(options,packageManager)=>{let manualAnswer=options.yes?!0:await prompts6([{type:"confirm",name:"manual",message:"Do you want to manually choose a Storybook project type to install?"}]);if(manualAnswer!==!0&&manualAnswer.manual){let frameworkAnswer=await prompts6([{type:"select",name:"manualFramework",message:"Please choose a project type from the following list:",choices:installableProjectTypes.map(type=>({title:type,value:type.toUpperCase()}))}]);return installStorybook(frameworkAnswer.manualFramework,packageManager,options)}return Promise.resolve()};async function doInitiate(options,pkg2){let{packageManager:pkgMgr}=options;options.useNpm&&(useNpmWarning(),pkgMgr="npm");let packageManager=JsPackageManagerFactory.getPackageManager({force:pkgMgr}),welcomeMessage="storybook init - the simplest way to add a Storybook to your project.";logger19.log(chalk23.inverse(`
|
|
317
368
|
${welcomeMessage}
|
|
318
|
-
`));let{default:updateNotifier}=await import("update-notifier");updateNotifier({pkg:pkg2,updateCheckInterval:1e3*60*60})
|
|
369
|
+
`));let{default:updateNotifier}=await import("simple-update-notifier");await updateNotifier({pkg:pkg2,updateCheckInterval:1e3*60*60});let projectType,projectTypeProvided=options.type,infoText=projectTypeProvided?`Installing Storybook for user specified project type: ${projectTypeProvided}`:"Detecting project type",done=commandLog(infoText),packageJson=packageManager.retrievePackageJson();try{projectTypeProvided?installableProjectTypes.includes(projectTypeProvided)?projectType=projectTypeProvided.toUpperCase():(done(`The provided project type was not recognized by Storybook: ${projectTypeProvided}`),logger19.log(`
|
|
319
370
|
The project types currently supported by Storybook are:
|
|
320
|
-
`),installableProjectTypes.sort().forEach(framework=>paddedLog(`- ${framework}`)),
|
|
371
|
+
`),installableProjectTypes.sort().forEach(framework=>paddedLog(`- ${framework}`)),logger19.log(),process.exit(1)):projectType=detect(packageJson,options)}catch(ex){done(ex.message),process.exit(1)}done();let storybookInstalled=isStorybookInstalled(packageJson,options.force);if(storybookInstalled&&projectType!=="ANGULAR"){logger19.log(),paddedLog("There seems to be a Storybook already available in this project."),paddedLog(`Apply following command to force:
|
|
372
|
+
`),codeLog(["sb init [options] -f"]),logger19.log();return}let installResult=await installStorybook(projectType,packageManager,options).catch(e=>{process.exit()});!options.skipInstall&&!storybookInstalled&&packageManager.installDependencies(),options.disableTelemetry||telemetry("init",{projectType}),projectType!=="REACT_NATIVE"&&await automigrate({yes:options.yes||process.env.CI==="true",packageManager:pkgMgr,fixes:initFixes}),logger19.log(`
|
|
373
|
+
For more information visit:`,chalk23.cyan("https://storybook.js.org")),projectType==="ANGULAR"?(logger19.log(`
|
|
321
374
|
To run your Storybook, type:
|
|
322
|
-
`),codeLog([
|
|
323
|
-
|
|
324
|
-
`),codeLog(["export {default} from '
|
|
375
|
+
`),codeLog([`ng run ${installResult.projectName}:storybook`])):projectType==="REACT_NATIVE"?(logger19.log(),logger19.log(chalk23.yellow(`NOTE: installation is not 100% automated.
|
|
376
|
+
`)),logger19.log(`To quickly run Storybook, replace contents of your app entry with:
|
|
377
|
+
`),codeLog(["export {default} from './.storybook';"]),logger19.log(`
|
|
378
|
+
Then to run your Storybook, type:
|
|
379
|
+
`),codeLog([packageManager.getRunCommand("start")]),logger19.log(`
|
|
325
380
|
For more in information, see the github readme:
|
|
326
|
-
`),
|
|
381
|
+
`),logger19.log(chalk23.cyan("https://github.com/storybookjs/react-native")),logger19.log()):(logger19.log(`
|
|
382
|
+
To run your Storybook, type:
|
|
383
|
+
`),codeLog([packageManager.getRunStorybookCommand()])),logger19.log()}async function initiate(options,pkg2){await withTelemetry("init",{cliOptions:options},()=>doInitiate(options,pkg2))}import path4 from"path";import fs4 from"fs";import{sync as spawnSync}from"cross-spawn";import{getStorybookInfo as getStorybookInfo4}from"@storybook/core-common";import{readConfig as readConfig3,writeConfig as writeConfig3}from"@storybook/csf-tools";var logger20=console,LEGACY_CONFIGS=["addons","config","presets"],postinstallAddon=async(addonName,isOfficialAddon)=>{let skipMsg=null;isOfficialAddon?fs4.existsSync(".storybook")?(skipMsg="no codmods found",LEGACY_CONFIGS.forEach(config=>{try{let codemod=__require.resolve(`${getPackageName(addonName,isOfficialAddon)}/postinstall/${config}.js`);commandLog(`Running postinstall script for ${addonName}`)();let configFile=path4.join(".storybook",`${config}.ts`);fs4.existsSync(configFile)||(configFile=path4.join(".storybook",`${config}.js`),fs4.existsSync(configFile)||fs4.writeFileSync(configFile,"","utf8")),spawnSync("npx",["jscodeshift","-t",codemod,configFile],{stdio:"inherit",shell:!0}),skipMsg=null}catch{}})):skipMsg="no .storybook config":skipMsg="unofficial addon",skipMsg&&commandLog(`Skipping postinstall for ${addonName}, ${skipMsg}`)()},getVersionSpecifier=addon=>{let groups=/^(...*)@(.*)$/.exec(addon);return groups?[groups[1],groups[2]]:[addon,void 0]};async function add(addon,options){let{packageManager:pkgMgr}=options;options.useNpm&&(useNpmWarning(),pkgMgr="npm");let packageManager=JsPackageManagerFactory.getPackageManager({force:pkgMgr}),packageJson=packageManager.retrievePackageJson(),[addonName,versionSpecifier]=getVersionSpecifier(addon),{mainConfig,version:storybookVersion}=getStorybookInfo4(packageJson);if(!mainConfig){logger20.error("Unable to find storybook main.js config");return}let main=await readConfig3(mainConfig),addons=main.getFieldValue(["addons"]);addons&&!Array.isArray(addons)&&logger20.error("Expected addons array in main.js config"),logger20.log(`Verifying ${addonName}`);let latestVersion=packageManager.latestVersion(addonName);latestVersion||logger20.error(`Unknown addon ${addonName}`);let isStorybookAddon=addonName.startsWith("@storybook/"),addonWithVersion=`${addonName}@${versionSpecifier||(isStorybookAddon?storybookVersion:latestVersion)}`;logger20.log(`Installing ${addonWithVersion}`),packageManager.addDependencies({installAsDevDependencies:!0},[addonWithVersion]),logger20.log(`Adding '${addon}' to main.js addons field.`);let updatedAddons=[...addons||[],addonName];main.setFieldValue(["addons"],updatedAddons),await writeConfig3(main),options.skipPostinstall||await postinstallAddon(addon,isStorybookAddon)}import{listCodemods,runCodemod}from"@storybook/codemod";async function migrate(migration,{glob,dryRun,list,rename,logger:logger27,parser}){if(list)listCodemods().forEach(key=>logger27.log(key));else if(migration)await runCodemod(migration,{glob,dryRun,logger:logger27,rename,parser});else throw new Error("Migrate: please specify a migration name or --list")}import path5 from"path";import{writeFile as writeFile2,stat}from"fs-extra";import puppeteerCore from"puppeteer-core";import express from"express";import getPort from"get-port";import{logger as logger21}from"@storybook/node-logger";var read=async url=>{let browser=await usePuppeteerBrowser(),page=await browser.newPage();await page.goto(url),await page.waitForFunction(`
|
|
327
384
|
(window.__STORYBOOK_PREVIEW__ && window.__STORYBOOK_PREVIEW__.extract && window.__STORYBOOK_PREVIEW__.extract()) ||
|
|
328
385
|
(window.__STORYBOOK_STORY_STORE__ && window.__STORYBOOK_STORY_STORE__.extract && window.__STORYBOOK_STORY_STORE__.extract())
|
|
329
|
-
`);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(
|
|
330
|
-
`).map(getStorybookVersion).filter(Boolean).filter(pkg2=>isCorePackage(pkg2.package));if(!storybookPackages.length){
|
|
331
|
-
> ${command2}
|
|
332
|
-
`);return}return logger20.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):(logger20.error(chalk22.red(`An error occurred while executing: \`${command2}\``)),logger20.log(errorMessage),reject(new Error(`command exited with code: ${code}: `)))})})},addPackageResolutions=async({cwd})=>{logger20.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})=>{logger20.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(`
|
|
333
|
-
`).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})=>{logger20.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})=>{logger20.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 logger20.error("\u{1F6A8} Creating tsconfig.json failed"),e}},doTask=async(task,options,condition=!0)=>{condition&&(await task(options),logger20.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};logger20.log(),logger20.info(`\u{1F3C3} Starting for ${name} ${version}`),logger20.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 logger21=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(logger21.info(boxen2(dedent20`
|
|
334
|
-
🤗 Welcome to ${chalk23.yellow("sb repro")}! 🤗
|
|
335
|
-
|
|
336
|
-
Create a ${chalk23.green("new project")} to minimally reproduce Storybook issues.
|
|
337
|
-
|
|
338
|
-
1. select an environment that most closely matches your project setup.
|
|
339
|
-
2. select a location for the reproduction, outside of your project.
|
|
340
|
-
|
|
341
|
-
After the reproduction is ready, we'll guide you through the next steps.
|
|
342
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),list){logger21.info("\u{1F308} Available templates"),Object.entries(RENDERERS).forEach(([r,templates])=>{logger21.info(r),templates.forEach(t=>logger21.info(`- ${t.name}`)),r==="other"&&logger21.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);logger21.info(`\u{1F3C3} Running ${selectedTemplate} into ${cwd}`),await createAndInit(cwd,selectedConfig,{registry,e2e:!!e2e,pnp:!!pnp,local:!!local}),e2e||await initGitRepo(cwd),logger21.info(boxen2(dedent20`
|
|
343
|
-
🎉 Your Storybook reproduction project is ready to use! 🎉
|
|
344
|
-
|
|
345
|
-
${chalk23.yellow(`cd ${selectedDirectory}`)}
|
|
346
|
-
${chalk23.yellow("yarn storybook")}
|
|
347
|
-
|
|
348
|
-
Once you've recreated the problem you're experiencing, please:
|
|
349
|
-
|
|
350
|
-
1. Document any additional steps in ${chalk23.cyan("README.md")}
|
|
351
|
-
2. Publish the repository to github
|
|
352
|
-
3. Link to the repro repository in your issue
|
|
353
|
-
|
|
354
|
-
Having a clean repro helps us solve your issue faster! 🙏
|
|
355
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}))}catch(error){throw logger21.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 chalk24 from"chalk";import boxen3 from"boxen";import{dedent as dedent21}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
|
+
`);let data=JSON.parse(await page.evaluate(async()=>JSON.stringify(window.__STORYBOOK_STORY_STORE__.getStoriesJsonData(),null,2)));return setImmediate(()=>{browser.close()}),data},useLocation=async input=>{if(await stat(path5.resolve(input)),input.match(/^http/))return[input,async()=>{}];let app=express();app.use(express.static(input));let port=await getPort();return new Promise(resolve=>{let server=app.listen(port,()=>{let result=`http://localhost:${port}/iframe.html`;logger21.info(`connecting to: ${result}`),resolve([result,server.close.bind(server)])})})},usePuppeteerBrowser=async()=>{let args=["--no-sandbox ","--disable-setuid-sandbox"];try{return await puppeteerCore.launch({args,executablePath:process.env.SB_CHROMIUM_PATH})}catch{return logger21.info("installing puppeteer..."),new Promise((resolve,reject)=>{__require("child_process").exec(`node ${__require.resolve(path5.join("puppeteer-core","install.js"))}`,error=>error?reject(error):resolve(puppeteerCore.launch({args})))})}};async function extract(input,targetPath){if(input&&targetPath){let[location,exit]=await useLocation(input),data=await read(location);await writeFile2(targetPath,JSON.stringify(data,null,2)),await exit()}else throw new Error("Extract: please specify a path where your built-storybook is (can be a public url) and a target directory")}import{sync as spawnSync2}from"cross-spawn";import{telemetry as telemetry2,getStorybookCoreVersion}from"@storybook/telemetry";import semver20 from"semver";import{logger as logger22}from"@storybook/node-logger";import{withTelemetry as withTelemetry2}from"@storybook/core-server";var versionRegex=/(@storybook\/[^@]+)@(\S+)/,getStorybookVersion=line=>{if(line.startsWith("npm "))return null;let match=versionRegex.exec(line);return!match||!semver20.clean(match[2])?null:{package:match[1],version:match[2]}},isCorePackage=pkg2=>versions_default[pkg2]!==void 0,deprecatedPackages=[{minVersion:"6.0.0-alpha.0",url:"https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#60-deprecations",deprecations:["@storybook/addon-notes","@storybook/addon-info","@storybook/addon-contexts","@storybook/addon-options","@storybook/addon-centered"]}],formatPackage=pkg2=>`${pkg2.package}@${pkg2.version}`,warnPackages=pkgs=>pkgs.forEach(pkg2=>logger22.warn(`- ${formatPackage(pkg2)}`)),checkVersionConsistency=()=>{let storybookPackages=spawnSync2("npm",["ls"],{stdio:"pipe",shell:!0}).output.toString().split(`
|
|
387
|
+
`).map(getStorybookVersion).filter(Boolean).filter(pkg2=>isCorePackage(pkg2.package));if(!storybookPackages.length){logger22.warn("No storybook core packages found."),logger22.warn("'npm ls | grep storybook' can show if multiple versions are installed.");return}storybookPackages.sort((a,b)=>semver20.rcompare(a.version,b.version));let latestVersion=storybookPackages[0].version,outdated=storybookPackages.filter(pkg2=>pkg2.version!==latestVersion);outdated.length>0&&(logger22.warn(`Found ${outdated.length} outdated packages (relative to '${formatPackage(storybookPackages[0])}')`),logger22.warn("Please make sure your packages are updated to ensure a consistent experience."),warnPackages(outdated)),deprecatedPackages.forEach(({minVersion,url,deprecations})=>{if(semver20.gte(latestVersion,minVersion)){let deprecated=storybookPackages.filter(pkg2=>deprecations.includes(pkg2.package));deprecated.length>0&&(logger22.warn(`Found ${deprecated.length} deprecated packages since ${minVersion}`),logger22.warn(`See ${url}`),warnPackages(deprecated))}})},EXTRA_FLAGS={"react-scripts@<5":["--reject","/preset-create-react-app/"]},addExtraFlags=(extraFlags,flags,{dependencies,devDependencies})=>Object.entries(extraFlags).reduce((acc,entry)=>{let[pattern,extra]=entry,[pkg2,specifier]=getPackageDetails(pattern),pkgVersion=dependencies[pkg2]||devDependencies[pkg2];return pkgVersion&&semver20.satisfies(semver20.coerce(pkgVersion),specifier)?[...acc,...extra]:acc},[...flags]),NON_CANARY_REGEX=/^(\^|~|>|>=)?([0-9]+)\.([0-9]+)\.([0-9]+)(-([a-z]+\.)?[0-9]+)?$/,doUpgrade=async({tag,prerelease,skipCheck,useNpm,packageManager:pkgMgr,dryRun,configDir,yes,...options})=>{useNpm&&(useNpmWarning(),pkgMgr="npm");let packageManager=JsPackageManagerFactory.getPackageManager({force:pkgMgr}),beforeVersion=await getStorybookCoreVersion();if(commandLog("Checking for latest versions of '@storybook/*' packages"),tag&&prerelease)throw new Error("Cannot set both --tag and --prerelease. Use --tag next to get the latest prereleae");let flags=[],target="latest";prerelease?(target="greatest",flags.push(`--filterVersion "${NON_CANARY_REGEX.toString()}"`)):tag&&(target=`@${tag}`),dryRun||flags.push("--upgrade"),flags.push("--target"),flags.push(target),flags=addExtraFlags(EXTRA_FLAGS,flags,packageManager.retrievePackageJson());let check=spawnSync2("npx",["npm-check-updates@latest","/storybook/",...flags],{stdio:"pipe",shell:!0}).output.toString();logger22.info(check);let checkSb=spawnSync2("npx",["npm-check-updates@latest","sb",...flags],{stdio:"pipe",shell:!0}).output.toString();logger22.info(checkSb),dryRun||(commandLog("Installing upgrades"),packageManager.installDependencies());let automigrationResults;if(skipCheck||(checkVersionConsistency(),automigrationResults=await automigrate({dryRun,yes,packageManager:pkgMgr,configDir})),!options.disableTelemetry){let afterVersion=await getStorybookCoreVersion(),{preCheckFailure,...results}=automigrationResults||{};telemetry2("upgrade",{prerelease,tag,beforeVersion,afterVersion,...{automigrationResults:preCheckFailure?null:results,automigrationPreCheckFailure:preCheckFailure||null}})}};async function upgrade(options){await withTelemetry2("upgrade",{cliOptions:options},()=>doUpgrade(options))}import prompts7 from"prompts";import path6 from"path";import chalk24 from"chalk";import boxen2 from"boxen";import{dedent as dedent27}from"ts-dedent";import{downloadTemplate}from"giget";import{existsSync,readdir}from"fs-extra";var baseTemplates={"cra/default-js":{name:"Create React App (Javascript)",script:"npx create-react-app .",expected:{framework:"@storybook/react-webpack5",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"}},"cra/default-ts":{name:"Create React App (Typescript)",script:"npx create-react-app . --template typescript",skipTasks:["smoke-test"],expected:{framework:"@storybook/react-webpack5",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"}},"nextjs/12-js":{name:"Next.js v12 (JavaScript)",script:'yarn create next-app {{beforeDir}} -e https://github.com/vercel/next.js/tree/next-12-3-2/examples/hello-world && cd {{beforeDir}} && npm pkg set "dependencies.next"="^12.2.0" && yarn && git add . && git commit --amend --no-edit && cd ..',expected:{framework:"@storybook/nextjs",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"}},"nextjs/default-js":{name:"Next.js (JavaScript)",script:"yarn create next-app {{beforeDir}} --javascript --eslint",expected:{framework:"@storybook/nextjs",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"}},"nextjs/default-ts":{name:"Next.js (TypeScript)",script:"yarn create next-app {{beforeDir}} --typescript --eslint",expected:{framework:"@storybook/nextjs",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"}},"react-vite/default-js":{name:"React Vite (JS)",script:"yarn create vite . --template react",expected:{framework:"@storybook/react-vite",renderer:"@storybook/react",builder:"@storybook/builder-vite"}},"react-vite/default-ts":{name:"React Vite (TS)",script:"yarn create vite . --template react-ts",expected:{framework:"@storybook/react-vite",renderer:"@storybook/react",builder:"@storybook/builder-vite"}},"react-webpack/18-ts":{name:"React 18 Webpack5 (TS)",script:"yarn create webpack5-react .",expected:{framework:"@storybook/react-webpack5",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"}},"react-webpack/17-ts":{name:"React 17 Webpack5 (TS)",script:'yarn create webpack5-react . --version-react="17" --version-react-dom="17"',expected:{framework:"@storybook/react-webpack5",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"}},"solid-vite/default-js":{name:"SolidJS Vite (JS)",script:"npx degit solidjs/templates/js .",expected:{framework:"storybook-solidjs-vite",renderer:"storybook-solidjs",builder:"@storybook/builder-vite"},inDevelopment:!0},"solid-vite/default-ts":{name:"SolidJS Vite (TS)",script:"npx degit solidjs/templates/ts .",expected:{framework:"storybook-solidjs-vite",renderer:"storybook-solidjs",builder:"@storybook/builder-vite"},inDevelopment:!0},"vue3-vite/default-js":{name:"Vue3 Vite (JS)",script:"yarn create vite . --template vue",expected:{framework:"@storybook/vue3-vite",renderer:"@storybook/vue3",builder:"@storybook/builder-vite"}},"vue3-vite/default-ts":{name:"Vue3 Vite (TS)",script:"yarn create vite . --template vue-ts",expected:{framework:"@storybook/vue3-vite",renderer:"@storybook/vue3",builder:"@storybook/builder-vite"}},"vue2-vite/2.7-js":{name:"Vue2 Vite (vue 2.7 JS)",script:`yarn create vite . --template vanilla && yarn add --dev @vitejs/plugin-vue2 vue-template-compiler vue@2 && echo "import vue2 from '@vitejs/plugin-vue2';
|
|
356
388
|
|
|
357
389
|
export default {
|
|
358
390
|
plugins: [vue2()]
|
|
359
|
-
};" > 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"}
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
After filtering all the templates with "${chalk24.yellow(filterValue)}", we found no results. Please try again with a different filter.
|
|
391
|
+
};" > vite.config.js`,skipTasks:["smoke-test"],expected:{framework:"@storybook/vue-vite",renderer:"@storybook/vue",builder:"@storybook/builder-vite"}},"html-webpack/default":{name:"HTML Webpack5",script:"yarn create webpack5-html .",expected:{framework:"@storybook/html-webpack5",renderer:"@storybook/html",builder:"@storybook/builder-webpack5"}},"html-vite/default-js":{name:"HTML Vite JS",script:'yarn create vite . --template vanilla && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/html-vite",renderer:"@storybook/html",builder:"@storybook/builder-vite"}},"html-vite/default-ts":{name:"HTML Vite TS",script:'yarn create vite . --template vanilla-ts && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/html-vite",renderer:"@storybook/html",builder:"@storybook/builder-vite"}},"svelte-vite/default-js":{name:"Svelte Vite (JS)",script:"yarn create vite . --template svelte",expected:{framework:"@storybook/svelte-vite",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"}},"svelte-vite/default-ts":{name:"Svelte Vite (TS)",script:"yarn create vite . --template svelte-ts",skipTasks:["smoke-test"],expected:{framework:"@storybook/svelte-vite",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"}},"angular-cli/default-ts":{name:"Angular CLI (latest)",script:"npx -p @angular/cli ng new angular-latest --directory . --routing=true --minimal=true --style=scss --strict --skip-git --skip-install --package-manager=yarn",expected:{framework:"@storybook/angular",renderer:"@storybook/angular",builder:"@storybook/builder-webpack5"}},"angular-cli/14-ts":{name:"Angular CLI (Version 14)",script:"npx -p @angular/cli@14 ng new angular-v14 --directory . --routing=true --minimal=true --style=scss --strict --skip-git --skip-install --package-manager=yarn",expected:{framework:"@storybook/angular",renderer:"@storybook/angular",builder:"@storybook/builder-webpack5"}},"svelte-kit/skeleton-js":{name:"Svelte Kit (JS)",script:"yarn create svelte-with-args --name=svelte-kit/skeleton-js --directory=. --template=skeleton --types=null --no-prettier --no-eslint --no-playwright --no-vitest",expected:{framework:"@storybook/sveltekit",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"}},"svelte-kit/skeleton-ts":{name:"Svelte Kit (TS)",script:"yarn create svelte-with-args --name=svelte-kit/skeleton-ts --directory=. --template=skeleton --types=typescript --no-prettier --no-eslint --no-playwright --no-vitest",expected:{framework:"@storybook/sveltekit",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"}},"lit-vite/default-js":{name:"Lit Vite (JS)",script:"yarn create vite . --template lit",skipTasks:["smoke-test"],expected:{framework:"@storybook/web-components-vite",renderer:"@storybook/web-components",builder:"@storybook/builder-vite"}},"lit-vite/default-ts":{name:"Lit Vite (TS)",script:"yarn create vite . --template lit-ts",skipTasks:["smoke-test"],expected:{framework:"@storybook/web-components-vite",renderer:"@storybook/web-components",builder:"@storybook/builder-vite"}},"vue-cli/default-js":{name:"Vue-CLI (Default JS)",script:"npx -p @vue/cli vue create . --default --packageManager=yarn --force --merge",skipTasks:["smoke-test"],expected:{framework:"@storybook/vue3-webpack5",renderer:"@storybook/vue3",builder:"@storybook/builder-webpack5"}},"vue-cli/vue2-default-js":{name:"Vue-CLI (Vue2 JS)",script:'npx -p @vue/cli vue create . --default --packageManager=yarn --force --merge --preset="Default (Vue 2)"',skipTasks:["smoke-test"],expected:{framework:"@storybook/vue-webpack5",renderer:"@storybook/vue",builder:"@storybook/builder-webpack5"}},"preact-webpack5/default-js":{name:"Preact CLI (Default JS)",script:"npx preact-cli create default {{beforeDir}} --name preact-app --yarn --no-install",expected:{framework:"@storybook/preact-webpack5",renderer:"@storybook/preact",builder:"@storybook/builder-webpack5"}},"preact-webpack5/default-ts":{name:"Preact CLI (Default TS)",script:"npx preact-cli create typescript {{beforeDir}} --name preact-app --yarn --no-install",expected:{framework:"@storybook/preact-webpack5",renderer:"@storybook/preact",builder:"@storybook/builder-webpack5"}},"preact-vite/default-js":{name:"Preact Vite (JS)",script:"yarn create vite . --template preact",expected:{framework:"@storybook/preact-vite",renderer:"@storybook/preact",builder:"@storybook/builder-vite"}},"preact-vite/default-ts":{name:"Preact Vite (TS)",script:"yarn create vite . --template preact-ts",expected:{framework:"@storybook/preact-vite",renderer:"@storybook/preact",builder:"@storybook/builder-vite"}},"qwik-vite/default-ts":{name:"Qwik CLI (Default TS)",script:"yarn create qwik basic {{beforeDir}} --no-install",skipTasks:["e2e-tests"],inDevelopment:!0,expected:{framework:"storybook-framework-qwik",renderer:"storybook-framework-qwik",builder:"storybook-framework-qwik"}}},internalTemplates={"internal/ssv6-vite":{...baseTemplates["react-vite/default-ts"],name:"StoryStore v6 (react-vite/default-ts)",isInternal:!0,modifications:{mainConfig:{features:{storyStoreV7:!1,storyStoreV7MdxErrors:!1}}}},"internal/ssv6-webpack":{...baseTemplates["react-webpack/18-ts"],name:"StoryStore v6 (react-webpack/18-ts)",isInternal:!0,modifications:{mainConfig:{features:{storyStoreV7:!1,storyStoreV7MdxErrors:!1}}}},"internal/pnp":{...baseTemplates["react-webpack/18-ts"],name:"PNP (react-webpack/18-ts)",script:"yarn create react-app . --use-pnp",isInternal:!0,inDevelopment:!0}},allTemplates={...baseTemplates,...internalTemplates},ci=["cra/default-ts","react-vite/default-ts"],pr=[...ci,"angular-cli/default-ts","vue3-vite/default-ts","vue-cli/vue2-default-js","lit-vite/default-ts","svelte-vite/default-ts","svelte-kit/skeleton-ts","nextjs/default-ts"],merged=[...pr,"react-webpack/18-ts","react-webpack/17-ts","angular-cli/14-ts","preact-webpack5/default-ts","preact-vite/default-ts","html-webpack/default","html-vite/default-ts","internal/ssv6-vite","internal/ssv6-webpack"],daily=[...merged,"cra/default-js","react-vite/default-js","vue3-vite/default-js","vue2-vite/2.7-js","vue-cli/default-js","lit-vite/default-js","svelte-kit/skeleton-js","svelte-vite/default-js","nextjs/12-js","nextjs/default-js","qwik-vite/default-ts","preact-webpack5/default-js","preact-vite/default-js","html-vite/default-js"];var logger23=console,toChoices=c=>({title:allTemplates[c].name,value:c}),sandbox=async({output:outputDirectory,filterValue,branch,init})=>{let selectedConfig=allTemplates[filterValue],selectedTemplate=selectedConfig?filterValue:null;if(!selectedConfig){let filterRegex=new RegExp(`^${filterValue||""}`,"i"),keys=Object.keys(allTemplates),choices=keys.reduce((acc,group)=>{let current=allTemplates[group];return(!filterValue||current.name.match(filterRegex)||group.match(filterRegex)||current.expected.builder.match(filterRegex)||current.expected.framework.match(filterRegex)||current.expected.renderer.match(filterRegex))&&acc.push(group),acc},[]);if(choices.length===0&&(logger23.info(boxen2(dedent27`
|
|
392
|
+
🔎 You filtered out all templates. 🔍
|
|
363
393
|
|
|
364
|
-
|
|
365
|
-
|
|
394
|
+
After filtering all the templates with "${chalk24.yellow(filterValue)}", we found no results. Please try again with a different filter.
|
|
395
|
+
|
|
396
|
+
Available templates:
|
|
397
|
+
${keys.map(key=>chalk24.blue`- ${key}`).join(`
|
|
366
398
|
`)}
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
399
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),process.exit(1)),choices.length===1?[selectedTemplate]=choices:(logger23.info(boxen2(dedent27`
|
|
400
|
+
🤗 Welcome to ${chalk24.yellow("sb sandbox")}! 🤗
|
|
401
|
+
|
|
402
|
+
Create a ${chalk24.green("new project")} to minimally reproduce Storybook issues.
|
|
403
|
+
|
|
404
|
+
1. select an environment that most closely matches your project setup.
|
|
405
|
+
2. select a location for the reproduction, outside of your project.
|
|
406
|
+
|
|
407
|
+
After the reproduction is ready, we'll guide you through the next steps.
|
|
408
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),selectedTemplate=await promptSelectedTemplate(choices)),!!!(selectedTemplate??null)){logger23.error("Somehow we got no templates. Please rerun this command!");return}if(selectedConfig=allTemplates[selectedTemplate],!selectedConfig)throw new Error("\u{1F6A8} Sandbox: please specify a valid template type")}let selectedDirectory=outputDirectory,outputDirectoryName=outputDirectory||selectedTemplate;if(selectedDirectory&&existsSync(`${selectedDirectory}`)&&logger23.info(`\u26A0\uFE0F ${selectedDirectory} already exists! Overwriting...`),!selectedDirectory){let{directory}=await prompts7({type:"text",message:"Enter the output directory",name:"directory",initial:outputDirectoryName,validate:async directoryName=>existsSync(directoryName)?`${directoryName} already exists. Please choose another name.`:!0},{onCancel:()=>{logger23.log("Command cancelled by the user. Exiting..."),process.exit(1)}});selectedDirectory=directory}try{let templateDestination=path6.isAbsolute(selectedDirectory)?selectedDirectory:path6.join(process.cwd(),selectedDirectory);logger23.info(`\u{1F3C3} Adding ${selectedConfig.name} into ${templateDestination}`),logger23.log("\u{1F4E6} Downloading sandbox template...");try{let gitPath=`github:storybookjs/sandboxes/${selectedTemplate}/${init?"after-storybook":"before-storybook"}#${branch}`;if(await downloadTemplate(gitPath,{force:!0,dir:templateDestination}),(await readdir(templateDestination)).length===0)throw new Error(dedent27`Template downloaded from ${chalk24.blue(gitPath)} is empty.
|
|
409
|
+
Are you use it exists? Or did you want to set ${chalk24.yellow(selectedTemplate)} to inDevelopment first?`)}catch(err){throw logger23.error(`\u{1F6A8} Failed to download sandbox template: ${err.message}`),err}let initMessage=init?chalk24.yellow(`yarn install
|
|
410
|
+
yarn storybook`):`Recreate your setup, then ${chalk24.yellow("run npx storybook init")}`;logger23.info(boxen2(dedent27`
|
|
378
411
|
🎉 Your Storybook reproduction project is ready to use! 🎉
|
|
379
412
|
|
|
380
413
|
${chalk24.yellow(`cd ${selectedDirectory}`)}
|
|
381
414
|
${initMessage}
|
|
382
415
|
|
|
383
416
|
Once you've recreated the problem you're experiencing, please:
|
|
384
|
-
|
|
417
|
+
|
|
385
418
|
1. Document any additional steps in ${chalk24.cyan("README.md")}
|
|
386
419
|
2. Publish the repository to github
|
|
387
420
|
3. Link to the repro repository in your issue
|
|
388
421
|
|
|
389
422
|
Having a clean repro helps us solve your issue faster! 🙏
|
|
390
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}))}catch(error){throw
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
It seems that you haven't run Storybook's CLI to upgrade to the latest version.
|
|
395
|
-
The upgrade command will install the required peer dependencies for you and will take
|
|
396
|
-
care of other important auto migrations as well.
|
|
397
|
-
|
|
398
|
-
If you want to upgrade to the latest prerelease version, please run:
|
|
399
|
-
|
|
400
|
-
$ npx storybook@next upgrade --prerelease
|
|
401
|
-
|
|
402
|
-
Otherwise, please run:
|
|
403
|
-
|
|
404
|
-
$ npx storybook upgrade
|
|
405
|
-
|
|
406
|
-
If you do not want to use the upgrade commands,
|
|
407
|
-
please install react and react-dom in your project manually.
|
|
408
|
-
|
|
409
|
-
npm:
|
|
410
|
-
$ npm add react react-dom --dev
|
|
411
|
-
|
|
412
|
-
yarn:
|
|
413
|
-
$ yarn add react react-dom --dev
|
|
414
|
-
|
|
415
|
-
pnpm:
|
|
416
|
-
$ pnpm add react react-dom --dev
|
|
417
|
-
`),process.exit(1)}}var dev=async cliOptions=>{process.env.NODE_ENV=process.env.NODE_ENV||"development",ensureReactPeerDeps();try{let options={...cliOptions,configDir:cliOptions.configDir||"./.storybook",configType:"DEVELOPMENT",ignorePreview:!!cliOptions.previewUrl&&!cliOptions.forceBuildPreview,docsMode:!!cliOptions.docs,cache,packageJson:readUpSync({cwd:__dirname}).packageJson};await withTelemetry3("dev",{cliOptions,presetOptions:options},()=>buildDevStandalone(options))}catch(error){npmLog.heading="",error instanceof Error?error.error?logger25.error(error.error):error.stats&&error.stats.compilation.errors?error.stats.compilation.errors.forEach(e=>logger25.plain(e)):logger25.error(error):error.compilation?.errors&&error.compilation.errors.forEach(e=>logger25.plain(e)),logger25.line(),logger25.warn(error.close?dedent23`
|
|
423
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}))}catch(error){throw logger23.error("\u{1F6A8} Failed to create sandbox"),error}};async function promptSelectedTemplate(choices){let{template}=await prompts7({type:"select",message:"\u{1F308} Select the template",name:"template",choices:choices.map(toChoices)},{onCancel:()=>{logger23.log("Command cancelled by the user. Exiting..."),process.exit(1)}});return template||null}import fse5 from"fs-extra";import path7 from"path";import{sync as spawnSync3}from"cross-spawn";import{logger as logger24}from"@storybook/node-logger";import shell from"shelljs";import chalk25 from"chalk";var exec=async(command2,options={},{startMessage,errorMessage,dryRun}={})=>{if(startMessage&&logger24.info(startMessage),dryRun){logger24.info(`
|
|
424
|
+
> ${command2}
|
|
425
|
+
`);return}return logger24.info(command2),new Promise((resolve,reject)=>{let defaultOptions2={silent:!1},child=shell.exec(command2,{...defaultOptions2,...options,async:!0,silent:!1});child.stderr.pipe(process.stderr),child.on("exit",code=>{code===0?resolve(void 0):(logger24.error(chalk25.red(`An error occurred while executing: \`${command2}\``)),logger24.info(errorMessage),reject(new Error(`command exited with code: ${code}: `)))})})},link=async({target,local,start})=>{let storybookDir=process.cwd();try{if((await fse5.readJSON("package.json")).name!=="@storybook/root")throw new Error}catch{throw new Error("Expected to run link from the root of the storybook monorepo")}let reproDir=target,reproName=path7.basename(target);if(!local){let reprosDir=path7.join(storybookDir,"../storybook-repros");logger24.info(`Ensuring directory ${reprosDir}`),await fse5.ensureDir(reprosDir),logger24.info(`Cloning ${target}`),await exec(`git clone ${target}`,{cwd:reprosDir}),reproName=path7.basename(target,path7.extname(target)),reproDir=path7.join(reprosDir,reproName)}let reproPackageJson=await fse5.readJSON(path7.join(reproDir,"package.json")),version=spawnSync3("yarn",["--version"],{cwd:reproDir,stdio:"pipe",shell:!0}).stdout.toString();if(!/^[23]\./.test(version)){logger24.warn(`\u{1F6A8} Expected yarn 2 or 3 in ${reproDir}!`),logger24.warn(""),logger24.warn("Please set it up with `yarn set version berry`,"),logger24.warn(`then link '${reproDir}' with the '--local' flag.`);return}logger24.info(`Linking ${reproDir}`),await exec(`yarn link --all ${storybookDir}`,{cwd:reproDir}),logger24.info(`Installing ${reproName}`),await exec("yarn install",{cwd:reproDir}),reproPackageJson.devDependencies?.vite||await exec("yarn add -D webpack-hot-middleware",{cwd:reproDir}),await exec("yarn add @types/node@16",{cwd:reproDir}),start&&(logger24.info(`Running ${reproName} storybook`),await exec("yarn run storybook",{cwd:reproDir}))};import{dedent as dedent28}from"ts-dedent";import{sync as readUpSync}from"read-pkg-up";import{logger as logger25,instance as npmLog}from"@storybook/node-logger";import{buildDevStandalone,withTelemetry as withTelemetry3}from"@storybook/core-server";import{cache}from"@storybook/core-common";function printError(error){npmLog.heading="",error instanceof Error?error.error?logger25.error(error.error):error.stats&&error.stats.compilation.errors?error.stats.compilation.errors.forEach(e=>logger25.plain(e)):logger25.error(error):error.compilation?.errors&&error.compilation.errors.forEach(e=>logger25.plain(e)),logger25.line(),logger25.warn(error.close?dedent28`
|
|
418
426
|
FATAL broken build!, will close the process,
|
|
419
427
|
Fix the error below and restart storybook.
|
|
420
|
-
`:
|
|
428
|
+
`:dedent28`
|
|
421
429
|
Broken build, fix the error above.
|
|
422
430
|
You may need to refresh the browser.
|
|
423
|
-
`),logger25.line()
|
|
424
|
-
Environment Info:`)),envinfo.run({System:["OS","CPU"],Binaries:["Node","Yarn","npm"],Browsers:["Chrome","Edge","Firefox","Safari"],npmPackages:"@storybook/*",npmGlobalPackages:"@storybook/*"}).then(consoleLogger.log)});
|
|
425
|
-
`)),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})});
|
|
426
|
-
`)),getEnvConfig(program,{staticDir:"SBCONFIG_STATIC_DIR",outputDir:"SBCONFIG_OUTPUT_DIR",configDir:"SBCONFIG_CONFIG_DIR"}),build({...options,packageJson:pkg})});program.on("command:*",([invalidCmd])=>{consoleLogger.error(` Invalid command: %s.
|
|
431
|
+
`),logger25.line()}var dev=async cliOptions=>{process.env.NODE_ENV=process.env.NODE_ENV||"development";let options={...cliOptions,configDir:cliOptions.configDir||"./.storybook",configType:"DEVELOPMENT",ignorePreview:!!cliOptions.previewUrl&&!cliOptions.forceBuildPreview,cache,packageJson:readUpSync({cwd:__dirname}).packageJson};await withTelemetry3("dev",{cliOptions,presetOptions:options,printError},()=>buildDevStandalone(options))};import{sync as readUpSync2}from"read-pkg-up";import{buildStaticStandalone,withTelemetry as withTelemetry4}from"@storybook/core-server";import{cache as cache2}from"@storybook/core-common";var build=async cliOptions=>{let options={...cliOptions,configDir:cliOptions.configDir||"./.storybook",outputDir:cliOptions.outputDir||"./storybook-static",ignorePreview:!!cliOptions.previewUrl&&!cliOptions.forceBuildPreview,configType:"PRODUCTION",cache:cache2,packageJson:readUpSync2({cwd:__dirname}).packageJson};await withTelemetry4("build",{cliOptions,presetOptions:options},()=>buildStaticStandalone(options))};function parseList(str){return str.split(",").map(item=>item.trim()).filter(item=>item.length>0)}function getEnvConfig(program2,configEnv){Object.keys(configEnv).forEach(fieldName=>{let envVarName=configEnv[fieldName],envVarValue=process.env[envVarName];envVarValue&&(program2[fieldName]=envVarValue)})}var pkg=readUpSync3({cwd:__dirname}).packageJson,consoleLogger=console,command=name=>program.command(name).option("--disable-telemetry","disable sending telemetry data",process.env.STORYBOOK_DISABLE_TELEMETRY&&process.env.STORYBOOK_DISABLE_TELEMETRY!=="false").option("--debug","Get more logs in debug mode",!1).option("--enable-crash-reports","enable sending crash reports to telemetry data");command("init").description("Initialize Storybook into your project.").option("-f --force","Force add Storybook").option("-s --skip-install","Skip installing deps").option("--package-manager <npm|pnpm|yarn1|yarn2>","Force package manager for installing deps").option("-N --use-npm","Use npm to install deps (deprecated)").option("--use-pnp","Enable pnp mode for Yarn 2+").option("-p --parser <babel | babylon | flow | ts | tsx>","jscodeshift parser").option("-t --type <type>","Add Storybook for a specific project type").option("-y --yes","Answer yes to all prompts").option("-b --builder <webpack5 | vite>","Builder library").option("-l --linkable","Prepare installation for link (contributor helper)").action(options=>{initiate(options,pkg).catch(()=>process.exit(1))});command("add <addon>").description("Add an addon to your Storybook").option("--package-manager <npm|pnpm|yarn1|yarn2>","Force package manager for installing dependencies").option("-N --use-npm","Use NPM to install dependencies (deprecated)").option("-s --skip-postinstall","Skip package specific postinstall config modifications").action((addonName,options)=>add(addonName,options));command("babelrc").description("generate the default storybook babel config into your current working directory").action(()=>generateStorybookBabelConfigInCWD());command("upgrade").description("Upgrade your Storybook packages to the latest").option("--package-manager <npm|pnpm|yarn1|yarn2>","Force package manager for installing dependencies").option("-N --use-npm","Use NPM to install dependencies (deprecated)").option("-y --yes","Skip prompting the user").option("-n --dry-run","Only check for upgrades, do not install").option("-t --tag <tag>","Upgrade to a certain npm dist-tag (e.g. next, prerelease)").option("-p --prerelease","Upgrade to the pre-release packages").option("-s --skip-check","Skip postinstall version and automigration checks").option("-c, --config-dir <dir-name>","Directory where to load Storybook configurations from").action(async options=>upgrade(options).catch(()=>process.exit(1)));command("info").description("Prints debugging information about the local environment").action(()=>{consoleLogger.log(chalk26.bold(`
|
|
432
|
+
Environment Info:`)),envinfo.run({System:["OS","CPU"],Binaries:["Node","Yarn","npm"],Browsers:["Chrome","Edge","Firefox","Safari"],npmPackages:"@storybook/*",npmGlobalPackages:"@storybook/*"}).then(consoleLogger.log)});command("migrate [migration]").description("Run a Storybook codemod migration on your source files").option("-l --list","List available migrations").option("-g --glob <glob>","Glob for files upon which to apply the migration","**/*.js").option("-p --parser <babel | babylon | flow | ts | tsx>","jscodeshift parser").option("-n --dry-run","Dry run: verify the migration exists and show the files to which it will be applied").option("-r --rename <from-to>",'Rename suffix of matching files after codemod has been applied, e.g. ".js:.ts"').action((migration,{configDir,glob,dryRun,list,rename,parser})=>{migrate(migration,{configDir,glob,dryRun,list,rename,parser,logger:consoleLogger}).catch(err=>{logger26.error(err),process.exit(1)})});command("extract [location] [output]").description("extract stories.json from a built version").action((location="storybook-static",output=path8.join(location,"stories.json"))=>extract(location,output).catch(e=>{logger26.error(e),process.exit(1)}));command("sandbox [filterValue]").alias("repro").description("Create a sandbox from a set of possible templates").option("-o --output <outDir>","Define an output directory").option("-b --branch <branch>","Define the branch to download from","next").option("--no-init","Whether to download a template without an initialized Storybook",!1).action((filterValue,options)=>sandbox({filterValue,...options}).catch(e=>{logger26.error(e),process.exit(1)}));command("link <repo-url-or-directory>").description("Pull down a repro from a URL (or a local directory), link it, and run storybook").option("--local","Link a local directory already in your file system").option("--no-start","Start the storybook",!0).action((target,{local,start})=>link({target,local,start}).catch(e=>{logger26.error(e),process.exit(1)}));command("automigrate [fixId]").description("Check storybook for known problems or migrations and apply fixes").option("-y --yes","Skip prompting the user").option("-n --dry-run","Only check for fixes, do not actually run them").option("--package-manager <npm|pnpm|yarn1|yarn2>","Force package manager").option("-N --use-npm","Use npm as package manager (deprecated)").option("-l --list","List available migrations").option("-c, --config-dir <dir-name>","Directory of Storybook configurations to migrate").option("-s --skip-install","Skip installing deps").option("--renderer <renderer-pkg-name>","The renderer package for the framework Storybook is using.").action(async(fixId,options)=>{await automigrate({fixId,...options}).catch(e=>{logger26.error(e),process.exit(1)})});command("dev").option("-p, --port <number>","Port to run Storybook",str=>parseInt(str,10)).option("-h, --host <string>","Host to run Storybook").option("-s, --static-dir <dir-names>","Directory where to load static files from",parseList).option("-c, --config-dir <dir-name>","Directory where to load Storybook configurations from").option("--https","Serve Storybook over HTTPS. Note: You must provide your own certificate information.").option("--ssl-ca <ca>","Provide an SSL certificate authority. (Optional with --https, required if using a self-signed certificate)",parseList).option("--ssl-cert <cert>","Provide an SSL certificate. (Required with --https)").option("--ssl-key <key>","Provide an SSL key. (Required with --https)").option("--smoke-test","Exit after successful start").option("--ci","CI mode (skip interactive prompts, don't open browser)").option("--no-open","Do not open Storybook automatically in the browser").option("--loglevel <level>","Control level of logging during build").option("--quiet","Suppress verbose build output").option("--no-version-updates","Suppress update check",!0).option("--no-release-notes","Suppress automatic redirects to the release notes after upgrading",!0).option("--debug-webpack","Display final webpack configurations for debugging purposes").option("--webpack-stats-json [directory]","Write Webpack Stats JSON to disk").option("--preview-url <string>","Disables the default storybook preview and lets your use your own").option("--force-build-preview","Build the preview iframe even if you are using --preview-url").option("--docs","Build a documentation-only site using addon-docs").action(async options=>{logger26.setLevel(program.loglevel),consoleLogger.log(chalk26.bold(`${pkg.name} v${pkg.version}`)+chalk26.reset(`
|
|
433
|
+
`)),getEnvConfig(program,{port:"SBCONFIG_PORT",host:"SBCONFIG_HOSTNAME",staticDir:"SBCONFIG_STATIC_DIR",configDir:"SBCONFIG_CONFIG_DIR",ci:"CI"}),typeof program.port=="string"&&program.port.length>0&&(program.port=parseInt(program.port,10)),await dev({...options,packageJson:pkg}).catch(()=>process.exit(1))});command("build").option("-s, --static-dir <dir-names>","Directory where to load static files from",parseList).option("-o, --output-dir <dir-name>","Directory where to store built files").option("-c, --config-dir <dir-name>","Directory where to load Storybook configurations from").option("--quiet","Suppress verbose build output").option("--loglevel <level>","Control level of logging during build").option("--debug-webpack","Display final webpack configurations for debugging purposes").option("--webpack-stats-json [directory]","Write Webpack Stats JSON to disk").option("--preview-url <string>","Disables the default storybook preview and lets your use your own").option("--force-build-preview","Build the preview iframe even if you are using --preview-url").option("--docs","Build a documentation-only site using addon-docs").action(async options=>{process.env.NODE_ENV=process.env.NODE_ENV||"production",logger26.setLevel(program.loglevel),consoleLogger.log(chalk26.bold(`${pkg.name} v${pkg.version}
|
|
434
|
+
`)),getEnvConfig(program,{staticDir:"SBCONFIG_STATIC_DIR",outputDir:"SBCONFIG_OUTPUT_DIR",configDir:"SBCONFIG_CONFIG_DIR"}),await build({...options,packageJson:pkg}).catch(()=>process.exit(1))});program.on("command:*",([invalidCmd])=>{consoleLogger.error(` Invalid command: %s.
|
|
427
435
|
See --help for a list of available commands.`,invalidCmd);let suggestion=program.commands.map(cmd=>cmd._name).find(cmd=>leven(cmd,invalidCmd)<3);suggestion&&consoleLogger.info(`
|
|
428
436
|
Did you mean ${suggestion}?`),process.exit(1)});program.usage("<command> [options]").version(pkg.version).parse(process.argv);
|