@storybook/cli 7.0.0-beta.6 → 7.0.0-beta.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generate.js +162 -140
- package/dist/generate.mjs +93 -71
- package/package.json +10 -10
package/dist/generate.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
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 chalk24 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 chalk20 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.6","@storybook/addon-actions":"7.0.0-beta.6","@storybook/addon-backgrounds":"7.0.0-beta.6","@storybook/addon-controls":"7.0.0-beta.6","@storybook/addon-docs":"7.0.0-beta.6","@storybook/addon-essentials":"7.0.0-beta.6","@storybook/addon-highlight":"7.0.0-beta.6","@storybook/addon-interactions":"7.0.0-beta.6","@storybook/addon-jest":"7.0.0-beta.6","@storybook/addon-links":"7.0.0-beta.6","@storybook/addon-measure":"7.0.0-beta.6","@storybook/addon-outline":"7.0.0-beta.6","@storybook/addon-storyshots":"7.0.0-beta.6","@storybook/addon-storyshots-puppeteer":"7.0.0-beta.6","@storybook/addon-storysource":"7.0.0-beta.6","@storybook/addon-toolbars":"7.0.0-beta.6","@storybook/addon-viewport":"7.0.0-beta.6","@storybook/addons":"7.0.0-beta.6","@storybook/angular":"7.0.0-beta.6","@storybook/manager-api":"7.0.0-beta.6","@storybook/blocks":"7.0.0-beta.6","@storybook/builder-manager":"7.0.0-beta.6","@storybook/builder-vite":"7.0.0-beta.6","@storybook/builder-webpack5":"7.0.0-beta.6","@storybook/channel-postmessage":"7.0.0-beta.6","@storybook/channel-websocket":"7.0.0-beta.6","@storybook/channels":"7.0.0-beta.6","@storybook/cli":"7.0.0-beta.6","@storybook/client-api":"7.0.0-beta.6","@storybook/client-logger":"7.0.0-beta.6","@storybook/codemod":"7.0.0-beta.6","@storybook/components":"7.0.0-beta.6","@storybook/core-client":"7.0.0-beta.6","@storybook/core-common":"7.0.0-beta.6","@storybook/core-events":"7.0.0-beta.6","@storybook/core-server":"7.0.0-beta.6","@storybook/core-webpack":"7.0.0-beta.6","@storybook/csf-tools":"7.0.0-beta.6","@storybook/docs-tools":"7.0.0-beta.6","@storybook/ember":"7.0.0-beta.6","@storybook/html":"7.0.0-beta.6","@storybook/html-webpack5":"7.0.0-beta.6","@storybook/html-vite":"7.0.0-beta.6","@storybook/instrumenter":"7.0.0-beta.6","@storybook/nextjs":"7.0.0-beta.6","@storybook/node-logger":"7.0.0-beta.6","@storybook/postinstall":"7.0.0-beta.6","@storybook/preact":"7.0.0-beta.6","@storybook/preact-webpack5":"7.0.0-beta.6","@storybook/preset-html-webpack":"7.0.0-beta.6","@storybook/preset-preact-webpack":"7.0.0-beta.6","@storybook/preset-react-webpack":"7.0.0-beta.6","@storybook/preset-server-webpack":"7.0.0-beta.6","@storybook/preset-svelte-webpack":"7.0.0-beta.6","@storybook/preset-vue-webpack":"7.0.0-beta.6","@storybook/preset-vue3-webpack":"7.0.0-beta.6","@storybook/preset-web-components-webpack":"7.0.0-beta.6","@storybook/preview":"7.0.0-beta.6","@storybook/preview-api":"7.0.0-beta.6","@storybook/preview-web":"7.0.0-beta.6","@storybook/react":"7.0.0-beta.6","@storybook/react-vite":"7.0.0-beta.6","@storybook/react-webpack5":"7.0.0-beta.6","@storybook/router":"7.0.0-beta.6","@storybook/server":"7.0.0-beta.6","@storybook/server-webpack5":"7.0.0-beta.6","@storybook/source-loader":"7.0.0-beta.6","@storybook/store":"7.0.0-beta.6","@storybook/svelte":"7.0.0-beta.6","@storybook/sveltekit":"7.0.0-beta.6","@storybook/svelte-vite":"7.0.0-beta.6","@storybook/svelte-webpack5":"7.0.0-beta.6","@storybook/telemetry":"7.0.0-beta.6","@storybook/theming":"7.0.0-beta.6","@storybook/manager":"7.0.0-beta.6","@storybook/vue":"7.0.0-beta.6","@storybook/vue-vite":"7.0.0-beta.6","@storybook/vue-webpack5":"7.0.0-beta.6","@storybook/vue3":"7.0.0-beta.6","@storybook/vue3-vite":"7.0.0-beta.6","@storybook/vue3-webpack5":"7.0.0-beta.6","@storybook/web-components":"7.0.0-beta.6","@storybook/web-components-webpack5":"7.0.0-beta.6","@storybook/web-components-vite":"7.0.0-beta.6",sb:"7.0.0-beta.6",storybook:"7.0.0-beta.6"};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)}
|
|
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.7","@storybook/addon-actions":"7.0.0-beta.7","@storybook/addon-backgrounds":"7.0.0-beta.7","@storybook/addon-controls":"7.0.0-beta.7","@storybook/addon-docs":"7.0.0-beta.7","@storybook/addon-essentials":"7.0.0-beta.7","@storybook/addon-highlight":"7.0.0-beta.7","@storybook/addon-interactions":"7.0.0-beta.7","@storybook/addon-jest":"7.0.0-beta.7","@storybook/addon-links":"7.0.0-beta.7","@storybook/addon-measure":"7.0.0-beta.7","@storybook/addon-outline":"7.0.0-beta.7","@storybook/addon-storyshots":"7.0.0-beta.7","@storybook/addon-storyshots-puppeteer":"7.0.0-beta.7","@storybook/addon-storysource":"7.0.0-beta.7","@storybook/addon-toolbars":"7.0.0-beta.7","@storybook/addon-viewport":"7.0.0-beta.7","@storybook/addons":"7.0.0-beta.7","@storybook/angular":"7.0.0-beta.7","@storybook/manager-api":"7.0.0-beta.7","@storybook/blocks":"7.0.0-beta.7","@storybook/builder-manager":"7.0.0-beta.7","@storybook/builder-vite":"7.0.0-beta.7","@storybook/builder-webpack5":"7.0.0-beta.7","@storybook/channel-postmessage":"7.0.0-beta.7","@storybook/channel-websocket":"7.0.0-beta.7","@storybook/channels":"7.0.0-beta.7","@storybook/cli":"7.0.0-beta.7","@storybook/client-api":"7.0.0-beta.7","@storybook/client-logger":"7.0.0-beta.7","@storybook/codemod":"7.0.0-beta.7","@storybook/components":"7.0.0-beta.7","@storybook/core-client":"7.0.0-beta.7","@storybook/core-common":"7.0.0-beta.7","@storybook/core-events":"7.0.0-beta.7","@storybook/core-server":"7.0.0-beta.7","@storybook/core-webpack":"7.0.0-beta.7","@storybook/csf-tools":"7.0.0-beta.7","@storybook/docs-tools":"7.0.0-beta.7","@storybook/ember":"7.0.0-beta.7","@storybook/html":"7.0.0-beta.7","@storybook/html-webpack5":"7.0.0-beta.7","@storybook/html-vite":"7.0.0-beta.7","@storybook/instrumenter":"7.0.0-beta.7","@storybook/nextjs":"7.0.0-beta.7","@storybook/node-logger":"7.0.0-beta.7","@storybook/postinstall":"7.0.0-beta.7","@storybook/preact":"7.0.0-beta.7","@storybook/preact-webpack5":"7.0.0-beta.7","@storybook/preset-html-webpack":"7.0.0-beta.7","@storybook/preset-preact-webpack":"7.0.0-beta.7","@storybook/preset-react-webpack":"7.0.0-beta.7","@storybook/preset-server-webpack":"7.0.0-beta.7","@storybook/preset-svelte-webpack":"7.0.0-beta.7","@storybook/preset-vue-webpack":"7.0.0-beta.7","@storybook/preset-vue3-webpack":"7.0.0-beta.7","@storybook/preset-web-components-webpack":"7.0.0-beta.7","@storybook/preview":"7.0.0-beta.7","@storybook/preview-api":"7.0.0-beta.7","@storybook/preview-web":"7.0.0-beta.7","@storybook/react":"7.0.0-beta.7","@storybook/react-vite":"7.0.0-beta.7","@storybook/react-webpack5":"7.0.0-beta.7","@storybook/router":"7.0.0-beta.7","@storybook/server":"7.0.0-beta.7","@storybook/server-webpack5":"7.0.0-beta.7","@storybook/source-loader":"7.0.0-beta.7","@storybook/store":"7.0.0-beta.7","@storybook/svelte":"7.0.0-beta.7","@storybook/sveltekit":"7.0.0-beta.7","@storybook/svelte-vite":"7.0.0-beta.7","@storybook/svelte-webpack5":"7.0.0-beta.7","@storybook/telemetry":"7.0.0-beta.7","@storybook/theming":"7.0.0-beta.7","@storybook/manager":"7.0.0-beta.7","@storybook/vue":"7.0.0-beta.7","@storybook/vue-vite":"7.0.0-beta.7","@storybook/vue-webpack5":"7.0.0-beta.7","@storybook/vue3":"7.0.0-beta.7","@storybook/vue3-vite":"7.0.0-beta.7","@storybook/vue3-webpack5":"7.0.0-beta.7","@storybook/web-components":"7.0.0-beta.7","@storybook/web-components-webpack5":"7.0.0-beta.7","@storybook/web-components-vite":"7.0.0-beta.7",sb:"7.0.0-beta.7",storybook:"7.0.0-beta.7"};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
2
|
`),!0):!1},commandLog=message=>(process.stdout.write(chalk.cyan(" \u2022 ")+message),(errorMessage,errorInfo)=>{if(errorMessage){if(process.stdout.write(`. ${chalk.red("\u2716")}
|
|
3
3
|
`),logger.error(`
|
|
4
4
|
${chalk.red(errorMessage)}`),!errorInfo)return;let newErrorInfo=errorInfo.split(`
|
|
@@ -50,7 +50,7 @@ Add a project and re-run the installation`)}async function getBaseTsConfigName()
|
|
|
50
50
|
});
|
|
51
51
|
return config;
|
|
52
52
|
}
|
|
53
|
-
%%`}:{},craVersion=semver4.coerce(packageManager.retrievePackageJson().dependencies["react-scripts"])?.version,isCra5=craVersion&&semver4.gte(craVersion,"5.0.0"),updatedOptions=isCra5?{...options,builder:"webpack5"}:options,extraPackages=["@storybook/node-logger"];isCra5&&(extraPackages.push("webpack"),extraPackages.push("babel-plugin-named-exports-order"),extraPackages.push("prop-types")),await baseGenerator(packageManager,npmOptions,updatedOptions,"react",{extraAddons:[`@storybook/preset-create-react-app${isCra5?"":"@3"}`],extraPackages,staticDir:fs5.existsSync(path8.resolve("./public"))?"public":void 0,addBabel:!1,addESLint:!0,extraMain})},REACT_SCRIPTS_default=generator6;var generator7=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"react",void 0,"nextjs")},NEXTJS_default=generator7;var generator8=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"vue")},SFC_VUE_default=generator8;var generator9=async(packageManager,npmOptions,options)=>{let extraPackages=options.builder==="webpack5"?["vue-loader@^15.7.0"]:[];await baseGenerator(packageManager,npmOptions,options,"vue",{extraPackages})},VUE_default=generator9;var generator10=async(packageManager,npmOptions,options)=>{let extraPackages=options.builder==="webpack5"?["vue-loader@^17.0.0","@vue/compiler-sfc@^3.2.0"]:[];await baseGenerator(packageManager,npmOptions,options,"vue3",{extraPackages})},VUE3_default=generator10;var generator11=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"react")},WEBPACK_REACT_default=generator11;var generator12=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"mithril")},MITHRIL_default=generator12;var generator13=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"marionette")},MARIONETTE_default=generator13;var generator14=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"marko")},MARKO_default=generator14;var generator15=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"html")},HTML_default=generator15;var generator16=async(packageManager,npmOptions,options)=>baseGenerator(packageManager,npmOptions,options,"web-components",{extraPackages:["lit-html"]}),WEB_COMPONENTS_default=generator16;var generator17=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"riot",{extraPackages:["riot-tag-loader"]})},RIOT_default=generator17;var generator18=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"preact")},PREACT_default=generator18;var generator19=async(packageManager,npmOptions,options)=>{let extraPackages=options.builder==="webpack5"?["svelte","svelte-loader"]:[];await baseGenerator(packageManager,npmOptions,options,"svelte",{extraPackages,extensions:["js","jsx","ts","tsx","svelte"],commonJs:!0})},SVELTE_default=generator19;var generator20=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"svelte",void 0,"sveltekit")},SVELTEKIT_default=generator20;var generator21=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=generator21;import{join as join5}from"path";var generator22=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"server",{extensions:["json"]});let templateDir=join5(getCliDir(),"templates","server");copyTemplate(templateDir)},SERVER_default=generator22;import prompts2 from"prompts";import
|
|
53
|
+
%%`}:{},craVersion=semver4.coerce(packageManager.retrievePackageJson().dependencies["react-scripts"])?.version,isCra5=craVersion&&semver4.gte(craVersion,"5.0.0"),updatedOptions=isCra5?{...options,builder:"webpack5"}:options,extraPackages=["@storybook/node-logger"];isCra5&&(extraPackages.push("webpack"),extraPackages.push("babel-plugin-named-exports-order"),extraPackages.push("prop-types")),await baseGenerator(packageManager,npmOptions,updatedOptions,"react",{extraAddons:[`@storybook/preset-create-react-app${isCra5?"":"@3"}`],extraPackages,staticDir:fs5.existsSync(path8.resolve("./public"))?"public":void 0,addBabel:!1,addESLint:!0,extraMain})},REACT_SCRIPTS_default=generator6;var generator7=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"react",void 0,"nextjs")},NEXTJS_default=generator7;var generator8=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"vue")},SFC_VUE_default=generator8;var generator9=async(packageManager,npmOptions,options)=>{let extraPackages=options.builder==="webpack5"?["vue-loader@^15.7.0"]:[];await baseGenerator(packageManager,npmOptions,options,"vue",{extraPackages})},VUE_default=generator9;var generator10=async(packageManager,npmOptions,options)=>{let extraPackages=options.builder==="webpack5"?["vue-loader@^17.0.0","@vue/compiler-sfc@^3.2.0"]:[];await baseGenerator(packageManager,npmOptions,options,"vue3",{extraPackages})},VUE3_default=generator10;var generator11=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"react")},WEBPACK_REACT_default=generator11;var generator12=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"mithril")},MITHRIL_default=generator12;var generator13=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"marionette")},MARIONETTE_default=generator13;var generator14=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"marko")},MARKO_default=generator14;var generator15=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"html")},HTML_default=generator15;var generator16=async(packageManager,npmOptions,options)=>baseGenerator(packageManager,npmOptions,options,"web-components",{extraPackages:["lit-html"]}),WEB_COMPONENTS_default=generator16;var generator17=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"riot",{extraPackages:["riot-tag-loader"]})},RIOT_default=generator17;var generator18=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"preact")},PREACT_default=generator18;var generator19=async(packageManager,npmOptions,options)=>{let extraPackages=options.builder==="webpack5"?["svelte","svelte-loader"]:[];await baseGenerator(packageManager,npmOptions,options,"svelte",{extraPackages,extensions:["js","jsx","ts","tsx","svelte"],commonJs:!0})},SVELTE_default=generator19;var generator20=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"svelte",void 0,"sveltekit")},SVELTEKIT_default=generator20;var generator21=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=generator21;import{join as join5}from"path";var generator22=async(packageManager,npmOptions,options)=>{await baseGenerator(packageManager,npmOptions,options,"server",{extensions:["json"]});let templateDir=join5(getCliDir(),"templates","server");copyTemplate(templateDir)},SERVER_default=generator22;import prompts2 from"prompts";import chalk20 from"chalk";import boxen from"boxen";import chalk5 from"chalk";import{dedent as dedent4}from"ts-dedent";import semver6 from"semver";import chalk4 from"chalk";import{dedent as dedent3}from"ts-dedent";import semver5 from"semver";import{readConfig,writeConfig}from"@storybook/csf-tools";import{getStorybookInfo}from"@storybook/core-common";var logger4=console,webpack5={id:"webpack5",async checkWebpack5Builder(packageJson){let{mainConfig,version:storybookVersion}=getStorybookInfo(packageJson),storybookCoerced=storybookVersion&&semver5.coerce(storybookVersion)?.version;if(!storybookCoerced)return logger4.warn(dedent3`
|
|
54
54
|
❌ Unable to determine storybook version, skipping ${chalk4.cyan("webpack5")} fix.
|
|
55
55
|
🤔 Are you running automigrate from your project directory?
|
|
56
56
|
`),null;if(semver5.lt(storybookCoerced,"6.3.0"))return logger4.warn(dedent3`
|
|
@@ -144,48 +144,70 @@ Add a project and re-run the installation`)}async function getBaseTsConfigName()
|
|
|
144
144
|
`:""}
|
|
145
145
|
|
|
146
146
|
More info: ${chalk12.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#start-storybook--build-storybook-binaries-removed")}
|
|
147
|
-
`},async run({result:{packageJson,hasSbBinary,hasStorybookBinary},packageManager,dryRun}){if(hasSbBinary&&(logger9.info("\u2705 Removing 'sb' dependency"),dryRun||packageManager.removeDependencies({skipInstall:!hasStorybookBinary,packageJson},["sb"])),!hasStorybookBinary&&(logger9.log(),logger9.info("\u2705 Adding 'storybook' as dev dependency"),logger9.log(),!dryRun)){let versionToInstall=getStorybookVersionSpecifier(packageJson);packageManager.addDependencies({installAsDevDependencies:!0},[`storybook@${versionToInstall}`])}}};import chalk13 from"chalk";import dedent12 from"ts-dedent";import semver12 from"semver";import{readConfig as readConfig5,writeConfig as writeConfig5}from"@storybook/csf-tools";import{getStorybookInfo as getStorybookInfo7}from"@storybook/core-common";var logger10=console,
|
|
147
|
+
`},async run({result:{packageJson,hasSbBinary,hasStorybookBinary},packageManager,dryRun}){if(hasSbBinary&&(logger9.info("\u2705 Removing 'sb' dependency"),dryRun||packageManager.removeDependencies({skipInstall:!hasStorybookBinary,packageJson},["sb"])),!hasStorybookBinary&&(logger9.log(),logger9.info("\u2705 Adding 'storybook' as dev dependency"),logger9.log(),!dryRun)){let versionToInstall=getStorybookVersionSpecifier(packageJson);packageManager.addDependencies({installAsDevDependencies:!0},[`storybook@${versionToInstall}`])}}};import chalk13 from"chalk";import dedent12 from"ts-dedent";import semver12 from"semver";import{readConfig as readConfig5,writeConfig as writeConfig5}from"@storybook/csf-tools";import{getStorybookInfo as getStorybookInfo7}from"@storybook/core-common";var logger10=console,getNextjsAddonOptions=addons=>{let nextjsAddon=addons?.find(addon=>typeof addon=="string"?addon==="storybook-addon-next":addon.name==="storybook-addon-next");return!nextjsAddon||typeof nextjsAddon=="string"?{}:nextjsAddon.options||{}},nextjsFramework={id:"nextjsFramework",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),allDeps={...packageJson.dependencies,...packageJson.devDependencies};if(!allDeps.next)return null;let{mainConfig,version:storybookVersion}=getStorybookInfo7(packageJson);if(!mainConfig)return logger10.warn("Unable to find storybook main.js config, skipping"),null;let storybookCoerced=storybookVersion&&semver12.coerce(storybookVersion)?.version;if(!storybookCoerced)return logger10.warn(dedent12`
|
|
148
|
+
❌ Unable to determine storybook version, skipping ${chalk13.cyan("nextjsFramework")} fix.
|
|
149
|
+
🤔 Are you running automigrate from your project directory?
|
|
150
|
+
`),null;if(!semver12.gte(storybookCoerced,"7.0.0"))return null;let main=await readConfig5(mainConfig),frameworkPackage=main.getFieldValue(["framework"]);if(!frameworkPackage)return null;let frameworkPackageName=typeof frameworkPackage=="string"?frameworkPackage:frameworkPackage.name;if(frameworkPackageName==="@storybook/react-vite")return logger10.info(dedent12`
|
|
151
|
+
We've detected you are using Storybook in a Next.js project.
|
|
152
|
+
|
|
153
|
+
In Storybook 7, we introduced a new framework package for Next.js projects: @storybook/nextjs.
|
|
154
|
+
|
|
155
|
+
This package provides a better experience for Next.js users, however it is only compatible with the webpack 5 builder, so we can't automigrate for you, as you are using the Vite builder.
|
|
156
|
+
|
|
157
|
+
If you are interested in using this package, see: ${chalk13.yellow("https://github.com/storybookjs/storybook/blob/next/code/frameworks/nextjs/README.md")}
|
|
158
|
+
`),null;if(frameworkPackageName!=="@storybook/react-webpack5")return null;let addonOptions=getNextjsAddonOptions(main.getFieldValue(["addons"])),frameworkOptions=main.getFieldValue(["framework","options"])||{},addonsToRemove=["storybook-addon-next","storybook-addon-next-router"].filter(dep=>allDeps[dep]);return{main,addonsToRemove,frameworkOptions:{...frameworkOptions,...addonOptions},packageJson}},prompt({addonsToRemove}){let addonsMessage="";return addonsToRemove.length>0&&(addonsMessage=`
|
|
159
|
+
This package also supports features provided by the following packages, which can now be removed:
|
|
160
|
+
${addonsToRemove.map(dep=>`- ${chalk13.cyan(dep)}`).join(", ")}
|
|
161
|
+
`),dedent12`
|
|
162
|
+
We've detected you are using Storybook in a ${chalk13.bold("Next.js")} project.
|
|
163
|
+
|
|
164
|
+
In Storybook 7, we introduced a new framework package for Next.js projects: ${chalk13.magenta("@storybook/nextjs")}.
|
|
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`
|
|
148
170
|
Unable to get the ${framework}Options field.
|
|
149
171
|
|
|
150
172
|
Please review the changes made to your main.js config and make any necessary changes.
|
|
151
173
|
The ${framework}Options should be moved to the framework.options field.
|
|
152
174
|
|
|
153
175
|
The following error occurred when we tried to get the ${framework}Options field:
|
|
154
|
-
`),console.log(e)}return frameworkOptions||{}},newFrameworks={id:"newFrameworks",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),allDeps={...packageJson.dependencies,...packageJson.devDependencies},{mainConfig,version:storybookVersion,framework}=
|
|
155
|
-
❌ Unable to determine storybook version, skipping ${
|
|
176
|
+
`),console.log(e)}return frameworkOptions||{}},newFrameworks={id:"newFrameworks",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),allDeps={...packageJson.dependencies,...packageJson.devDependencies},{mainConfig,version:storybookVersion,framework}=getStorybookInfo8(packageJson);if(!mainConfig)return logger11.warn("Unable to find storybook main.js config, skipping"),null;let storybookCoerced=storybookVersion&&semver13.coerce(storybookVersion)?.version;if(!storybookCoerced)return logger11.warn(dedent13`
|
|
177
|
+
❌ Unable to determine storybook version, skipping ${chalk14.cyan("newFrameworks")} fix.
|
|
156
178
|
🤔 Are you running automigrate from your project directory?
|
|
157
|
-
`),null;if(!
|
|
158
|
-
❌ Detected Vite ${allDeps.vite}, which is unsupported in Storybook 7.0, so the ${
|
|
179
|
+
`),null;if(!semver13.gte(storybookCoerced,"7.0.0"))return null;let main=await readConfig6(mainConfig),frameworkPackage=main.getFieldValue(["framework"]),builder=main.getFieldValue(["core","builder"]);if(!frameworkPackage||!Object.keys(packagesMap).includes(frameworkPackage))return null;let builderInfo={name:getBuilder(builder),options:main.getFieldValue(["core","builder","options"])||{}},newFrameworkPackage=packagesMap[frameworkPackage][builderInfo.name];if(!newFrameworkPackage)return null;if(allDeps.vite&&semver13.lt(semver13.coerce(allDeps.vite).version,"3.0.0"))return logger11.warn(dedent13`
|
|
180
|
+
❌ Detected Vite ${allDeps.vite}, which is unsupported in Storybook 7.0, so the ${chalk14.cyan("newFrameworks")} fix will be skipped.
|
|
159
181
|
Please upgrade vite to 3.0.0 or higher and rerun this automigration with "npx storybook@future automigrate".
|
|
160
|
-
`),null;let frameworkOptions=getFrameworkOptions(framework,main),dependenciesToRemove=["@storybook/builder-webpack5","@storybook/manager-webpack5","@storybook/builder-webpack4","@storybook/manager-webpack4","@storybook/builder-vite","storybook-builder-vite"].filter(dep=>allDeps[dep]),dependenciesToAdd=[];return newFrameworkPackage!==frameworkPackage&&dependenciesToAdd.push(newFrameworkPackage),{main,dependenciesToAdd,dependenciesToRemove,frameworkPackage:newFrameworkPackage,frameworkOptions,builderInfo,packageJson}},prompt(){return
|
|
182
|
+
`),null;let frameworkOptions=getFrameworkOptions(framework,main),dependenciesToRemove=["@storybook/builder-webpack5","@storybook/manager-webpack5","@storybook/builder-webpack4","@storybook/manager-webpack4","@storybook/builder-vite","storybook-builder-vite"].filter(dep=>allDeps[dep]),dependenciesToAdd=[];return newFrameworkPackage!==frameworkPackage&&dependenciesToAdd.push(newFrameworkPackage),{main,dependenciesToAdd,dependenciesToRemove,frameworkPackage:newFrameworkPackage,frameworkOptions,builderInfo,packageJson}},prompt(){return dedent13`
|
|
161
183
|
We've detected you are using an older format of Storybook frameworks and builders.
|
|
162
184
|
|
|
163
185
|
In Storybook 7, frameworks also specify the builder to be used.
|
|
164
186
|
|
|
165
187
|
We can remove the dependencies that are no longer needed and install the new framework that already includes the builder.
|
|
166
188
|
|
|
167
|
-
To learn more about the framework field, see: ${
|
|
189
|
+
To learn more about the framework field, see: ${chalk14.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#framework-field-mandatory")}
|
|
168
190
|
|
|
169
|
-
${
|
|
191
|
+
${chalk14.underline(chalk14.bold(chalk14.cyan("Webpack4 users")))}
|
|
170
192
|
|
|
171
193
|
Unless you're using Storybook's Vite builder, this automigration will install a Webpack5-based framework.
|
|
172
194
|
|
|
173
195
|
If you were using Storybook's Webpack4 builder (default in 6.x, discontinued in 7.0), this could be a breaking
|
|
174
196
|
change--especially if your project has a custom webpack configuration.
|
|
175
197
|
|
|
176
|
-
To learn more about migrating from Webpack4, see: ${
|
|
177
|
-
`},async run({result:{dependenciesToAdd,dependenciesToRemove,main,frameworkPackage,frameworkOptions,builderInfo,packageJson},packageManager,dryRun}){if(
|
|
178
|
-
The following APIs (used in "${
|
|
198
|
+
To learn more about migrating from Webpack4, see: ${chalk14.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#webpack4-support-discontinued")}
|
|
199
|
+
`},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,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`
|
|
200
|
+
The following APIs (used in "${chalk15.yellow(previewPath)}") have been removed from Storybook:
|
|
179
201
|
|
|
180
|
-
${usedAPIs.map(api=>`- ${
|
|
202
|
+
${usedAPIs.map(api=>`- ${chalk15.cyan(api)}`).join(`
|
|
181
203
|
`)}
|
|
182
204
|
|
|
183
|
-
You'll need to update "${
|
|
205
|
+
You'll need to update "${chalk15.yellow(previewPath)}" manually.
|
|
184
206
|
|
|
185
207
|
Please see the migration guide for more information:
|
|
186
|
-
${
|
|
187
|
-
`},async run(){console.log("Skipping automatic fix for removed global client APIs")}};import
|
|
188
|
-
We've found ${
|
|
208
|
+
${chalk15.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#removed-global-client-apis")}
|
|
209
|
+
`},async run(){console.log("Skipping automatic fix for removed global client APIs")}};import chalk16 from"chalk";import{dedent as dedent15}from"ts-dedent";import{basename}from"path";import fse5 from"fs-extra";import globby from"globby";var MDX1_SCRIPT_START=/<style>{`/g,MDX1_SCRIPT_END=/`}<\/style>/g,fixMdxScript=mdx=>mdx.replace(MDX1_SCRIPT_START,"<style>\n {`").replace(MDX1_SCRIPT_END," `}\n</style>"),logger12=console,mdx1to2={id:"mdx1to2",async check(){let storiesMdxFiles=await globby("./!(node_modules)**/*.(story|stories).mdx");return storiesMdxFiles.length?{storiesMdxFiles}:void 0},prompt({storiesMdxFiles}){return dedent15`
|
|
210
|
+
We've found ${chalk16.yellow(storiesMdxFiles.length)} '.stories.mdx' files in your project.
|
|
189
211
|
|
|
190
212
|
Storybook has upgraded to MDX2 (https://mdxjs.com/blog/v2/), which contains breaking changes from V1.
|
|
191
213
|
|
|
@@ -193,38 +215,38 @@ Add a project and re-run the installation`)}async function getBaseTsConfigName()
|
|
|
193
215
|
|
|
194
216
|
For a full guide for how to manually upgrade your files, see the MDX2 migration guide:
|
|
195
217
|
|
|
196
|
-
${
|
|
197
|
-
`},async run({result:{storiesMdxFiles},dryRun}){await Promise.all(storiesMdxFiles.map(async fname=>{let contents=await fse5.readFile(fname,"utf-8"),updated=fixMdxScript(contents);updated===contents?
|
|
218
|
+
${chalk16.cyan("https://mdxjs.com/migrating/v2/#update-mdx-files")}
|
|
219
|
+
`},async run({result:{storiesMdxFiles},dryRun}){await Promise.all(storiesMdxFiles.map(async fname=>{let contents=await fse5.readFile(fname,"utf-8"),updated=fixMdxScript(contents);updated===contents?logger12.info(`\u{1F197} Unmodified ${basename(fname)}`):(logger12.info(`\u2705 Modified ${basename(fname)}`),dryRun||await fse5.writeFile(fname,updated))}))}};import chalk17 from"chalk";import{dedent as dedent16}from"ts-dedent";import{readConfig as readConfig7,writeConfig as writeConfig7}from"@storybook/csf-tools";import{getStorybookInfo as getStorybookInfo10}from"@storybook/core-common";var logger13=console,docsPageAutomatic={id:"docsPageAutomatic",async check({packageManager}){let packageJson=packageManager.retrievePackageJson(),{mainConfig}=getStorybookInfo10(packageJson);if(!mainConfig)return logger13.warn("Unable to find storybook main.js config, skipping"),null;let main=await readConfig7(mainConfig);return main.getFieldValue(["docs"])?.docsPage===void 0?{main}:null},prompt(){let docsPageAutomaticFormatted=chalk17.cyan("docs: { docsPage: 'automatic' }");return dedent16`
|
|
198
220
|
We've detected that your main.js configuration file has not configured docsPage. In 6.x we
|
|
199
221
|
we defaulted to having a docsPage for every story, in 7.x you need to opt in per-component.
|
|
200
222
|
However, we can set the \`docs.docsPage\` to 'automatic' to approximate the old behaviour:
|
|
201
223
|
|
|
202
224
|
${docsPageAutomaticFormatted}
|
|
203
225
|
|
|
204
|
-
More info: ${
|
|
205
|
-
`},async run({result:{main},dryRun}){
|
|
206
|
-
❌ Unable to determine Storybook version, skipping ${
|
|
226
|
+
More info: ${chalk17.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#docs-page")}
|
|
227
|
+
`},async run({result:{main},dryRun}){logger13.info("\u2705 Setting 'docs.docsPage' to 'automatic' in main.js"),dryRun||(main.setFieldValue(["docs","docsPage"],"automatic"),await writeConfig7(main))}};import chalk18 from"chalk";import dedent17 from"ts-dedent";import semver14 from"semver";import{readConfig as readConfig8,writeConfig as writeConfig8}from"@storybook/csf-tools";import{getStorybookInfo as getStorybookInfo11}from"@storybook/core-common";var logger14=console,fixId="sveltekitFramework",sveltekitFramework={id:fixId,async check({packageManager}){let packageJson=packageManager.retrievePackageJson();if(!{...packageJson.dependencies,...packageJson.devDependencies}["@sveltejs/kit"])return null;let{mainConfig,version:storybookVersion}=getStorybookInfo11(packageJson);if(!mainConfig)return logger14.warn("Unable to find storybook main.js config, skipping"),null;let sbVersionCoerced=storybookVersion&&semver14.coerce(storybookVersion)?.version;if(!sbVersionCoerced)return logger14.warn(dedent17`
|
|
228
|
+
❌ Unable to determine Storybook version, skipping ${chalk18.cyan(fixId)} fix.
|
|
207
229
|
🤔 Are you running automigrate from your project directory?
|
|
208
|
-
`),null;if(!
|
|
209
|
-
❌ Unable to determine Storybook framework, skipping ${
|
|
230
|
+
`),null;if(!semver14.gte(sbVersionCoerced,"7.0.0"))return null;let main=await readConfig8(mainConfig),frameworkConfig=main.getFieldValue(["framework"]);if(!frameworkConfig)return logger14.warn(dedent17`
|
|
231
|
+
❌ Unable to determine Storybook framework, skipping ${chalk18.cyan(fixId)} fix.
|
|
210
232
|
🤔 Are you running automigrate from your project directory?
|
|
211
|
-
`),null;let framework=typeof frameworkConfig=="string"?frameworkConfig:frameworkConfig.name,frameworkOptions=main.getFieldValue(["framework","options"]);if(framework==="@storybook/sveltekit")return null;if(framework==="@storybook/svelte-vite")return{main,frameworkOptions,packageJson,dependenciesToRemove:["@storybook/svelte-vite"]};if(framework!=="@storybook/svelte")return
|
|
233
|
+
`),null;let framework=typeof frameworkConfig=="string"?frameworkConfig:frameworkConfig.name,frameworkOptions=main.getFieldValue(["framework","options"]);if(framework==="@storybook/sveltekit")return null;if(framework==="@storybook/svelte-vite")return{main,frameworkOptions,packageJson,dependenciesToRemove:["@storybook/svelte-vite"]};if(framework!=="@storybook/svelte")return logger14.warn(dedent17`
|
|
212
234
|
We've detected you are using Storybook in a SvelteKit project.
|
|
213
235
|
|
|
214
236
|
In Storybook 7, we introduced a new framework package for SvelteKit projects: @storybook/sveltekit.
|
|
215
237
|
|
|
216
238
|
This package provides a better experience for SvelteKit users, however it is only compatible with the Svelte framework and the Vite builder, so we can't automigrate for you, as you are using another framework and builder combination.
|
|
217
239
|
|
|
218
|
-
If you are interested in using this package, see: ${
|
|
219
|
-
`),null;let builder=main.getFieldValue(["core","builder"]);return["@storybook/builder-vite","storybook-builder-vite"].includes(builder)?{main,frameworkOptions,packageJson,dependenciesToRemove:[builder]}:(
|
|
240
|
+
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")}
|
|
241
|
+
`),null;let builder=main.getFieldValue(["core","builder"]);return["@storybook/builder-vite","storybook-builder-vite"].includes(builder)?{main,frameworkOptions,packageJson,dependenciesToRemove:[builder]}:(logger14.warn(dedent17`
|
|
220
242
|
We've detected you are using Storybook in a SvelteKit project.
|
|
221
243
|
|
|
222
244
|
In Storybook 7, we introduced a new framework package for SvelteKit projects: @storybook/sveltekit.
|
|
223
245
|
|
|
224
246
|
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.
|
|
225
247
|
|
|
226
|
-
If you are interested in using this package, see: ${
|
|
227
|
-
`),null)},prompt(){return
|
|
248
|
+
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")}
|
|
249
|
+
`),null)},prompt(){return dedent17`
|
|
228
250
|
We've detected you are using Storybook in a SvelteKit project.
|
|
229
251
|
|
|
230
252
|
In Storybook 7, we introduced a new framework package for SvelteKit projects: @storybook/sveltekit
|
|
@@ -232,9 +254,9 @@ Add a project and re-run the installation`)}async function getBaseTsConfigName()
|
|
|
232
254
|
|
|
233
255
|
We can automatically migrate your project to use the new SvelteKit framework package.
|
|
234
256
|
|
|
235
|
-
To learn more about this change, see: ${
|
|
236
|
-
`},async run({result:{main,frameworkOptions,packageJson,dependenciesToRemove},packageManager,dryRun}){if(
|
|
237
|
-
`);return
|
|
257
|
+
To learn more about this change, see: ${chalk18.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#sveltekit-needs-the-storybooksveltekit-framework")}
|
|
258
|
+
`},async run({result:{main,frameworkOptions,packageJson,dependenciesToRemove},packageManager,dryRun}){if(logger14.info(`\u2705 Removing redundant packages: ${dependenciesToRemove.join(", ")}`),dryRun||packageManager.removeDependencies({skipInstall:!0,packageJson},dependenciesToRemove),logger14.info("\u2705 Installing new dependencies: @storybook/sveltekit"),!dryRun){let versionToInstall=getStorybookVersionSpecifier(packageJson);packageManager.addDependencies({installAsDevDependencies:!0,packageJson},[`@storybook/sveltekit@${versionToInstall}`])}logger14.info("\u2705 Updating framework field in main.js"),frameworkOptions?(main.setFieldValue(["framework","options"],frameworkOptions),main.setFieldValue(["framework","name"],"@storybook/sveltekit")):main.setFieldValue(["framework"],"@storybook/sveltekit");let currentCore=main.getFieldValue(["core"]);if(currentCore.builder){logger14.info("\u2705 Updating core field in main.js");let{builder,...core}=currentCore;Object.keys(core).length===0?main.removeField(["core"]):main.setFieldValue(["core"],core)}dryRun||await writeConfig8(main)}};import chalk19 from"chalk";import{dedent as dedent18}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=>chalk19.cyan(pkg2)).join(" & "),additionalDependenciesFormatted=additionalDependencies.map(pkg2=>`- ${chalk19.cyan(pkg2)}`).join(`
|
|
259
|
+
`);return dedent18`
|
|
238
260
|
We've detected that you're using ${dependentsFormatted}.
|
|
239
261
|
|
|
240
262
|
Starting in Storybook 7 we now require the following peer dependencies:
|
|
@@ -243,9 +265,9 @@ Add a project and re-run the installation`)}async function getBaseTsConfigName()
|
|
|
243
265
|
|
|
244
266
|
We can add these for you automatically.
|
|
245
267
|
|
|
246
|
-
More info: ${
|
|
247
|
-
`},async run({packageManager,result:{additionalDependencies},dryRun}){dryRun||packageManager.addDependencies({installAsDevDependencies:!0},additionalDependencies)}};var fixes=[cra5,webpack5,angular12,vue3,mainjsFramework,eslintPlugin,sveltekitFramework,builderVite,sbBinary,sbScripts,newFrameworks,removedGlobalClientAPIs,mdx1to2,docsPageAutomatic,addReact];var
|
|
248
|
-
`),codeLog(["sb init [options] -f"]),
|
|
268
|
+
More info: ${chalk19.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#react-peer-dependencies-required")}
|
|
269
|
+
`},async run({packageManager,result:{additionalDependencies},dryRun}){dryRun||packageManager.addDependencies({installAsDevDependencies:!0},additionalDependencies)}};var fixes=[cra5,webpack5,angular12,vue3,mainjsFramework,eslintPlugin,sveltekitFramework,builderVite,sbBinary,sbScripts,newFrameworks,nextjsFramework,removedGlobalClientAPIs,mdx1to2,docsPageAutomatic,addReact];var logger15=console;var automigrate=async({fixId:fixId2,dryRun,yes,useNpm,force}={})=>{let packageManager=JsPackageManagerFactory.getPackageManager({useNpm,force}),filtered=fixId2?fixes.filter(f=>f.id===fixId2):fixes;logger15.info("\u{1F50E} checking possible migrations..");let fixResults={};for(let i=0;i<filtered.length;i+=1){let f=fixes[i],result,fixStatus;try{result=await f.check({packageManager})}catch{fixStatus="check_failed",logger15.info(`failed to check fix: ${f.id}`)}if(!result)fixStatus="unnecessary";else{logger15.info(`\u{1F50E} found a '${chalk20.cyan(f.id)}' migration:`),logger15.info();let message=f.prompt(result);logger15.info(boxen(message,{borderStyle:"round",padding:1,borderColor:"#F1618C"}));let runAnswer;if(dryRun?runAnswer={fix:!1}:yes?runAnswer={fix:!0}:runAnswer=await prompts2({type:"confirm",name:"fix",message:`Do you want to run the '${chalk20.cyan(f.id)}' migration on your project?`,initial:!0}),runAnswer.fix)try{await f.run({result,packageManager,dryRun}),logger15.info(`\u2705 ran ${chalk20.cyan(f.id)} migration`),fixStatus="succeeded"}catch(error){fixStatus="failed",logger15.info(`\u274C error when running ${chalk20.cyan(f.id)} migration:`),logger15.info(error),logger15.info()}else fixStatus="skipped",logger15.info(`Skipping the ${chalk20.cyan(f.id)} migration.`),logger15.info(),logger15.info(`If you change your mind, run '${chalk20.cyan("npx storybook@next automigrate")}'`)}fixResults[f.id]=fixStatus}return logger15.info(),logger15.info("\u2705 migration check successfully ran"),logger15.info(),fixResults};var logger16=console,installStorybook=(projectType,packageManager,options)=>{let npmOptions={installAsDevDependencies:!0,skipInstall:options.skipInstall},packageJson;try{packageJson=packageManager.readPackageJson()}catch{}let generatorOptions={language:detectLanguage(packageJson),builder:options.builder||detectBuilder(packageManager),linkable:!!options.linkable,commonJs:options.commonJs,pnp:options.usePnp};return(async()=>{switch(projectType){case"ALREADY_HAS_STORYBOOK":return logger16.log(),paddedLog("There seems to be a Storybook already available in this project."),paddedLog(`Apply following command to force:
|
|
270
|
+
`),codeLog(["sb init [options] -f"]),logger16.log(),Promise.resolve();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
|
|
249
271
|
`));case"REACT_NATIVE":return(options.yes?Promise.resolve({server:!0}):prompts3([{type:"confirm",name:"server",message:"Do you want to install dependencies necessary to run Storybook server? You can manually do it later by install @storybook/react-native-server",initial:!1}])).then(({server})=>REACT_NATIVE_default(packageManager,npmOptions,server)).then(commandLog(`Adding Storybook support to your "React Native" app
|
|
250
272
|
`));case"WEBPACK_REACT":return WEBPACK_REACT_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Webpack React" app
|
|
251
273
|
`));case"REACT_PROJECT":return REACT_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "React" library
|
|
@@ -267,82 +289,82 @@ Add a project and re-run the installation`)}async function getBaseTsConfigName()
|
|
|
267
289
|
`));case"RAX":return RAX_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Rax" app
|
|
268
290
|
`));case"AURELIA":return AURELIA_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Aurelia" app
|
|
269
291
|
`));case"SERVER":return SERVER_default(packageManager,npmOptions,generatorOptions).then(commandLog(`Adding Storybook support to your "Server" app
|
|
270
|
-
`));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"),
|
|
271
|
-
${
|
|
292
|
+
`));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"),logger16.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"),logger16.log(),projectTypeInquirer(options,packageManager)}})().catch(ex=>{logger16.error(`
|
|
293
|
+
${chalk21.red(ex.stack)}`),process.exit(1)})},projectTypeInquirer=async(options,packageManager)=>{let manualAnswer=options.yes?!0:await prompts3([{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 prompts3([{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{useNpm,packageManager:pkgMgr}=options;useNpm&&useNpmWarning();let packageManager=JsPackageManagerFactory.getPackageManager({useNpm,force:pkgMgr}),welcomeMessage="storybook init - the simplest way to add a Storybook to your project.";logger16.log(chalk21.inverse(`
|
|
272
294
|
${welcomeMessage}
|
|
273
|
-
`));let{default:updateNotifier}=await import("update-notifier");updateNotifier({pkg:pkg2,updateCheckInterval:1e3*60*60}).notify();let projectType,projectTypeProvided=options.type,infoText=projectTypeProvided?`Installing Storybook for user specified project type: ${projectTypeProvided}`:"Detecting project type",done=commandLog(infoText),packageJson=packageManager.retrievePackageJson(),isEsm=packageJson&&packageJson.type==="module";try{projectTypeProvided?installableProjectTypes.includes(projectTypeProvided)?projectType=isStorybookInstalled(packageJson,options.force)?"ALREADY_HAS_STORYBOOK":projectTypeProvided.toUpperCase():(done(`The provided project type was not recognized by Storybook: ${projectTypeProvided}`),
|
|
295
|
+
`));let{default:updateNotifier}=await import("update-notifier");updateNotifier({pkg:pkg2,updateCheckInterval:1e3*60*60}).notify();let projectType,projectTypeProvided=options.type,infoText=projectTypeProvided?`Installing Storybook for user specified project type: ${projectTypeProvided}`:"Detecting project type",done=commandLog(infoText),packageJson=packageManager.retrievePackageJson(),isEsm=packageJson&&packageJson.type==="module";try{projectTypeProvided?installableProjectTypes.includes(projectTypeProvided)?projectType=isStorybookInstalled(packageJson,options.force)?"ALREADY_HAS_STORYBOOK":projectTypeProvided.toUpperCase():(done(`The provided project type was not recognized by Storybook: ${projectTypeProvided}`),logger16.log(`
|
|
274
296
|
The project types currently supported by Storybook are:
|
|
275
|
-
`),installableProjectTypes.sort().forEach(framework=>paddedLog(`- ${framework}`)),
|
|
297
|
+
`),installableProjectTypes.sort().forEach(framework=>paddedLog(`- ${framework}`)),logger16.log(),process.exit(1)):projectType=detect(packageJson,options)}catch(ex){done(ex.message),process.exit(1)}if(done(),await installStorybook(projectType,packageManager,{...options,...isEsm?{commonJs:!0}:void 0}),options.skipInstall||packageManager.installDependencies(),options.disableTelemetry||telemetry("init",{projectType}),await automigrate({yes:options.yes||process.env.CI==="true",useNpm,force:pkgMgr}),logger16.log(`
|
|
276
298
|
To run your Storybook, type:
|
|
277
|
-
`),codeLog([packageManager.getRunStorybookCommand()]),
|
|
278
|
-
For more information visit:`,
|
|
279
|
-
`),codeLog(["export {default} from './storybook';"]),
|
|
299
|
+
`),codeLog([packageManager.getRunStorybookCommand()]),logger16.log(`
|
|
300
|
+
For more information visit:`,chalk21.cyan("https://storybook.js.org")),projectType==="REACT_NATIVE"){let REACT_NATIVE_REPO="https://github.com/storybookjs/react-native";logger16.log(),logger16.log(chalk21.red("NOTE: installation is not 100% automated.")),logger16.log(`To quickly run Storybook, replace contents of your app entry with:
|
|
301
|
+
`),codeLog(["export {default} from './storybook';"]),logger16.log(`
|
|
280
302
|
For more in information, see the github readme:
|
|
281
|
-
`),
|
|
303
|
+
`),logger16.log(chalk21.cyan(REACT_NATIVE_REPO)),logger16.log()}logger16.log()}async function initiate(options,pkg2){await withTelemetry("init",{cliOptions:options},()=>doInitiate(options,pkg2))}import path9 from"path";import fs6 from"fs";import{sync as spawnSync3}from"cross-spawn";import{getStorybookInfo as getStorybookInfo12}from"@storybook/core-common";import{readConfig as readConfig9,writeConfig as writeConfig9}from"@storybook/csf-tools";var logger17=console,LEGACY_CONFIGS=["addons","config","presets"],postinstallAddon=async(addonName,isOfficialAddon)=>{let skipMsg=null;isOfficialAddon?fs6.existsSync(".storybook")?(skipMsg="no codmods found",LEGACY_CONFIGS.forEach(config=>{try{let codemod=__require.resolve(`${getPackageName(addonName,isOfficialAddon)}/postinstall/${config}.js`);commandLog(`Running postinstall script for ${addonName}`)();let configFile=path9.join(".storybook",`${config}.ts`);fs6.existsSync(configFile)||(configFile=path9.join(".storybook",`${config}.js`),fs6.existsSync(configFile)||fs6.writeFileSync(configFile,"","utf8")),spawnSync3("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{useNpm,packageManager:pkgMgr}=options;useNpm&&useNpmWarning();let packageManager=JsPackageManagerFactory.getPackageManager({useNpm,force:pkgMgr}),packageJson=packageManager.retrievePackageJson(),[addonName,versionSpecifier]=getVersionSpecifier(addon),{mainConfig,version:storybookVersion}=getStorybookInfo12(packageJson);if(!mainConfig){logger17.error("Unable to find storybook main.js config");return}let main=await readConfig9(mainConfig),addons=main.getFieldValue(["addons"]);addons&&!Array.isArray(addons)&&logger17.error("Expected addons array in main.js config"),logger17.log(`Verifying ${addonName}`);let latestVersion=packageManager.latestVersion(addonName);latestVersion||logger17.error(`Unknown addon ${addonName}`);let isStorybookAddon=addonName.startsWith("@storybook/"),addonWithVersion=`${addonName}@${versionSpecifier||(isStorybookAddon?storybookVersion:latestVersion)}`;logger17.log(`Installing ${addonWithVersion}`),packageManager.addDependencies({installAsDevDependencies:!0},[addonWithVersion]),logger17.log(`Adding '${addon}' to main.js addons field.`);let updatedAddons=[...addons||[],addonName];main.setFieldValue(["addons"],updatedAddons),await writeConfig9(main),options.skipPostinstall||await postinstallAddon(addon,isStorybookAddon)}import{listCodemods,runCodemod}from"@storybook/codemod";async function migrate(migration,{glob,dryRun,list,rename,logger:logger28,parser}){if(list)listCodemods().forEach(key=>logger28.log(key));else if(migration)await runCodemod(migration,{glob,dryRun,logger:logger28,rename,parser});else throw new Error("Migrate: please specify a migration name or --list")}import path10 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 logger18}from"@storybook/node-logger";var read=async url=>{let browser=await usePuppeteerBrowser(),page=await browser.newPage();await page.goto(url),await page.waitForFunction(`
|
|
282
304
|
(window.__STORYBOOK_PREVIEW__ && window.__STORYBOOK_PREVIEW__.extract && window.__STORYBOOK_PREVIEW__.extract()) ||
|
|
283
305
|
(window.__STORYBOOK_STORY_STORE__ && window.__STORYBOOK_STORY_STORE__.extract && window.__STORYBOOK_STORY_STORE__.extract())
|
|
284
|
-
`);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(path10.resolve(input)),input.match(/^http/))return[input,async()=>{}];let app=express();app.use(express.static(input));let port=await getPort();return new Promise(resolve2=>{let server=app.listen(port,()=>{let result=`http://localhost:${port}/iframe.html`;
|
|
285
|
-
`).map(getStorybookVersion).filter(Boolean).filter(pkg2=>isCorePackage(pkg2.package));if(!storybookPackages.length){
|
|
306
|
+
`);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(path10.resolve(input)),input.match(/^http/))return[input,async()=>{}];let app=express();app.use(express.static(input));let port=await getPort();return new Promise(resolve2=>{let server=app.listen(port,()=>{let result=`http://localhost:${port}/iframe.html`;logger18.info(`connecting to: ${result}`),resolve2([result,server.close.bind(server)])})})},usePuppeteerBrowser=async()=>{let args=["--no-sandbox ","--disable-setuid-sandbox"];try{return await puppeteerCore.launch({args,executablePath:process.env.SB_CHROMIUM_PATH})}catch{return logger18.info("installing puppeteer..."),new Promise((resolve2,reject)=>{__require("child_process").exec(`node ${__require.resolve(path10.join("puppeteer-core","install.js"))}`,error=>error?reject(error):resolve2(puppeteerCore.launch({args})))})}};async function extract(input,targetPath){if(input&&targetPath){let[location,exit]=await useLocation(input),data=await read(location);await 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 spawnSync4}from"cross-spawn";import{telemetry as telemetry2,getStorybookCoreVersion}from"@storybook/telemetry";import semver15 from"semver";import{logger as logger19}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||!semver15.clean(match[2])?null:{package:match[1],version:match[2]}},excludeList=["@storybook/addon-bench","@storybook/addon-console","@storybook/addon-postcss","@storybook/babel-plugin-require-context-hook","@storybook/bench","@storybook/builder-vite","@storybook/csf","@storybook/design-system","@storybook/ember-cli-storybook","@storybook/eslint-config-storybook","@storybook/expect","@storybook/jest","@storybook/linter-config","@storybook/mdx1-csf","@storybook/mdx2-csf","@storybook/react-docgen-typescript-plugin","@storybook/storybook-deployer","@storybook/test-runner","@storybook/testing-library","@storybook/testing-react"],isCorePackage=pkg2=>pkg2.startsWith("@storybook/")&&!pkg2.startsWith("@storybook/preset-")&&!excludeList.includes(pkg2),deprecatedPackages=[{minVersion:"6.0.0-alpha.0",url:"https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#60-deprecations",deprecations:["@storybook/addon-notes","@storybook/addon-info","@storybook/addon-contexts","@storybook/addon-options","@storybook/addon-centered"]}],formatPackage=pkg2=>`${pkg2.package}@${pkg2.version}`,warnPackages=pkgs=>pkgs.forEach(pkg2=>logger19.warn(`- ${formatPackage(pkg2)}`)),checkVersionConsistency=()=>{let storybookPackages=spawnSync4("npm",["ls"],{stdio:"pipe",shell:!0}).output.toString().split(`
|
|
307
|
+
`).map(getStorybookVersion).filter(Boolean).filter(pkg2=>isCorePackage(pkg2.package));if(!storybookPackages.length){logger19.warn("No storybook core packages found."),logger19.warn("'npm ls | grep storybook' can show if multiple versions are installed.");return}storybookPackages.sort((a,b)=>semver15.rcompare(a.version,b.version));let latestVersion=storybookPackages[0].version,outdated=storybookPackages.filter(pkg2=>pkg2.version!==latestVersion);outdated.length>0&&(logger19.warn(`Found ${outdated.length} outdated packages (relative to '${formatPackage(storybookPackages[0])}')`),logger19.warn("Please make sure your packages are updated to ensure a consistent experience."),warnPackages(outdated)),deprecatedPackages.forEach(({minVersion:minVersion2,url,deprecations})=>{if(semver15.gte(latestVersion,minVersion2)){let deprecated=storybookPackages.filter(pkg2=>deprecations.includes(pkg2.package));deprecated.length>0&&(logger19.warn(`Found ${deprecated.length} deprecated packages since ${minVersion2}`),logger19.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&&semver15.satisfies(semver15.coerce(pkgVersion),specifier)?[...acc,...extra]:acc},[...flags]),doUpgrade=async({tag,prerelease,skipCheck,useNpm,packageManager:pkgMgr,dryRun,yes,...options})=>{useNpm&&useNpmWarning();let packageManager=JsPackageManagerFactory.getPackageManager({useNpm,force:pkgMgr}),beforeVersion=await getStorybookCoreVersion();if(commandLog("Checking for latest versions of '@storybook/*' packages"),tag&&prerelease)throw new Error("Cannot set both --tag and --prerelease. Use --tag next to get the latest prereleae");let target="latest";prerelease?target="@next":tag&&(target=`@${tag}`);let flags=[];dryRun||flags.push("--upgrade"),flags.push("--target"),flags.push(target),flags=addExtraFlags(EXTRA_FLAGS,flags,packageManager.retrievePackageJson());let check=spawnSync4("npx",["npm-check-updates@latest","/storybook/",...flags],{stdio:"pipe",shell:!0}).output.toString();logger19.info(check);let checkSb=spawnSync4("npx",["npm-check-updates@latest","sb",...flags],{stdio:"pipe",shell:!0}).output.toString();logger19.info(checkSb),dryRun||(commandLog("Installing upgrades"),packageManager.installDependencies());let automigrationResults;if(skipCheck||(checkVersionConsistency(),automigrationResults=await automigrate({dryRun,yes,useNpm,force:pkgMgr})),!options.disableTelemetry){let afterVersion=await getStorybookCoreVersion();telemetry2("upgrade",{prerelease,tag,automigrationResults,beforeVersion,afterVersion})}};async function upgrade(options){await withTelemetry2("upgrade",{cliOptions:options},()=>doUpgrade(options))}import prompts4 from"prompts";import fs7 from"fs";import path12 from"path";import chalk23 from"chalk";import boxen2 from"boxen";import{dedent as dedent19}from"ts-dedent";import path11 from"path";import{readJSON,writeJSON,outputFile}from"fs-extra";import shell2 from"shelljs";import chalk22 from"chalk";import{command}from"execa";var configs_exports={};__export(configs_exports,{angular:()=>angular,angular12:()=>angular122,angular13:()=>angular13,angular130:()=>angular130,cra:()=>cra,cra_typescript:()=>cra_typescript,html:()=>html,nextjs:()=>nextjs,nextjs_typescript:()=>nextjs_typescript,preact:()=>preact,react:()=>react,react_in_yarn_workspace:()=>react_in_yarn_workspace,react_legacy_root_api:()=>react_legacy_root_api,react_typescript:()=>react_typescript,sfcVue:()=>sfcVue,svelte:()=>svelte,svelteKit:()=>svelteKit,vue:()=>vue,vue3:()=>vue32,web_components:()=>web_components,web_components_lit2:()=>web_components_lit2,web_components_typescript:()=>web_components_typescript});var fromDeps=(...args)=>["mkdir {{appName}}","cd {{appName}}","touch yarn.lock","yarn init --yes",args.length&&`yarn add ${args.join(" ")}`].filter(Boolean).join(" && "),cra={renderer:"react",name:"cra",version:"latest",generator:["npm_config_user_agent=npm npx -p create-react-app@{{version}} create-react-app {{appName}}","cd {{appName}}",'echo "FAST_REFRESH=true" > .env','echo "SKIP_PREFLIGHT_CHECK=true" > .env'].join(" && ")},cra_typescript={renderer:"react",name:"cra_typescript",version:"latest",generator:["npm_config_user_agent=npm npx -p create-react-app@{{version}} create-react-app {{appName}} --template typescript"].join(" && ")},react={renderer:"react",name:"react",version:"latest",generator:fromDeps("react","react-dom","@babel/preset-react"),additionalDeps:["prop-types"],additionalFiles:[{path:".babelrc",contents:'{ "presets": ["@babel/preset-react"] }'}]},react_legacy_root_api={renderer:"react",name:"react_legacy_root_api",version:"latest",generator:fromDeps("react","react-dom"),additionalDeps:["prop-types","@babel/preset-react"],additionalFiles:[{path:".babelrc",contents:'{ "presets": ["@babel/preset-react"] }'}],mainOverrides:{reactOptions:{legacyRootApi:!0}}},react_typescript={renderer:"react",name:"react_typescript",version:"latest",generator:fromDeps("react","react-dom"),typescript:!0,additionalDeps:["@babel/preset-react","@babel/preset-typescript"],additionalFiles:[{path:".babelrc",contents:'{ "presets": ["@babel/preset-react", "@babel/preset-typescript"] }'}]},nextjs={renderer:"react",name:"nextjs",version:"latest",generator:["npm_config_user_agent=npm npx -p create-next-app@{{version}} create-next-app {{appName}}","cd {{appName}}"].join(" && ")},nextjs_typescript={renderer:"react",name:"nextjs_typescript",version:"latest",generator:["npm_config_user_agent=npm npx -p create-next-app@{{version}} create-next-app {{appName}} --typescript","cd {{appName}}"].join(" && ")},react_in_yarn_workspace={renderer:"react",name:"react_in_yarn_workspace",version:"latest",generator:["mkdir {{appName}}","cd {{appName}}",'echo "{ \\"name\\": \\"workspace-root\\", \\"private\\": true, \\"workspaces\\": [] }" > package.json',"touch yarn.lock","yarn add react react-dom"].join(" && ")},baseAngular={renderer:"angular",name:"angular",version:"latest",generator:"npx -p @angular/cli@{{version}} ng new {{appName}} --routing=true --minimal=true --style=scss --skip-install=true --strict"},angular122={...baseAngular,name:"angular12",version:"v12-lts"},angular130={...baseAngular,name:"angular130",version:"13.0.x"},angular13={...baseAngular,name:"angular13",version:"13.1.x"},angular=baseAngular,web_components={renderer:"web-components",name:"web_components",version:"2",generator:fromDeps("lit-element")},web_components_typescript={...web_components,name:"web_components_typescript",typescript:!0,additionalDeps:["@babel/preset-typescript"],additionalFiles:[{path:".babelrc",contents:'{ "presets": ["@babel/preset-typescript"] }'}]},web_components_lit2={...web_components,version:"next",name:"web_components_lit2",generator:fromDeps("lit"),typescript:!0,additionalDeps:["@babel/preset-typescript"],additionalFiles:[{path:".babelrc",contents:'{ "presets": ["@babel/preset-typescript"] }'}]},vue={renderer:"vue",name:"vue",version:"latest",generator:['npx -p @vue/cli vue create {{appName}} --default --packageManager=yarn --force --merge --preset="Default (Vue 2)"'].join(" && ")},vue32={renderer:"vue3",name:"vue3",version:"next",generator:["npx -p @vue/cli@^4 vue create {{appName}} --preset=__default_vue_3__ --packageManager=npm --no-git --force"].join(" && ")},html={renderer:"html",name:"html",version:"latest",generator:fromDeps(),autoDetect:!1},preact={renderer:"preact",name:"preact",version:"latest",generator:"npx preact-cli@{{version}} create preactjs-templates/default {{appName}} --install=false --git=false"},sfcVue={renderer:"vue",name:"sfcVue",version:"latest",generator:fromDeps("vue@2.6","vue-loader@15.9","vue-template-compiler@2.6","webpack")},svelte={renderer:"svelte",name:"svelte",version:"latest",generator:"npx giget github:sveltejs/template#master {{appName}}"},svelteKit={renderer:"svelte",name:"svelteKit",version:"latest",generator:"yarn create svelte-with-args --name={{appName}} --directory=. --template=skeleton --types=null --no-prettier --no-eslint --no-playwright"};var logger20=console,exec=async(command2,options={},{startMessage,errorMessage,dryRun}={})=>{if(startMessage&&logger20.info(startMessage),dryRun){logger20.info(`
|
|
286
308
|
> ${command2}
|
|
287
|
-
`);return}return
|
|
288
|
-
`).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})=>{
|
|
289
|
-
🤗 Welcome to ${
|
|
309
|
+
`);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(`
|
|
310
|
+
`).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(dedent19`
|
|
311
|
+
🤗 Welcome to ${chalk23.yellow("sb repro")}! 🤗
|
|
290
312
|
|
|
291
|
-
Create a ${
|
|
313
|
+
Create a ${chalk23.green("new project")} to minimally reproduce Storybook issues.
|
|
292
314
|
|
|
293
315
|
1. select an environment that most closely matches your project setup.
|
|
294
316
|
2. select a location for the reproduction, outside of your project.
|
|
295
317
|
|
|
296
318
|
After the reproduction is ready, we'll guide you through the next steps.
|
|
297
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),list){
|
|
319
|
+
`.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(dedent19`
|
|
298
320
|
🎉 Your Storybook reproduction project is ready to use! 🎉
|
|
299
321
|
|
|
300
|
-
${
|
|
301
|
-
${
|
|
322
|
+
${chalk23.yellow(`cd ${selectedDirectory}`)}
|
|
323
|
+
${chalk23.yellow("yarn storybook")}
|
|
302
324
|
|
|
303
325
|
Once you've recreated the problem you're experiencing, please:
|
|
304
326
|
|
|
305
|
-
1. Document any additional steps in ${
|
|
327
|
+
1. Document any additional steps in ${chalk23.cyan("README.md")}
|
|
306
328
|
2. Publish the repository to github
|
|
307
329
|
3. Link to the repro repository in your issue
|
|
308
330
|
|
|
309
331
|
Having a clean repro helps us solve your issue faster! 🙏
|
|
310
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}))}catch(error){throw
|
|
332
|
+
`.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 dedent20}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';
|
|
311
333
|
|
|
312
334
|
export default {
|
|
313
335
|
plugins: [vue2()]
|
|
314
|
-
};" > vite.config.js`,skipTasks:["smoke-test"],expected:{framework:"@storybook/vue-vite",renderer:"@storybook/vue",builder:"@storybook/builder-vite"}},"html-webpack/default":{name:"HTML Webpack5",script:"yarn create webpack5-html .",expected:{framework:"@storybook/html-webpack5",renderer:"@storybook/html",builder:"@storybook/builder-webpack5"}},"html-vite/default-js":{name:"HTML Vite JS",script:'yarn create vite . --template vanilla && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/html-vite",renderer:"@storybook/html",builder:"@storybook/builder-vite"},inDevelopment:!0},"html-vite/default-ts":{name:"HTML Vite TS",script:'yarn create vite . --template vanilla-ts && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/html-vite",renderer:"@storybook/html",builder:"@storybook/builder-vite"},inDevelopment:!0},"svelte-vite/default-js":{name:"Svelte Vite (JS)",script:"yarn create vite . --template svelte",expected:{framework:"@storybook/svelte-vite",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"}},"svelte-vite/default-ts":{name:"Svelte Vite (TS)",script:"yarn create vite . --template svelte-ts",skipTasks:["smoke-test"],expected:{framework:"@storybook/svelte-vite",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"}},"angular-cli/default-ts":{name:"Angular CLI (latest)",script:"npx -p @angular/cli ng new angular-latest --directory . --routing=true --minimal=true --style=scss --strict --skip-git --skip-install --package-manager=yarn",expected:{framework:"@storybook/angular",renderer:"@storybook/angular",builder:"@storybook/builder-webpack5"}},"angular-cli/14-ts":{name:"Angular CLI (Version 14)",script:"npx -p @angular/cli@14 ng new angular-v14 --directory . --routing=true --minimal=true --style=scss --strict --skip-git --skip-install --package-manager=yarn",expected:{framework:"@storybook/angular",renderer:"@storybook/angular",builder:"@storybook/builder-webpack5"}},"angular-cli/13-ts":{name:"Angular CLI (Version 13)",script:"npx -p @angular/cli@13 ng new angular-v13 --directory . --routing=true --minimal=true --style=scss --strict --skip-git --skip-install --package-manager=yarn",expected:{framework:"@storybook/angular",renderer:"@storybook/angular",builder:"@storybook/builder-webpack5"}},"svelte-kit/skeleton-js":{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"}}},ci=["cra/default-ts","react-vite/default-ts"],pr=[...ci,"angular-cli/default-ts","vue3-vite/default-ts","vue-cli/vue2-default-js","lit-vite/default-ts","svelte-vite/default-ts","svelte-kit/skeleton-ts","nextjs/default-ts"],merged=[...pr,"react-webpack/18-ts","react-webpack/17-ts","angular-cli/14-ts","angular-cli/13-ts","preact-webpack5/default-ts","html-webpack/default"],daily=[...merged,"cra/default-js","react-vite/default-js","vue3-vite/default-js","vue2-vite/2.7-js","vue-cli/default-js","lit-vite/default-js","svelte-kit/skeleton-js","svelte-vite/default-js","nextjs/default-js","preact-webpack5/default-js"];var
|
|
336
|
+
};" > vite.config.js`,skipTasks:["smoke-test"],expected:{framework:"@storybook/vue-vite",renderer:"@storybook/vue",builder:"@storybook/builder-vite"}},"html-webpack/default":{name:"HTML Webpack5",script:"yarn create webpack5-html .",expected:{framework:"@storybook/html-webpack5",renderer:"@storybook/html",builder:"@storybook/builder-webpack5"}},"html-vite/default-js":{name:"HTML Vite JS",script:'yarn create vite . --template vanilla && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/html-vite",renderer:"@storybook/html",builder:"@storybook/builder-vite"},inDevelopment:!0},"html-vite/default-ts":{name:"HTML Vite TS",script:'yarn create vite . --template vanilla-ts && echo "export default {}" > vite.config.js',expected:{framework:"@storybook/html-vite",renderer:"@storybook/html",builder:"@storybook/builder-vite"},inDevelopment:!0},"svelte-vite/default-js":{name:"Svelte Vite (JS)",script:"yarn create vite . --template svelte",expected:{framework:"@storybook/svelte-vite",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"}},"svelte-vite/default-ts":{name:"Svelte Vite (TS)",script:"yarn create vite . --template svelte-ts",skipTasks:["smoke-test"],expected:{framework:"@storybook/svelte-vite",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"}},"angular-cli/default-ts":{name:"Angular CLI (latest)",script:"npx -p @angular/cli ng new angular-latest --directory . --routing=true --minimal=true --style=scss --strict --skip-git --skip-install --package-manager=yarn",expected:{framework:"@storybook/angular",renderer:"@storybook/angular",builder:"@storybook/builder-webpack5"}},"angular-cli/14-ts":{name:"Angular CLI (Version 14)",script:"npx -p @angular/cli@14 ng new angular-v14 --directory . --routing=true --minimal=true --style=scss --strict --skip-git --skip-install --package-manager=yarn",expected:{framework:"@storybook/angular",renderer:"@storybook/angular",builder:"@storybook/builder-webpack5"}},"angular-cli/13-ts":{name:"Angular CLI (Version 13)",script:"npx -p @angular/cli@13 ng new angular-v13 --directory . --routing=true --minimal=true --style=scss --strict --skip-git --skip-install --package-manager=yarn",expected:{framework:"@storybook/angular",renderer:"@storybook/angular",builder:"@storybook/builder-webpack5"}},"svelte-kit/skeleton-js":{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"}}},ci=["cra/default-ts","react-vite/default-ts"],pr=[...ci,"angular-cli/default-ts","vue3-vite/default-ts","vue-cli/vue2-default-js","lit-vite/default-ts","svelte-vite/default-ts","svelte-kit/skeleton-ts","nextjs/default-ts"],merged=[...pr,"react-webpack/18-ts","react-webpack/17-ts","angular-cli/14-ts","angular-cli/13-ts","preact-webpack5/default-ts","html-webpack/default"],daily=[...merged,"cra/default-js","react-vite/default-js","vue3-vite/default-js","vue2-vite/2.7-js","vue-cli/default-js","lit-vite/default-js","svelte-kit/skeleton-js","svelte-vite/default-js","nextjs/12-js","nextjs/default-js","preact-webpack5/default-js"];var logger22=console,toChoices=c=>({title:allTemplates[c].name,value:c}),reproNext=async({output:outputDirectory,filterValue,branch,init})=>{let keys=Object.keys(allTemplates),choices=keys.reduce((acc,group)=>{let current=allTemplates[group],filterRegex=new RegExp(filterValue,"i");return(!filterValue||current.name.match(filterRegex)||group.match(filterRegex)||current.expected.builder.match(filterRegex)||current.expected.framework.match(filterRegex)||current.expected.renderer.match(filterRegex))&&acc.push(group),acc},[]);choices.length===0&&(logger22.info(boxen3(dedent20`
|
|
315
337
|
🔎 You filtered out all templates. 🔍
|
|
316
338
|
|
|
317
|
-
After filtering all the templates with "${
|
|
339
|
+
After filtering all the templates with "${chalk24.yellow(filterValue)}", we found no results. Please try again with a different filter.
|
|
318
340
|
|
|
319
341
|
Available templates:
|
|
320
|
-
${keys.map(key=>
|
|
342
|
+
${keys.map(key=>chalk24.blue`- ${key}`).join(`
|
|
321
343
|
`)}
|
|
322
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),process.exit(1));let selectedTemplate=null;if(choices.length===1?[selectedTemplate]=choices:(
|
|
323
|
-
🤗 Welcome to ${
|
|
344
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),process.exit(1));let selectedTemplate=null;if(choices.length===1?[selectedTemplate]=choices:(logger22.info(boxen3(dedent20`
|
|
345
|
+
🤗 Welcome to ${chalk24.yellow("sb repro NEXT")}! 🤗
|
|
324
346
|
|
|
325
|
-
Create a ${
|
|
347
|
+
Create a ${chalk24.green("new project")} to minimally reproduce Storybook issues.
|
|
326
348
|
|
|
327
349
|
1. select an environment that most closely matches your project setup.
|
|
328
350
|
2. select a location for the reproduction, outside of your project.
|
|
329
351
|
|
|
330
352
|
After the reproduction is ready, we'll guide you through the next steps.
|
|
331
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),selectedTemplate=await promptSelectedTemplate(choices)),!!!(selectedTemplate??null)){
|
|
332
|
-
yarn storybook`):`Recreate your setup, then ${
|
|
353
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),selectedTemplate=await promptSelectedTemplate(choices)),!!!(selectedTemplate??null)){logger22.error("Somehow we got no templates. Please rerun this command!");return}let selectedConfig=allTemplates[selectedTemplate];if(!selectedConfig)throw new Error("\u{1F6A8} Repro: please specify a valid template type");let selectedDirectory=outputDirectory,outputDirectoryName=outputDirectory||selectedTemplate;if(selectedDirectory&&existsSync2(`${selectedDirectory}`)&&logger22.info(`\u26A0\uFE0F ${selectedDirectory} already exists! Overwriting...`),!selectedDirectory){let{directory}=await prompts5({type:"text",message:"Enter the output directory",name:"directory",initial:outputDirectoryName,validate:async directoryName=>existsSync2(directoryName)?`${directoryName} already exists. Please choose another name.`:!0});selectedDirectory=directory}try{let templateDestination=path13.isAbsolute(selectedDirectory)?selectedDirectory:path13.join(process.cwd(),selectedDirectory);logger22.info(`\u{1F3C3} Adding ${selectedConfig.name} into ${templateDestination}`),logger22.log("\u{1F4E6} Downloading repro template...");try{await downloadTemplate(`github:storybookjs/repro-templates-temp/${selectedTemplate}/${init?"after-storybook":"before-storybook"}#${branch}`,{force:!0,dir:templateDestination})}catch(err){throw logger22.error(`\u{1F6A8} Failed to download repro template: ${err.message}`),err}let initMessage=init?chalk24.yellow(`yarn install
|
|
354
|
+
yarn storybook`):`Recreate your setup, then ${chalk24.yellow("run npx storybook init")}`;logger22.info(boxen3(dedent20`
|
|
333
355
|
🎉 Your Storybook reproduction project is ready to use! 🎉
|
|
334
356
|
|
|
335
|
-
${
|
|
357
|
+
${chalk24.yellow(`cd ${selectedDirectory}`)}
|
|
336
358
|
${initMessage}
|
|
337
359
|
|
|
338
360
|
Once you've recreated the problem you're experiencing, please:
|
|
339
361
|
|
|
340
|
-
1. Document any additional steps in ${
|
|
362
|
+
1. Document any additional steps in ${chalk24.cyan("README.md")}
|
|
341
363
|
2. Publish the repository to github
|
|
342
364
|
3. Link to the repro repository in your issue
|
|
343
365
|
|
|
344
366
|
Having a clean repro helps us solve your issue faster! 🙏
|
|
345
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}))}catch(error){throw
|
|
367
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}))}catch(error){throw logger22.error("\u{1F6A8} Failed to create repro"),error}};async function promptSelectedTemplate(choices){let{template}=await prompts5({type:"select",message:"\u{1F308} Select the template",name:"template",choices:choices.map(toChoices)});return template||null}import fse6 from"fs-extra";import path14 from"path";import{sync as spawnSync5}from"cross-spawn";import{logger as logger23}from"@storybook/node-logger";var link=async({target,local,start})=>{let storybookDir=process.cwd();try{if((await fse6.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=path14.basename(target);if(!local){let reprosDir=path14.join(storybookDir,"../storybook-repros");logger23.info(`Ensuring directory ${reprosDir}`),await fse6.ensureDir(reprosDir),logger23.info(`Cloning ${target}`),await exec(`git clone ${target}`,{cwd:reprosDir}),reproName=path14.basename(target,path14.extname(target)),reproDir=path14.join(reprosDir,reproName)}let reproPackageJson=await fse6.readJSON(path14.join(reproDir,"package.json")),version=spawnSync5("yarn",["--version"],{cwd:reproDir,stdio:"pipe",shell:!0}).stdout.toString();if(!/^[23]\./.test(version)){logger23.warn(`\u{1F6A8} Expected yarn 2 or 3 in ${reproDir}!`),logger23.warn(""),logger23.warn("Please set it up with `yarn set version berry`,"),logger23.warn(`then link '${reproDir}' with the '--local' flag.`);return}logger23.info(`Linking ${reproDir}`),await exec(`yarn link --all ${storybookDir}`,{cwd:reproDir}),logger23.info(`Installing ${reproName}`),await exec("yarn install",{cwd:reproDir}),logger23.info("Magic stuff related to @storybook/preset-create-react-app, we need to fix peerDependencies"),reproPackageJson.devDependencies?.vite||await exec("yarn add -D webpack-hot-middleware",{cwd:reproDir}),await exec("yarn add @types/node@16",{cwd:reproDir}),start&&(logger23.info(`Running ${reproName} storybook`),await exec("yarn run storybook",{cwd:reproDir}))};import{dedent as dedent22}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";import{logger as logger24}from"@storybook/node-logger";import dedent21 from"ts-dedent";function ensureReactPeerDeps(){try{__require.resolve("react"),__require.resolve("react-dom")}catch{logger24.error(dedent21`
|
|
346
368
|
Starting in 7.0, react and react-dom are now required peer dependencies of Storybook.
|
|
347
369
|
https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#react-peer-dependencies-required
|
|
348
370
|
|
|
@@ -369,15 +391,15 @@ yarn storybook`):`Recreate your setup, then ${chalk23.yellow("run npx storybook
|
|
|
369
391
|
|
|
370
392
|
pnpm:
|
|
371
393
|
$ pnpm add react react-dom --dev
|
|
372
|
-
`),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?
|
|
394
|
+
`),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?dedent22`
|
|
373
395
|
FATAL broken build!, will close the process,
|
|
374
396
|
Fix the error below and restart storybook.
|
|
375
|
-
`:
|
|
397
|
+
`:dedent22`
|
|
376
398
|
Broken build, fix the error above.
|
|
377
399
|
You may need to refresh the browser.
|
|
378
|
-
`),
|
|
379
|
-
Environment Info:`)),envinfo.run({System:["OS","CPU"],Binaries:["Node","Yarn","npm"],Browsers:["Chrome","Edge","Firefox","Safari"],npmPackages:"@storybook/*",npmGlobalPackages:"@storybook/*"}).then(consoleLogger.log)});program.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=>{
|
|
380
|
-
`)),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})});program.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").option("--no-manager-cache","Do not cache the manager UI").action(options=>{process.env.NODE_ENV=process.env.NODE_ENV||"production",
|
|
400
|
+
`),logger25.line(),process.exit(1)}};import{sync as readUpSync2}from"read-pkg-up";import{logger as logger26}from"@storybook/node-logger";import{buildStaticStandalone,withTelemetry as withTelemetry4}from"@storybook/core-server";import{cache as cache2}from"@storybook/core-common";var build=async cliOptions=>{ensureReactPeerDeps();try{let options={...cliOptions,configDir:cliOptions.configDir||"./.storybook",outputDir:cliOptions.outputDir||"./storybook-static",ignorePreview:!!cliOptions.previewUrl&&!cliOptions.forceBuildPreview,docsMode:!!cliOptions.docs,configType:"PRODUCTION",cache:cache2,packageJson:readUpSync2({cwd:__dirname}).packageJson};await withTelemetry4("build",{cliOptions,presetOptions:options},()=>buildStaticStandalone(options))}catch(err){logger26.error(err),process.exit(1)}};function parseList(str){return str.split(",").map(item=>item.trim()).filter(item=>item.length>0)}function getEnvConfig(program2,configEnv){Object.keys(configEnv).forEach(fieldName=>{let envVarName=configEnv[fieldName],envVarValue=process.env[envVarName];envVarValue&&(program2[fieldName]=envVarValue)})}var pkg=readUpSync3({cwd:__dirname}).packageJson,consoleLogger=console;program.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");program.command("init").description("Initialize Storybook into your project.").option("-f --force","Force add Storybook").option("-s --skip-install","Skip installing deps").option("--package-manager <npm|pnpm|yarn1|yarn2>","Force package manager for installing deps").option("-N --use-npm","Use npm to install deps (deprecated)").option("--use-pnp","Enable pnp mode for Yarn 2+").option("-p --parser <babel | babylon | flow | ts | tsx>","jscodeshift parser").option("-t --type <type>","Add Storybook for a specific project type").option("-y --yes","Answer yes to all prompts").option("-b --builder <webpack5 | vite>","Builder library").option("-l --linkable","Prepare installation for link (contributor helper)").action(options=>initiate(options,pkg).catch(err=>{logger27.error(err),process.exit(1)}));program.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));program.command("babelrc").description("generate the default storybook babel config into your current working directory").action(()=>generateStorybookBabelConfigInCWD());program.command("upgrade").description("Upgrade your Storybook packages to the latest").option("--package-manager <npm|pnpm|yarn1|yarn2>","Force package manager for installing dependencies").option("-N --use-npm","Use NPM to install dependencies (deprecated)").option("-y --yes","Skip prompting the user").option("-n --dry-run","Only check for upgrades, do not install").option("-t --tag <tag>","Upgrade to a certain npm dist-tag (e.g. next, prerelease)").option("-p --prerelease","Upgrade to the pre-release packages").option("-s --skip-check","Skip postinstall version and automigration checks").action(options=>upgrade(options));program.command("info").description("Prints debugging information about the local environment").action(()=>{consoleLogger.log(chalk25.bold(`
|
|
401
|
+
Environment Info:`)),envinfo.run({System:["OS","CPU"],Binaries:["Node","Yarn","npm"],Browsers:["Chrome","Edge","Firefox","Safari"],npmPackages:"@storybook/*",npmGlobalPackages:"@storybook/*"}).then(consoleLogger.log)});program.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=>{logger27.error(err),process.exit(1)})});program.command("extract [location] [output]").description("extract stories.json from a built version").action((location="storybook-static",output=path15.join(location,"stories.json"))=>extract(location,output).catch(e=>{logger27.error(e),process.exit(1)}));program.command("repro [outputDirectory]").description("Create a reproduction from a set of possible templates").option("-f --renderer <renderer>","Filter on given renderer").option("-t --template <template>","Use the given template").option("-l --list","List available templates").option("-g --generator <generator>","Use custom generator command").option("--registry <registry>","which registry to use for storybook packages").option("--pnp","Use Yarn Plug'n'Play mode instead of node_modules one").option("--local","use storybook's local packages instead of yarn's registry").option("--e2e","Used in e2e context").action((outputDirectory,{renderer,template,list,e2e,generator:generator23,pnp,local})=>repro({outputDirectory,renderer,template,list,e2e,local,generator:generator23,pnp}).catch(e=>{logger27.error(e),process.exit(1)}));program.command("repro-next [filterValue]").description("Create a reproduction 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)=>reproNext({filterValue,...options}).catch(e=>{logger27.error(e),process.exit(1)}));program.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=>{logger27.error(e),process.exit(1)}));program.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)").action(async(fixId2,options)=>{await automigrate({fixId:fixId2,...options}).catch(e=>{logger27.error(e),process.exit(1)})});program.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("--no-manager-cache","Do not cache the manager UI").option("--debug-webpack","Display final webpack configurations for debugging purposes").option("--webpack-stats-json [directory]","Write Webpack Stats JSON to disk").option("--preview-url <string>","Disables the default storybook preview and lets your use your own").option("--force-build-preview","Build the preview iframe even if you are using --preview-url").option("--docs","Build a documentation-only site using addon-docs").action(options=>{logger27.setLevel(program.loglevel),consoleLogger.log(chalk25.bold(`${pkg.name} v${pkg.version}`)+chalk25.reset(`
|
|
402
|
+
`)),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})});program.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").option("--no-manager-cache","Do not cache the manager UI").action(options=>{process.env.NODE_ENV=process.env.NODE_ENV||"production",logger27.setLevel(program.loglevel),consoleLogger.log(chalk25.bold(`${pkg.name} v${pkg.version}
|
|
381
403
|
`)),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.
|
|
382
404
|
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(`
|
|
383
405
|
Did you mean ${suggestion}?`),process.exit(1)});program.usage("<command> [options]").version(pkg.version).parse(process.argv);
|