@storybook/cli 7.0.0-alpha.33 → 7.0.0-alpha.35
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 +102 -98
- package/dist/generate.mjs +111 -107
- package/package.json +10 -10
- package/rendererAssets/svelte/Button.svelte +4 -3
- package/rendererAssets/vue/Header.stories.js +1 -1
- package/rendererAssets/vue/Page.stories.js +1 -1
package/dist/generate.mjs
CHANGED
|
@@ -1,25 +1,25 @@
|
|
|
1
|
-
var ho=Object.freeze,wo=Object.defineProperty;var U=(e=>typeof require!="undefined"?require:typeof Proxy!="undefined"?new Proxy(e,{get:(o,t)=>(typeof require!="undefined"?require:o)[t]}):e)(function(e){if(typeof require!="undefined")return require.apply(this,arguments);throw new Error('Dynamic require of "'+e+'" is not supported')});var
|
|
2
|
-
`),!0):!1},
|
|
3
|
-
`),
|
|
1
|
+
var ho=Object.freeze,wo=Object.defineProperty;var U=(e=>typeof require!="undefined"?require:typeof Proxy!="undefined"?new Proxy(e,{get:(o,t)=>(typeof require!="undefined"?require:o)[t]}):e)(function(e){if(typeof require!="undefined")return require.apply(this,arguments);throw new Error('Dynamic require of "'+e+'" is not supported')});var Rr=(e,o)=>{for(var t in o)wo(e,t,{get:o[t],enumerable:!0})};var vo=(e,o)=>ho(wo(e,"raw",{value:ho(o||e.slice())}));var p={};import k from"commander";import Ia from"path";import Ge from"chalk";import Va from"envinfo";import _a from"leven";import{sync as Na}from"read-pkg-up";import{logger as I}from"@storybook/node-logger";import{UpdateNotifier as ps}from"update-notifier";import fe from"chalk";import ao from"prompts";import{telemetry as ls}from"@storybook/telemetry";import{validRange as xo,minVersion as Po}from"@storybook/semver";function we(e,o){return xo(e)&&Po(e).major<o}function So(e,o){return xo(e)&&Po(e).major===o}var Co=["react","react-native","vue","vue3","angular","mithril","riot","ember","marionette","marko","preact","svelte","rax","aurelia"],ve=(y=>(y.UNDETECTED="UNDETECTED",y.UNSUPPORTED="UNSUPPORTED",y.REACT_SCRIPTS="REACT_SCRIPTS",y.REACT="REACT",y.REACT_NATIVE="REACT_NATIVE",y.REACT_PROJECT="REACT_PROJECT",y.WEBPACK_REACT="WEBPACK_REACT",y.VUE="VUE",y.VUE3="VUE3",y.SFC_VUE="SFC_VUE",y.ANGULAR="ANGULAR",y.EMBER="EMBER",y.ALREADY_HAS_STORYBOOK="ALREADY_HAS_STORYBOOK",y.WEB_COMPONENTS="WEB_COMPONENTS",y.MITHRIL="MITHRIL",y.MARIONETTE="MARIONETTE",y.MARKO="MARKO",y.HTML="HTML",y.RIOT="RIOT",y.PREACT="PREACT",y.SVELTE="SVELTE",y.RAX="RAX",y.AURELIA="AURELIA",y.SERVER="SERVER",y))(ve||{});var Ro=[{preset:"SFC_VUE",dependencies:{"vue-loader":e=>we(e,16),vuetify:e=>we(e,3)},matcherFunction:({dependencies:e})=>e.some(Boolean)},{preset:"VUE",dependencies:{vue:e=>we(e,3),nuxt:e=>we(e,3)},matcherFunction:({dependencies:e})=>e.some(Boolean)},{preset:"VUE3",dependencies:{vue:e=>e==="next"||So(e,3)},matcherFunction:({dependencies:e})=>e.some(Boolean)},{preset:"EMBER",dependencies:["ember-cli"],matcherFunction:({dependencies:e})=>e.every(Boolean)},{preset:"REACT_PROJECT",peerDependencies:["react"],matcherFunction:({peerDependencies:e})=>e.every(Boolean)},{preset:"REACT_NATIVE",dependencies:["react-native","react-native-scripts"],matcherFunction:({dependencies:e})=>e.some(Boolean)},{preset:"REACT_SCRIPTS",files:["/node_modules/.bin/react-scripts"],dependencies:["react-scripts"],matcherFunction:({dependencies:e,files:o})=>e.every(Boolean)||o.every(Boolean)},{preset:"WEBPACK_REACT",dependencies:["react","webpack"],matcherFunction:({dependencies:e})=>e.every(Boolean)},{preset:"REACT",dependencies:["react"],matcherFunction:({dependencies:e})=>e.every(Boolean)},{preset:"ANGULAR",dependencies:["@angular/core"],matcherFunction:({dependencies:e})=>e.every(Boolean)},{preset:"WEB_COMPONENTS",dependencies:["lit-element","lit-html","lit"],matcherFunction:({dependencies:e})=>e.some(Boolean)},{preset:"MITHRIL",dependencies:["mithril"],matcherFunction:({dependencies:e})=>e.every(Boolean)},{preset:"MARIONETTE",dependencies:["backbone.marionette"],matcherFunction:({dependencies:e})=>e.every(Boolean)},{preset:"MARKO",dependencies:["marko"],matcherFunction:({dependencies:e})=>e.every(Boolean)},{preset:"RIOT",dependencies:["riot"],matcherFunction:({dependencies:e})=>e.every(Boolean)},{preset:"PREACT",dependencies:["preact"],matcherFunction:({dependencies:e})=>e.every(Boolean)},{preset:"SVELTE",dependencies:["svelte"],matcherFunction:({dependencies:e})=>e.every(Boolean)},{preset:"RAX",dependencies:["rax"],matcherFunction:({dependencies:e})=>e.every(Boolean)},{preset:"AURELIA",dependencies:["aurelia-bootstrapper"],matcherFunction:({dependencies:e})=>e.every(Boolean)}],Do={preset:"UNSUPPORTED",dependencies:{nuxt:e=>So(e,3)},matcherFunction:({dependencies:e})=>e.some(Boolean)},jr=["UNDETECTED","UNSUPPORTED","ALREADY_HAS_STORYBOOK"],xe=Object.values(ve).filter(e=>!jr.includes(e)).map(e=>e.toLowerCase());import $r from"path";import Fr from"fs";import Jr from"find-up";import Pe,{join as le}from"path";import H from"fs";import W from"fs-extra";import Y from"chalk";import{satisfies as Tr}from"@storybook/semver";import Ar from"strip-json-comments";import{dirname as Er}from"path";function R(){return Er(U.resolve("@storybook/cli/package.json"))}var D={"@storybook/addon-a11y":"7.0.0-alpha.35","@storybook/addon-actions":"7.0.0-alpha.35","@storybook/addon-backgrounds":"7.0.0-alpha.35","@storybook/addon-controls":"7.0.0-alpha.35","@storybook/addon-docs":"7.0.0-alpha.35","@storybook/addon-essentials":"7.0.0-alpha.35","@storybook/addon-highlight":"7.0.0-alpha.35","@storybook/addon-interactions":"7.0.0-alpha.35","@storybook/addon-jest":"7.0.0-alpha.35","@storybook/addon-links":"7.0.0-alpha.35","@storybook/addon-measure":"7.0.0-alpha.35","@storybook/addon-outline":"7.0.0-alpha.35","@storybook/addon-storyshots":"7.0.0-alpha.35","@storybook/addon-storyshots-puppeteer":"7.0.0-alpha.35","@storybook/addon-storysource":"7.0.0-alpha.35","@storybook/addon-toolbars":"7.0.0-alpha.35","@storybook/addon-viewport":"7.0.0-alpha.35","@storybook/addons":"7.0.0-alpha.35","@storybook/angular":"7.0.0-alpha.35","@storybook/api":"7.0.0-alpha.35","@storybook/blocks":"7.0.0-alpha.35","@storybook/builder-manager":"7.0.0-alpha.35","@storybook/builder-vite":"7.0.0-alpha.35","@storybook/builder-webpack5":"7.0.0-alpha.35","@storybook/channel-postmessage":"7.0.0-alpha.35","@storybook/channel-websocket":"7.0.0-alpha.35","@storybook/channels":"7.0.0-alpha.35","@storybook/cli":"7.0.0-alpha.35","@storybook/client-api":"7.0.0-alpha.35","@storybook/client-logger":"7.0.0-alpha.35","@storybook/codemod":"7.0.0-alpha.35","@storybook/components":"7.0.0-alpha.35","@storybook/core-client":"7.0.0-alpha.35","@storybook/core-common":"7.0.0-alpha.35","@storybook/core-events":"7.0.0-alpha.35","@storybook/core-server":"7.0.0-alpha.35","@storybook/core-webpack":"7.0.0-alpha.35","@storybook/csf-tools":"7.0.0-alpha.35","@storybook/docs-tools":"7.0.0-alpha.35","@storybook/ember":"7.0.0-alpha.35","@storybook/html":"7.0.0-alpha.35","@storybook/html-webpack5":"7.0.0-alpha.35","@storybook/instrumenter":"7.0.0-alpha.35","@storybook/node-logger":"7.0.0-alpha.35","@storybook/postinstall":"7.0.0-alpha.35","@storybook/preact":"7.0.0-alpha.35","@storybook/preact-webpack5":"7.0.0-alpha.35","@storybook/preset-html-webpack":"7.0.0-alpha.35","@storybook/preset-preact-webpack":"7.0.0-alpha.35","@storybook/preset-react-webpack":"7.0.0-alpha.35","@storybook/preset-server-webpack":"7.0.0-alpha.35","@storybook/preset-svelte-webpack":"7.0.0-alpha.35","@storybook/preset-vue-webpack":"7.0.0-alpha.35","@storybook/preset-vue3-webpack":"7.0.0-alpha.35","@storybook/preset-web-components-webpack":"7.0.0-alpha.35","@storybook/preview-web":"7.0.0-alpha.35","@storybook/react":"7.0.0-alpha.35","@storybook/react-vite":"7.0.0-alpha.35","@storybook/react-webpack5":"7.0.0-alpha.35","@storybook/router":"7.0.0-alpha.35","@storybook/server":"7.0.0-alpha.35","@storybook/server-webpack5":"7.0.0-alpha.35","@storybook/source-loader":"7.0.0-alpha.35","@storybook/store":"7.0.0-alpha.35","@storybook/svelte":"7.0.0-alpha.35","@storybook/svelte-vite":"7.0.0-alpha.35","@storybook/svelte-webpack5":"7.0.0-alpha.35","@storybook/telemetry":"7.0.0-alpha.35","@storybook/theming":"7.0.0-alpha.35","@storybook/ui":"7.0.0-alpha.35","@storybook/vue":"7.0.0-alpha.35","@storybook/vue-vite":"7.0.0-alpha.35","@storybook/vue-webpack5":"7.0.0-alpha.35","@storybook/vue3":"7.0.0-alpha.35","@storybook/vue3-vite":"7.0.0-alpha.35","@storybook/vue3-webpack5":"7.0.0-alpha.35","@storybook/web-components":"7.0.0-alpha.35","@storybook/web-components-webpack5":"7.0.0-alpha.35","@storybook/web-components-vite":"7.0.0-alpha.35",sb:"7.0.0-alpha.35",storybook:"7.0.0-alpha.35"};var de=console;function Ue(){let e=Pe.resolve("bower.json");if(!H.existsSync(e))return!1;let o=H.readFileSync(e,"utf8");return JSON.parse(o)}function K(e,o){let t=Pe.resolve(e);if(!H.existsSync(t))return!1;let r=H.readFileSync(t,"utf8"),n=o?Ar(r):r;try{return JSON.parse(n)}catch(s){throw de.error(Y.red(`Invalid json in file: ${t}`)),s}}var oe=(e,o)=>{let t=Pe.resolve(e);return H.existsSync(t)?(H.writeFileSync(t,`${JSON.stringify(o,null,2)}
|
|
2
|
+
`),!0):!1},g=e=>(process.stdout.write(Y.cyan(" \u2022 ")+e),(o,t)=>{if(o){if(process.stdout.write(`. ${Y.red("\u2716")}
|
|
3
|
+
`),de.error(`
|
|
4
4
|
${Y.red(o)}`),!t)return;let r=t.split(`
|
|
5
5
|
`).map(n=>` ${Y.dim(n)}`).join(`
|
|
6
|
-
`);
|
|
6
|
+
`);de.error(`${r}
|
|
7
7
|
`);return}process.stdout.write(`. ${Y.green("\u2713")}
|
|
8
8
|
`)});function S(e){let o=e.split(`
|
|
9
9
|
`).map(t=>` ${t}`).join(`
|
|
10
|
-
`);
|
|
11
|
-
`);
|
|
12
|
-
Add a project and re-run the installation`)}async function Bo(){return await
|
|
13
|
-
`)}`;await
|
|
10
|
+
`);de.log(o)}function jo(e,o){let t="";for(let r=0;r<o;r+=1)t+=e;return t}function Se(e,o){let t=0,n=e.map(s=>(t=s.length>t?s.length:t,s)).map(s=>{let a=t-s.length,i=s+jo(" ",a);return i=jo(" ",o||2)+Y.inverse(` ${i} `),i}).join(`
|
|
11
|
+
`);de.log(n)}async function Ce(e,o){let t=[],r="^8.0.0-0",n=o.dependencies["babel-core"]||o.devDependencies["babel-core"];if(n){let s=await e.latestVersion("babel-core",n);Tr(s,"^6.0.0")&&(r="^7.0.0")}else if(!o.dependencies["@babel/core"]&&!o.devDependencies["@babel/core"]){let s=await e.getVersion("@babel/core");t.push(`@babel/core@${s}`)}if(!o.dependencies["babel-loader"]&&!o.devDependencies["babel-loader"]){let s=await e.getVersion("babel-loader",r);t.push(`babel-loader@${s}`)}return t}function V(e){let o=Pe.resolve(e,"template-csf/");if(!H.existsSync(o))throw new Error("Couldn't find template dir");W.copySync(o,".",{overwrite:!0})}async function Eo(e,o){let t={javascript:"js",typescript:"ts"},r=async()=>{let a=R(),i=le(a,"rendererAssets"),c=le(i,e),l=le(c,t[o]);if(await W.pathExists(l))return l;let d=le(c,t.javascript);if(await W.pathExists(d))return d;if(await W.pathExists(c))return c;throw new Error(`Unsupported renderer: ${e}`)},s=await(async()=>await W.pathExists("./src")?"./src/stories":"./stories")();await W.copy(await r(),s,{overwrite:!0}),await W.copy(le(R(),"rendererAssets/common"),s,{overwrite:!0})}function Re(e){let o={...e.dependencies,...e.devDependencies},t=Object.keys(o).find(r=>D[r]);if(!t)throw new Error("Couldn't find any official storybook packages in package.json");return o[t]}var Or=/[\s"\n]next.*?(\d+).*/,To=e=>{try{let o="";if(e.type==="npm")try{o=e.executeCommand("npm",["ls","next"])}catch{o=e.executeCommand("npm",["why","next"])}else o=e.executeCommand("yarn",["why","next"]);let[,t]=o.match(Or);return t&&parseInt(t,10)?parseInt(t,10):!1}catch{}return!1};var Ir=["vite.config.ts","vite.config.js","vite.config.mjs"],Ao=(e,o,t)=>{let r=e.dependencies?.[o]||e.devDependencies?.[o];return r&&typeof t=="function"?t(r):!!r},Vr=(e,o,t)=>{let r=e.peerDependencies?.[o];return r&&typeof t=="function"?t(r):!!r},_r=(e,o)=>{let t={dependencies:[!1],peerDependencies:[!1],files:[!1]},{preset:r,files:n,dependencies:s,peerDependencies:a,matcherFunction:i}=o,c=[];Array.isArray(s)?c=s.map(d=>[d,void 0]):typeof s=="object"&&(c=Object.entries(s)),c.length>0&&(t.dependencies=c.map(([d,u])=>Ao(e,d,u)));let l=[];return Array.isArray(a)?l=a.map(d=>[d,void 0]):typeof a=="object"&&(l=Object.entries(a)),l.length>0&&(t.peerDependencies=l.map(([d,u])=>Vr(e,d,u))),Array.isArray(n)&&n.length>0&&(t.files=n.map(d=>Fr.existsSync($r.join(process.cwd(),d)))),i(t)?r:null};function Nr(e={}){let o=[...Ro,Do].find(t=>_r(e,t)!==null);return o?o.preset:"UNDETECTED"}function Oo(e){if(Jr.sync(Ir))return S("Detected vite project, setting builder to @storybook/builder-vite"),"vite";let t=To(e);return t&&t>=11?"webpack5":"webpack5"}function We(e,o){return e&&!o&&e.devDependencies&&Co.reduce((t,r)=>t||!!e.devDependencies[`@storybook/${r}`],!1)?"ALREADY_HAS_STORYBOOK":!1}function $o(e){let o="javascript",t=Ue();return!e&&!t||Ao(e||t,"typescript")&&(o="typescript"),o}function Fo(e,o={}){let t=Ue();if(!e&&!t)return"UNDETECTED";let r=We(e,o.force);return r||(o.html?"HTML":Nr(e||t))}import sn,{join as an}from"path";import Xo from"@storybook/semver";import*as Jo from"path";import*as Io from"fs";import{pathExists as Br}from"fs-extra";function De(){let e=K("angular.json",!0),o=Mr(e),t=e.projects[o].architect.build.options.tsConfig;return!t||!Io.existsSync(Jo.resolve(t))?!1:t}function Vo(){let e=De();return e?K(e,!0):!1}function Gr(e){let o=De(),t={...e};return t.extends=`../${o}`,t}function _o(e){let o;try{o=K(e)}catch(t){throw t.name==="SyntaxError"&&t.message.indexOf("Unexpected token /")>-1?new Error(`Comments are disallowed in ${e}`):t}o=Gr(o),oe(e,o)}function Mr(e){let{defaultProject:o,projects:t}=e;if(t?.storybook)return"storybook";if(o)return o;let r=t?Object.keys(t)[0]:void 0;if(r)return r}function No(){let{projects:e}=K("angular.json",!0);if(!e||Object.keys(e).length===0)throw new Error(`Could not find a project in your Angular workspace.
|
|
12
|
+
Add a project and re-run the installation`)}async function Bo(){return await Br("./tsconfig.base.json")?"tsconfig.base.json":"tsconfig.json"}import qe from"fs-extra";import{dedent as Ho}from"ts-dedent";import je from"fs-extra";import{dedent as Ye}from"ts-dedent";async function Go({addons:e,extensions:o=["js","jsx","ts","tsx"],commonJs:t=!1,...r}){let n=await je.pathExists("./src")?"../src":"../stories",s={stories:[`${n}/**/*.stories.mdx`,`${n}/**/*.stories.@(${o.join("|")})`],addons:e,...r},a=`module.exports = ${JSON.stringify(s,null,2).replace(/\\"/g,'"').replace(/['"]%%/g,"").replace(/%%['"]/g,"").replace(/\\n/g,`\r
|
|
13
|
+
`)}`;await je.writeFile(`./.storybook/main.${t?"cjs":"js"}`,Ye`
|
|
14
14
|
const path = require('path');
|
|
15
|
-
${
|
|
16
|
-
`,{encoding:"utf8"})}var
|
|
15
|
+
${a}
|
|
16
|
+
`,{encoding:"utf8"})}var Lr={angular:{prefix:Ye`
|
|
17
17
|
import { setCompodocJson } from "@storybook/addon-docs/angular";
|
|
18
18
|
import docJson from "../documentation.json";
|
|
19
19
|
setCompodocJson(docJson);
|
|
20
20
|
|
|
21
|
-
`.trimStart(),extraParameters:"docs: { inlineStories: true },"}};async function Mo(e
|
|
22
|
-
${
|
|
21
|
+
`.trimStart(),extraParameters:"docs: { inlineStories: true },"}};async function Mo(e){let{prefix:o="",extraParameters:t=""}=Lr[e]||{},r="./.storybook/preview.js";if(await je.pathExists(r))return;let n=Ye`
|
|
22
|
+
${o}
|
|
23
23
|
export const parameters = {
|
|
24
24
|
actions: { argTypesRegex: "^on[A-Z].*" },
|
|
25
25
|
controls: {
|
|
@@ -28,20 +28,20 @@ Add a project and re-run the installation`)}async function Bo(){return await Ur(
|
|
|
28
28
|
date: /Date$/,
|
|
29
29
|
},
|
|
30
30
|
},
|
|
31
|
-
${
|
|
31
|
+
${t}
|
|
32
32
|
}`.replace(`
|
|
33
|
-
`,"").trim();await
|
|
34
|
-
`;
|
|
35
|
-
${Lo.yellow(
|
|
36
|
-
${Lo.red(
|
|
33
|
+
`,"").trim();await je.writeFile(r,n,{encoding:"utf8"})}import{sync as Yo}from"cross-spawn";import{sync as Hr}from"find-up";import Yr from"@storybook/semver";import Lo from"chalk";import{gt as Ur,satisfies as Uo}from"@storybook/semver";import{sync as Wr}from"cross-spawn";import Wo from"path";import He from"fs";var _=console;function q(e){let o=e.lastIndexOf("@");if(o<=0)return[e,void 0];let t=e.slice(0,o),r=e.slice(o+1);return[t,r]}var N=class{setRegistryURL(o){o?this.executeCommand("npm",["config","set","registry",o]):this.executeCommand("npm",["config","delete","registry"])}getRegistryURL(){let o=this.executeCommand("npm",["config","get","registry"]).trim();return o==="undefined"?void 0:o}constructor(o){this.cwd=o?.cwd}installDependencies(){let o=g("Preparing to install dependencies");o(),_.log(),_.log(),o=g("Installing dependencies");try{this.runInstall()}catch{o("An error occurred while installing dependencies."),process.exit(1)}o()}packageJsonPath(){return this.cwd?Wo.resolve(this.cwd,"package.json"):Wo.resolve("package.json")}readPackageJson(){let o=this.packageJsonPath();if(!He.existsSync(o))throw new Error(`Could not read package.json file at ${o}`);let t=He.readFileSync(o,"utf8");return JSON.parse(t)}writePackageJson(o){let t=`${JSON.stringify(o,null,2)}
|
|
34
|
+
`;He.writeFileSync(this.packageJsonPath(),t,"utf8")}retrievePackageJson(){let o;try{o=this.readPackageJson()}catch{this.initPackageJson(),o=this.readPackageJson()}return{...o,dependencies:{...o.dependencies},devDependencies:{...o.devDependencies}}}addDependencies(o,t){let{skipInstall:r}=o;if(r){let{packageJson:n}=o,s=t.reduce((a,i)=>{let[c,l]=q(i);return{...a,[c]:l}},{});o.installAsDevDependencies?n.devDependencies={...n.devDependencies,...s}:n.dependencies={...n.dependencies,...s},this.writePackageJson(n)}else try{this.runAddDeps(t,o.installAsDevDependencies)}catch(n){_.error("An error occurred while installing dependencies."),_.log(n.message),process.exit(1)}}removeDependencies(o,t){let{skipInstall:r}=o;if(r){let{packageJson:n}=o;t.forEach(s=>{n.devDependencies&&delete n.devDependencies[s],n.dependencies&&delete n.dependencies[s]}),this.writePackageJson(n)}else try{this.runRemoveDeps(t)}catch(n){_.error("An error occurred while removing dependencies."),_.log(n.message),process.exit(1)}}getVersionedPackages(o){return Promise.all(o.map(async t=>{let[r,n]=q(t);return`${r}@${await this.getVersion(r,n)}`}))}getVersions(...o){return Promise.all(o.map(t=>this.getVersion(t)))}async getVersion(o,t){let r;/(@storybook|^sb$|^storybook$)/.test(o)&&(r=D[o]);let n;try{n=await this.latestVersion(o,t)}catch(a){if(r)return _.warn(`
|
|
35
|
+
${Lo.yellow(a.message)}`),r;_.error(`
|
|
36
|
+
${Lo.red(a.message)}`),process.exit(1)}return`^${r&&(!t||Uo(r,t))&&Ur(r,n)?r:n}`}async latestVersion(o,t){return t?(await this.runGetVersions(o,!0)).reverse().find(n=>Uo(n,t)):this.runGetVersions(o,!1)}addStorybookCommandInScripts(o){let t=o?.port??6006,r=o?.staticFolder?`npx storybook dev -p ${t} -s ${o.staticFolder}`:`npx storybook dev -p ${t}`,n=o?.staticFolder?`npx storybook build -s ${o.staticFolder}`:"npx storybook build",s=o?.preCommand?this.getRunCommand(o.preCommand):void 0;this.addScripts({storybook:[s,r].filter(Boolean).join(" && "),"build-storybook":[s,n].filter(Boolean).join(" && ")})}addESLintConfig(){let o=this.retrievePackageJson();this.writePackageJson({...o,eslintConfig:{...o.eslintConfig,overrides:[...o.eslintConfig?.overrides||[],{files:["**/*.stories.*"],rules:{"import/no-anonymous-default-export":"off"}}]}})}addScripts(o){let t=this.retrievePackageJson();this.writePackageJson({...t,scripts:{...t.scripts,...o}})}addPackageResolutions(o){let t=this.retrievePackageJson(),r=this.getResolutions(t,o);this.writePackageJson({...t,...r})}executeCommand(o,t,r){let n=Wr(o,t,{cwd:this.cwd,stdio:r??"pipe",encoding:"utf-8",shell:!0});if(n.status!==0)throw new Error(n.stderr??"");return n.stdout??""}};var me=class extends N{constructor(){super(...arguments);this.type="npm"}initPackageJson(){return this.executeCommand("npm",["init","-y"])}getRunStorybookCommand(){return"npm run storybook"}getRunCommand(t){return`npm run ${t}`}getNpmVersion(){return this.executeCommand("npm",["--version"])}hasLegacyPeerDeps(){return this.executeCommand("npm",["config","get","legacy-peer-deps","--location=project"]).trim()==="true"}setLegacyPeerDeps(){this.executeCommand("npm",["config","set","legacy-peer-deps=true","--location=project"])}needsLegacyPeerDeps(t){return Yr.gte(t,"7.0.0")&&!this.hasLegacyPeerDeps()}getInstallArgs(){return this.installArgs||(this.installArgs=this.needsLegacyPeerDeps(this.getNpmVersion())?["install","--legacy-peer-deps"]:["install"]),this.installArgs}getUninstallArgs(){return this.uninstallArgs||(this.uninstallArgs=this.needsLegacyPeerDeps(this.getNpmVersion())?["uninstall","--legacy-peer-deps"]:["uninstall"]),this.uninstallArgs}getResolutions(t,r){return{overrides:{...t.overrides,...r}}}runInstall(){this.executeCommand("npm",this.getInstallArgs(),"inherit")}runAddDeps(t,r){let n=[...t];r&&(n=["-D",...n]),this.executeCommand("npm",[...this.getInstallArgs(),...n],"inherit")}runRemoveDeps(t){let r=[...t];this.executeCommand("npm",[...this.getUninstallArgs(),...r],"inherit")}runGetVersions(t,r){let n=[r?"versions":"version","--json"],s=this.executeCommand("npm",["info",t,...n]);try{let a=JSON.parse(s);if(a.error)throw new Error(a.error.summary);return a}catch{throw new Error(`Unable to find versions of ${t} using npm`)}}};var Ee=class extends N{constructor(){super(...arguments);this.type="yarn2"}initPackageJson(){return this.executeCommand("yarn",["init"])}getRunStorybookCommand(){return"yarn storybook"}getRunCommand(t){return`yarn ${t}`}getResolutions(t,r){return{resolutions:{...t.resolutions,...r}}}runInstall(){this.executeCommand("yarn",[],"inherit")}runAddDeps(t,r){let n=[...t];r&&(n=["-D",...n]),this.executeCommand("yarn",["add",...n],"inherit")}runRemoveDeps(t){let r=[...t];this.executeCommand("yarn",["remove",...r],"inherit")}runGetVersions(t,r){let n=r?"versions":"version",s=["--fields",n,"--json"],a=this.executeCommand("yarn",["npm","info",t,...s]);try{return JSON.parse(a)[n]}catch{throw new Error(`Unable to find versions of ${t} using yarn 2`)}}};var Te=class extends N{constructor(){super(...arguments);this.type="yarn1"}initPackageJson(){return this.executeCommand("yarn",["init","-y"])}getRunStorybookCommand(){return"yarn storybook"}getRunCommand(t){return`yarn ${t}`}getResolutions(t,r){return{resolutions:{...t.resolutions,...r}}}runInstall(){this.executeCommand("yarn",[],"inherit")}runAddDeps(t,r){let n=["--ignore-workspace-root-check",...t];r&&(n=["-D",...n]),this.executeCommand("yarn",["add",...n],"inherit")}runRemoveDeps(t){let r=["--ignore-workspace-root-check",...t];this.executeCommand("yarn",["remove",...r],"inherit")}runGetVersions(t,r){let n=[r?"versions":"version","--json"],s=this.executeCommand("yarn",["info",t,...n]);try{let a=JSON.parse(s);if(a.type==="inspect")return a.data;throw new Error(`Unable to find versions of ${t} using yarn`)}catch{throw new Error(`Unable to find versions of ${t} using yarn`)}}};var T=class{static getPackageManager(o=!1,t){if(o)return new me({cwd:t});let r=qr(t),n=Hr("yarn.lock",{cwd:t}),s=Kr(t);if(r&&(n||!s))return r===1?new Te({cwd:t}):new Ee({cwd:t});if(s)return new me({cwd:t});throw new Error("Unable to find a usable package manager within NPM, Yarn and Yarn 2")}};function Kr(e){return Yo("npm",["--version"],{cwd:e,shell:!0}).status===0}function qr(e){let o=Yo("yarn",["--version"],{cwd:e,shell:!0});if(o.status!==0)return;let t=o.output.toString().replace(/,/g,"").replace(/"/g,"");return/^1\.+/.test(t)?1:2}import{writeFile as Xr,access as zr}from"fs-extra";import{logger as Ke}from"@storybook/node-logger";import Zr from"path";import Qr from"prompts";var Ae=async()=>{let e=process.cwd();return en({target:e})},en=async({target:e})=>{Ke.info(`Generating the storybook default babel config at ${e}`);let o=JSON.stringify({sourceType:"unambiguous",presets:[],plugins:[]},null,2),t=".babelrc.json",r=Zr.join(e,t);if(await zr(r).then(()=>!0,()=>!1)){let{overwrite:s}=await Qr({type:"confirm",initial:!0,name:"overwrite",message:`${t} already exists. Would you like overwrite it?`});if(s===!1){Ke.warn("Cancelled, babel config file was NOT written to file-system.");return}}Ke.info(`Writing file to ${r}`),await Xr(r,o)};var Ko={extraPackages:[],extraAddons:[],staticDir:void 0,addScripts:!0,addComponents:!0,addBabel:!1,addESLint:!1,extraMain:void 0,framework:void 0,extensions:void 0,commonJs:!1},on=e=>{let o=D;if(o[e])return e;let t=`@storybook/${e}`;return o[t]?t:e},Oe=e=>`%%path.dirname(require.resolve(path.join('${e}', 'package.json')))%%`,tn=(e,o,t)=>{let r=`@storybook/${e}-${o}`,n=t?Oe(r):r,s=`@storybook/${e}`,a=t?Oe(s):s,i=on(o),c=t?Oe(i):i,l=!!D[r],d=!!D[s];if(e==="angular")return{packages:[s],framework:a,rendererId:"angular",type:"framework"};if(l)return{packages:[r],framework:n,rendererId:e,type:"framework"};if(d)return{packages:[s,i],builder:c,renderer:a,rendererId:e,type:"renderer"};throw new Error(`Could not find the framework (${r}) or renderer (${s}) package`)},rn=e=>e.map(o=>q(o)[0]),nn=e=>["react","angular","preact","svelte","vue","vue3","html"].includes(e),qo;async function m(e,o,{language:t,builder:r="webpack5",pnp:n,commonJs:s},a,i=Ko){let{extraAddons:c,extraPackages:l,staticDir:d,addScripts:u,addComponents:b,addBabel:f,addESLint:h,extraMain:ee,extensions:Me}={...Ko,...i},{packages:bo,type:ko,renderer:Ba,rendererId:br,framework:kr,builder:hr}=tn(a,r,n),Le=["@storybook/addon-links","@storybook/addon-essentials",...rn(c)],y=["@storybook/addon-links","@storybook/addon-essentials",...c];nn(br)&&(Le.push("@storybook/addon-interactions"),y.push("@storybook/addon-interactions","@storybook/testing-library"));let wr=e.type==="yarn2"?["@storybook/addon-docs","@mdx-js/react@1.x.x"]:[],vr=await qe.readdir(process.cwd()),he=e.retrievePackageJson(),xr=new Set(Object.keys({...he.dependencies,...he.devDependencies}));if(ko==="renderer")throw new Error(Ho`
|
|
37
37
|
Sorry, for now, you can not do this, please use a framework such as @storybook/react-webpack5
|
|
38
38
|
|
|
39
39
|
https://github.com/storybookjs/storybook/issues/18360
|
|
40
|
-
`);let
|
|
40
|
+
`);let Pr=["storybook",`@storybook/${a}`,...bo,...y,...l,...wr].filter(Boolean).filter($=>!xr.has(q($)[0])),Sr=await e.getVersionedPackages(Pr);if(await qe.ensureDir("./.storybook"),await Go({framework:{name:kr,options:i.framework||{}},addons:n?Le.map(Oe):Le,extensions:Me,commonJs:s,...ee,...ko!=="framework"?{core:{builder:hr}}:{}}),await Mo(a),b&&await Eo(a,t),bo.find($=>$.match(/^@storybook\/.*-vite$/))){let $=Ho(qo||(qo=vo([`
|
|
41
41
|
<script>
|
|
42
42
|
window.global = window;
|
|
43
43
|
<\/script>
|
|
44
|
-
`])));await
|
|
44
|
+
`])));await qe.writeFile(".storybook/preview-head.html",$,{encoding:"utf8"})}let Cr=f&&r!=="vite"?await Ce(e,he):[];!vr.some($=>$.startsWith(".babel")||$.startsWith("babel")||$==="package.json")&&await Ae(),e.addDependencies({...o,packageJson:he},[...Sr,...Cr]),u&&e.addStorybookCommandInScripts({port:6006,staticFolder:d}),h&&e.addESLintConfig()}function cn(){let e=Vo(),o="**/*.stories.*";if(!e)return;let{exclude:t=[]}=e;t.includes(o)||(e.exclude=[...t,o],oe(De(),e))}var pn=async(e,o,t)=>{No();let r=Xo.coerce(e.retrievePackageJson().dependencies["@angular/core"])?.version,s=Xo.gte(r,"12.0.0")?{...t,builder:"webpack5"}:t;await m(e,o,s,"angular",{extraPackages:["@compodoc/compodoc"],addScripts:!1});let a=an(R(),"templates","angular");V(a),cn(),_o(sn.resolve("./.storybook/tsconfig.json"));let i=await Bo();e.addScripts({"docs:json":`compodoc -p ./${i} -e json -d .`}),e.addStorybookCommandInScripts({port:6006,preCommand:"docs:json"})},zo=pn;import{join as ln}from"path";function dn(){let e=K("tsconfig.json",!0),o="**/*.stories.ts";if(!e)return;let{exclude:t=[]}=e;t.includes(o)||(e.exclude=[...t,o],oe("tsconfig.json",e))}var mn=async(e,o,t)=>{dn(),await m(e,o,t,"aurelia",{extraPackages:["aurelia"]});let r=ln(R(),"templates","aurelia");V(r)},Zo=mn;var un=async(e,o,t)=>{await m(e,o,t,"ember",{extraPackages:["babel-plugin-ember-modules-api-polyfill","babel-plugin-htmlbars-inline-precompile"],staticDir:"dist"})},Qo=un;var fn=async(e,o,t)=>{await m(e,o,t,"react")},Xe=fn;import{join as gn}from"path";import yn from"chalk";import et from"shelljs";var bn=async(e,o,t)=>{let r=et.ls("-d","ios/*.xcodeproj").stdout;if(r){let h=r.slice(4,r.length-10-1);h?et.sed("-i","%APP_NAME%",h,"storybook/index.js"):S(yn.red("ERR: Could not determine project name, to fix: https://github.com/storybookjs/storybook/issues/1277"))}let n=e.retrievePackageJson(),s=!n.dependencies["react-dom"]&&!n.devDependencies["react-dom"],a=n.dependencies.react,i=["@storybook/addon-links@^5.3","@storybook/addon-knobs@^5.3","@storybook/addon-actions@^5.3"],l=[...["@storybook/addon-ondevice-knobs","@storybook/addon-ondevice-actions"],"@storybook/react-native",t&&"@storybook/react-native-server"].filter(Boolean),d=await e.getVersionedPackages(l),b=[...await Ce(e,n),...d,...i,s&&a&&`react-dom@${a}`].filter(Boolean);e.addDependencies({...o,packageJson:n},b),t&&e.addStorybookCommandInScripts({port:7007});let f=gn(R(),"templates","react-native");V(f)},ot=bn;import tt from"path";import kn from"fs";import rt from"@storybook/semver";var hn=async(e,o,t)=>{let r=tt.join(__dirname,"..","..","..","..","..",".."),n=t.linkable?{webpackFinal:`%%(config) => {
|
|
45
45
|
// add monorepo root as a valid directory to import modules from
|
|
46
46
|
config.resolve.plugins.forEach((p) => {
|
|
47
47
|
if (Array.isArray(p.appSrcs)) {
|
|
@@ -50,100 +50,100 @@ Add a project and re-run the installation`)}async function Bo(){return await Ur(
|
|
|
50
50
|
});
|
|
51
51
|
return config;
|
|
52
52
|
}
|
|
53
|
-
%%`}:{},s=rt.coerce(e.retrievePackageJson().dependencies["react-scripts"])?.version,
|
|
54
|
-
❌ Unable to determine storybook version, skipping ${
|
|
53
|
+
%%`}:{},s=rt.coerce(e.retrievePackageJson().dependencies["react-scripts"])?.version,a=s&&rt.gte(s,"5.0.0"),i=a?{...t,builder:"webpack5"}:t,c=["@storybook/node-logger"];a&&(c.push("webpack"),c.push("babel-plugin-named-exports-order"),c.push("prop-types")),await m(e,o,i,"react",{extraAddons:[`@storybook/preset-create-react-app${a?"":"@3"}`],extraPackages:c,staticDir:kn.existsSync(tt.resolve("./public"))?"public":void 0,addBabel:!1,addESLint:!0,extraMain:n})},nt=hn;var wn=async(e,o,t)=>{await m(e,o,t,"vue")},st=wn;var vn=async(e,o,t)=>{let r=t.builder==="webpack5"?["vue-loader@^15.7.0"]:[];await m(e,o,t,"vue",{extraPackages:r})},at=vn;var xn=async(e,o,t)=>{let r=t.builder==="webpack5"?["vue-loader@^17.0.0","@vue/compiler-sfc@^3.2.0"]:[];await m(e,o,t,"vue3",{extraPackages:r})},it=xn;var Pn=async(e,o,t)=>{await m(e,o,t,"react")},ct=Pn;var Sn=async(e,o,t)=>{await m(e,o,t,"mithril")},pt=Sn;var Cn=async(e,o,t)=>{await m(e,o,t,"marionette")},lt=Cn;var Rn=async(e,o,t)=>{await m(e,o,t,"marko")},dt=Rn;var Dn=async(e,o,t)=>{await m(e,o,t,"html")},mt=Dn;var jn=async(e,o,t)=>m(e,o,t,"web-components",{extraPackages:["lit-html"]}),ut=jn;var En=async(e,o,t)=>{await m(e,o,t,"riot",{extraPackages:["riot-tag-loader"]})},ft=En;var Tn=async(e,o,t)=>{await m(e,o,t,"preact")},gt=Tn;import yt from"fs-extra";import{logger as ze}from"@storybook/node-logger";var An=async(e,o,t)=>{let r;if(yt.existsSync("./svelte.config.js"))ze.info("Configuring preprocessor from 'svelte.config.js'"),r={svelteOptions:{preprocess:'%%require("../svelte.config.js").preprocess%%'}};else if(yt.existsSync("./svelte.config.cjs"))ze.info("Configuring preprocessor from 'svelte.config.cjs'"),r={svelteOptions:{preprocess:'%%require("../svelte.config.cjs").preprocess%%'}};else{let s=e.retrievePackageJson();s.devDependencies&&s.devDependencies["svelte-preprocess"]&&(ze.info("Configuring preprocessor with 'svelte-preprocess'"),r={svelteOptions:{preprocess:'%%require("svelte-preprocess")()%%'}})}let n=t.builder==="webpack5"?["svelte","svelte-loader"]:[];await m(e,o,t,"svelte",{extraPackages:n,extensions:["js","jsx","ts","tsx","svelte"],extraMain:r,commonJs:!0})},bt=An;var On=async(e,o,t)=>{let[r]=await e.getVersions("rax"),n=e.retrievePackageJson(),s=n.dependencies.rax||r;n.dependencies.rax=n.dependencies.rax||s,n.dependencies["rax-image"]=n.dependencies["rax-image"]||s,n.dependencies["rax-link"]=n.dependencies["rax-link"]||s,n.dependencies["rax-text"]=n.dependencies["rax-text"]||s,n.dependencies["rax-view"]=n.dependencies["rax-view"]||s,e.writePackageJson(n),await m(e,o,t,"rax",{extraPackages:["rax"]})},kt=On;import{join as $n}from"path";var Fn=async(e,o,t)=>{await m(e,o,t,"server",{extensions:["json"]});let r=$n(R(),"templates","server");V(r)},ht=Fn;import is from"prompts";import ie from"chalk";import cs from"boxen";import Qe from"chalk";import{dedent as _n}from"ts-dedent";import wt from"@storybook/semver";import re from"chalk";import{dedent as Ze}from"ts-dedent";import ne from"@storybook/semver";import{readConfig as Jn,writeConfig as In}from"@storybook/csf-tools";import{getStorybookInfo as Vn}from"@storybook/core-common";var se=console,j={id:"webpack5",async checkWebpack5Builder(e){let{mainConfig:o,version:t}=Vn(e),r=t&&ne.coerce(t)?.version;if(!r)return se.warn(Ze`
|
|
54
|
+
❌ Unable to determine storybook version, skipping ${re.cyan("webpack5")} fix.
|
|
55
55
|
🤔 Are you running automigrate from your project directory?
|
|
56
|
-
`),null;if(
|
|
56
|
+
`),null;if(ne.lt(r,"6.3.0"))return se.warn(Ze`
|
|
57
57
|
Detected SB 6.3 or below, please upgrade storybook to use webpack5.
|
|
58
58
|
|
|
59
59
|
To upgrade to the latest stable release, run this from your project directory:
|
|
60
60
|
|
|
61
|
-
${
|
|
61
|
+
${re.cyan("npx storybook upgrade")}
|
|
62
62
|
|
|
63
|
-
Add the ${
|
|
64
|
-
`.trim()),null;if(
|
|
63
|
+
Add the ${re.cyan("--prerelease")} flag to get the latest prerelease.
|
|
64
|
+
`.trim()),null;if(ne.gte(r,"7.0.0"))return null;if(!o)return se.warn("Unable to find storybook main.js config"),null;let n=await Jn(o),s=n.getFieldValue(["core","builder"]);return s&&s!=="webpack4"?(se.info(`Found builder ${s}, skipping`),null):{storybookVersion:t,main:n}},async check({packageManager:e}){let o=e.retrievePackageJson(),{dependencies:t,devDependencies:r}=o,n=t.webpack||r.webpack,s=ne.coerce(n)?.version;if(!s||ne.lt(s,"5.0.0")||ne.gte(s,"6.0.0"))return null;let a=await this.checkWebpack5Builder(o);return a?{webpackVersion:n,...a}:null},prompt({webpackVersion:e}){let o=re.cyan(`webpack ${e}`);return Ze`
|
|
65
65
|
We've detected you're running ${o}.
|
|
66
66
|
Your Storybook's main.js files specifies webpack4, which is incompatible.
|
|
67
67
|
|
|
68
|
-
To run Storybook in webpack5-mode, we can install Storybook's ${
|
|
68
|
+
To run Storybook in webpack5-mode, we can install Storybook's ${re.cyan("@storybook/builder-webpack5")} for you.
|
|
69
69
|
|
|
70
|
-
More info: ${
|
|
71
|
-
`},async run({result:{main:e,storybookVersion:o,webpackVersion:t},packageManager:r,dryRun:n}){let s=[`@storybook/builder-webpack5@${o}`];t||s.push("webpack@5"),
|
|
70
|
+
More info: ${re.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#webpack-5-manager-build")}
|
|
71
|
+
`},async run({result:{main:e,storybookVersion:o,webpackVersion:t},packageManager:r,dryRun:n}){let s=[`@storybook/builder-webpack5@${o}`];t||s.push("webpack@5"),se.info(`\u2705 Adding dependencies: ${s}`),n||r.addDependencies({installAsDevDependencies:!0},s),se.info("\u2705 Setting `core.builder` to `@storybook/builder-webpack5` in main.js"),n||(e.setFieldValue(["core","builder"],"@storybook/builder-webpack5"),await In(e))}};var vt={id:"cra5",async check({packageManager:e}){let o=e.retrievePackageJson(),{dependencies:t,devDependencies:r}=o,n=t["react-scripts"]||r["react-scripts"],s=wt.coerce(n)?.version;if(!s||wt.lt(s,"5.0.0"))return null;let a=await j.checkWebpack5Builder(o);return a?{craVersion:n,...a}:null},prompt({craVersion:e,...o}){let t=Qe.cyan(`Create React App (CRA) ${e}`);return console.log({...o}),_n`
|
|
72
72
|
We've detected you are running ${t} which is powered by webpack5.
|
|
73
73
|
Your Storybook's main.js files specifies webpack4, which is incompatible.
|
|
74
74
|
|
|
75
|
-
In order to work with your version of CRA, we need to install Storybook's ${
|
|
75
|
+
In order to work with your version of CRA, we need to install Storybook's ${Qe.cyan("@storybook/builder-webpack5")}.
|
|
76
76
|
|
|
77
|
-
More info: ${
|
|
78
|
-
`},async run(e){return j.run({...e,result:{webpackVersion:null,...e.result}})}};import
|
|
77
|
+
More info: ${Qe.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#cra5-upgrade")}
|
|
78
|
+
`},async run(e){return j.run({...e,result:{webpackVersion:null,...e.result}})}};import eo from"chalk";import{dedent as Nn}from"ts-dedent";import xt from"@storybook/semver";var Pt={id:"angular12",async check({packageManager:e}){let o=e.retrievePackageJson(),{dependencies:t,devDependencies:r}=o,n=t["@angular/core"]||r["@angular/core"],s=xt.coerce(n)?.version;if(!s||xt.lt(s,"12.0.0"))return null;let a=await j.checkWebpack5Builder(o);return a?{angularVersion:n,...a}:null},prompt({angularVersion:e}){let o=eo.cyan(`Angular ${e}`);return Nn`
|
|
79
79
|
We've detected you are running ${o} which is powered by webpack5.
|
|
80
80
|
Your Storybook's main.js files specifies webpack4, which is incompatible.
|
|
81
81
|
|
|
82
|
-
In order to work with your version of Angular, we need to install Storybook's ${
|
|
82
|
+
In order to work with your version of Angular, we need to install Storybook's ${eo.cyan("@storybook/builder-webpack5")}.
|
|
83
83
|
|
|
84
|
-
More info: ${
|
|
85
|
-
`},async run(e){return j.run({...e,result:{webpackVersion:null,...e.result}})}};import
|
|
84
|
+
More info: ${eo.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#angular12-upgrade")}
|
|
85
|
+
`},async run(e){return j.run({...e,result:{webpackVersion:null,...e.result}})}};import $e from"chalk";import{dedent as Bn}from"ts-dedent";import St from"@storybook/semver";var Ct={id:"vue3",async check({packageManager:e}){let o=e.retrievePackageJson(),{dependencies:t,devDependencies:r}=o,n=t.vue||r.vue,s=St.coerce(n)?.version;if(!s||St.lt(s,"3.0.0"))return null;let a=await j.checkWebpack5Builder(o);return a?{vueVersion:n,...a}:null},prompt({vueVersion:e,storybookVersion:o}){let t=$e.cyan(`Vue ${e}`),r=$e.cyan(`Storybook ${o}`);return Bn`
|
|
86
86
|
We've detected you are running ${t} with Storybook.
|
|
87
87
|
${r} runs webpack4 by default, which is incompatible.
|
|
88
88
|
|
|
89
|
-
In order to work with your version of Vue, we need to install Storybook's ${
|
|
89
|
+
In order to work with your version of Vue, we need to install Storybook's ${$e.cyan("webpack5 builder")}.
|
|
90
90
|
|
|
91
|
-
More info: ${
|
|
92
|
-
`},async run(e){return j.run({...e,result:{webpackVersion:null,...e.result}})}};import
|
|
93
|
-
❌ Unable to determine storybook version, skipping ${
|
|
91
|
+
More info: ${$e.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#vue3-upgrade")}
|
|
92
|
+
`},async run(e){return j.run({...e,result:{webpackVersion:null,...e.result}})}};import oo from"chalk";import{dedent as Rt}from"ts-dedent";import Dt from"@storybook/semver";import{readConfig as Gn,writeConfig as Mn}from"@storybook/csf-tools";import{getStorybookInfo as Ln}from"@storybook/core-common";var to=console,jt={id:"mainjsFramework",async check({packageManager:e}){let o=e.retrievePackageJson(),{mainConfig:t,framework:r,version:n}=Ln(o);if(!t)return to.warn("Unable to find storybook main.js config, skipping"),null;let s=n&&Dt.coerce(n)?.version;if(!s)return to.warn(Rt`
|
|
93
|
+
❌ Unable to determine storybook version, skipping ${oo.cyan("mainjsFramework")} fix.
|
|
94
94
|
🤔 Are you running automigrate from your project directory?
|
|
95
|
-
`),null;let
|
|
95
|
+
`),null;let a=await Gn(t),i=a.getFieldValue(["framework"]),c=a.getFieldValue(["features"]);return i?null:c?.breakingChangesV7||c?.storyStoreV7||Dt.gte(s,"7.0.0")?{main:a,framework:`@storybook/${r}`}:null},prompt({framework:e}){let o=oo.cyan(`framework: '${e}'`);return Rt`
|
|
96
96
|
We've detected that your main.js configuration file does not specify the
|
|
97
97
|
'framework' field, which is a requirement in SB7.0 and above. We can add one
|
|
98
98
|
for you automatically:
|
|
99
99
|
|
|
100
100
|
${o}
|
|
101
101
|
|
|
102
|
-
More info: ${
|
|
103
|
-
`},async run({result:{main:e,framework:o},dryRun:t}){
|
|
102
|
+
More info: ${oo.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#mainjs-framework-field")}
|
|
103
|
+
`},async run({result:{main:e,framework:o},dryRun:t}){to.info(`\u2705 Setting 'framework' to '${o}' in main.js`),t||(e.setFieldValue(["framework"],o),await Mn(e))}};import Wn from"chalk";import{dedent as At}from"ts-dedent";import{readConfig as Ot,writeConfig as Yn}from"@storybook/csf-tools";import{getStorybookInfo as Hn}from"@storybook/core-common";import Et from"fs-extra";var ro=["js","cjs"],Un=["yaml","yml","json"],Tt=()=>{let e=".eslintrc",o=Un.find(r=>Et.existsSync(`${e}.${r}`));if(o)throw new Error(o);let t=ro.find(r=>Et.existsSync(`${e}.${r}`));return t?`${e}.${t}`:null};var ue=console,$t={id:"eslintPlugin",async check({packageManager:e}){let o=e.retrievePackageJson(),{dependencies:t,devDependencies:r}=o,n=t["eslint-plugin-storybook"]||r["eslint-plugin-storybook"],s=t.eslint||r.eslint;if(n||!s)return null;let{mainConfig:a}=Hn(o);if(!a)return ue.warn("Unable to find storybook main.js config, skipping"),null;let i,c;try{i=Tt()}catch(d){c=d.message}if(!i&&!c)return ue.warn("Unable to find .eslintrc config file, skipping"),null;let l=await Ot(a);return{eslintFile:i,main:l,unsupportedExtension:c}},prompt(){return At`
|
|
104
104
|
We've detected you are not using our eslint-plugin.
|
|
105
105
|
|
|
106
106
|
In order to have the best experience with Storybook and follow best practices, we advise you to install eslint-plugin-storybook.
|
|
107
107
|
|
|
108
|
-
More info: ${
|
|
109
|
-
`},async run({result:{eslintFile:e,unsupportedExtension:o},packageManager:t,dryRun:r}){let n=["eslint-plugin-storybook"];if(
|
|
108
|
+
More info: ${Wn.yellow("https://github.com/storybookjs/eslint-plugin-storybook#readme")}
|
|
109
|
+
`},async run({result:{eslintFile:e,unsupportedExtension:o},packageManager:t,dryRun:r}){let n=["eslint-plugin-storybook"];if(ue.info(`\u2705 Adding dependencies: ${n}`),r||t.addDependencies({installAsDevDependencies:!0},n),!r&&o)throw new Error(At`
|
|
110
110
|
⚠️ The plugin was successfuly installed but failed to configure.
|
|
111
111
|
|
|
112
112
|
Found an .eslintrc config file with an unsupported automigration format: ${o}.
|
|
113
|
-
Supported formats for automigration are: ${
|
|
113
|
+
Supported formats for automigration are: ${ro.join(", ")}.
|
|
114
114
|
|
|
115
115
|
Please refer to https://github.com/storybookjs/eslint-plugin-storybook#usage to finish setting up the plugin manually.
|
|
116
|
-
`);let s=await Ot(e);if(
|
|
116
|
+
`);let s=await Ot(e);if(ue.info(`\u2705 Configuring eslint rules in ${s.fileName}`),!r){ue.info("\u2705 Adding Storybook to extends list");let a=s.getFieldValue(["extends"])||[],i=Array.isArray(a)?a:[a];s.setFieldValue(["extends"],[...i,"plugin:storybook/recommended"]),await Yn(s)}}};import no from"chalk";import{dedent as Kn}from"ts-dedent";import{readConfig as qn,writeConfig as Xn}from"@storybook/csf-tools";import{getStorybookInfo as zn}from"@storybook/core-common";var Fe=console,Ft={id:"builder-vite",async check({packageManager:e}){let o=e.retrievePackageJson(),{mainConfig:t}=zn(o);if(!t)return Fe.warn("Unable to find storybook main.js config"),null;let r=await qn(t),n=r.getFieldValue(["core","builder"]);return(typeof n=="string"?n:n?.name)!=="storybook-builder-vite"?null:{builder:n,main:r,packageJson:o}},prompt({builder:e}){let o=no.cyan(JSON.stringify(e,null,2));return Kn`
|
|
117
117
|
We've detected you're using the community vite builder: ${o}
|
|
118
118
|
|
|
119
|
-
'storybook-builder-vite' is deprecated and now located at ${
|
|
119
|
+
'storybook-builder-vite' is deprecated and now located at ${no.cyan("@storybook/builder-vite")}.
|
|
120
120
|
|
|
121
121
|
We can upgrade your project to use the new builder automatically.
|
|
122
122
|
|
|
123
|
-
More info: ${
|
|
124
|
-
`},async run({result:{builder:e,main:o,packageJson:t},packageManager:r,dryRun:n}){let{dependencies:s={},devDependencies:
|
|
123
|
+
More info: ${no.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#vite-builder-renamed")}
|
|
124
|
+
`},async run({result:{builder:e,main:o,packageJson:t},packageManager:r,dryRun:n}){let{dependencies:s={},devDependencies:a={}}=t;if(Fe.info("Removing existing 'storybook-builder-vite' dependency"),n||(delete s["storybook-builder-vite"],delete a["storybook-builder-vite"],r.writePackageJson(t)),Fe.info("Adding '@storybook/builder-vite' as dev dependency"),n||r.addDependencies({installAsDevDependencies:!0},["@storybook/builder-vite"]),Fe.info("Updating main.js to use vite builder"),!n){let i=typeof e=="string"?"@storybook/builder-vite":{name:"@storybook/builder-vite",options:e.options};o.setFieldValue(["core","builder"],i),await Xn(o)}}};import Jt from"chalk";import{dedent as Zn}from"ts-dedent";var It={id:"npm7",async check({packageManager:e}){if(e.type!=="npm")return null;let o=e.getNpmVersion();return e.needsLegacyPeerDeps(o)?{npmVersion:o}:null},prompt({npmVersion:e}){let o=Jt.cyan(`npm ${e}`);return Zn`
|
|
125
125
|
We've detected you are running ${o} which has peer dependency semantics which Storybook is incompatible with.
|
|
126
126
|
|
|
127
127
|
In order to work with Storybook's package structure, you'll need to run \`npm\` with the
|
|
128
128
|
\`--legacy-peer-deps=true\` flag. We can generate an \`.npmrc\` which will do that automatically.
|
|
129
129
|
|
|
130
130
|
More info: ${Jt.yellow("https://github.com/storybookjs/storybook/issues/18298")}
|
|
131
|
-
`},async run({packageManager:e}){e.setLegacyPeerDeps()}};import E from"chalk";import{dedent as
|
|
131
|
+
`},async run({packageManager:e}){e.setLegacyPeerDeps()}};import E from"chalk";import{dedent as Qn}from"ts-dedent";import Vt from"@storybook/semver";import{getStorybookInfo as es}from"@storybook/core-common";var A=console,os=e=>{let o={custom:{},official:{}};return Object.keys(e).forEach(t=>{t==="storybook"||t==="build-storybook"?o.official[t]=e[t]:(e[t].match(/start-storybook/)||e[t].match(/build-storybook/))&&(o.custom[t]=e[t])}),o},_t={id:"sb-scripts",async check({packageManager:e}){let o=e.retrievePackageJson(),{scripts:t={},devDependencies:r,dependencies:n}=o,{version:s}=es(o),a={...n,...r},i=s&&Vt.coerce(s)?.version;if(!i)return A.warn(Qn`
|
|
132
132
|
❌ Unable to determine storybook version, skipping ${E.cyan("sb-scripts")} fix.
|
|
133
133
|
🤔 Are you running automigrate from your project directory?
|
|
134
|
-
`),null;if(
|
|
134
|
+
`),null;if(a.sb||a.storybook)return null;let c=os(t);return Object.keys(c.official).length===0&&Object.keys(c.custom).length===0?null:(Object.keys(c.official).forEach(l=>{c.official[l]=c.official[l].replace("start-storybook","storybook dev").replace("build-storybook","storybook build")}),Vt.gte(i,"7.0.0")?{packageJson:o,storybookScripts:c,storybookVersion:s}:null)},prompt({storybookVersion:e}){let o=E.cyan(`Storybook ${e}`),t=[`Starting in Storybook 7, the ${E.yellow("start-storybook")} and ${E.yellow("build-storybook")} binaries have changed to ${E.magenta("storybook dev")} and ${E.magenta("storybook build")} respectively.`,`In order to work with ${o}, Storybook's ${E.magenta("storybook")} binary has to be installed and your storybook scripts have to be adjusted to use the binary. We can install the storybook binary and attempt to adjust your scripts for you.`].join(`
|
|
135
135
|
`);return[`We've detected you are using ${o} with scripts from previous versions of Storybook.`,t,`More info: ${E.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#start-storybook--build-storybook-binaries-removed")}`].filter(Boolean).join(`
|
|
136
136
|
|
|
137
|
-
`)},async run({result:{storybookScripts:e,packageJson:o},packageManager:t,dryRun:r}){if(
|
|
138
|
-
`);
|
|
137
|
+
`)},async run({result:{storybookScripts:e,packageJson:o},packageManager:t,dryRun:r}){if(A.log(),A.info("Adding 'storybook' as dev dependency"),A.log(),!r){let n=Re(o);t.addDependencies({installAsDevDependencies:!0},[`storybook@${n}`])}if(A.info("Updating scripts in package.json"),A.log(),!r&&Object.keys(e.official).length>0){let n=["Migrating your scripts to:",E.yellow(JSON.stringify(e.official,null,2))].join(`
|
|
138
|
+
`);A.log(n),A.log(),t.addScripts(e.official)}if(!r&&Object.keys(e.custom).length>0){let n=["We detected custom scripts that we can't automigrate:",E.yellow(JSON.stringify(e.custom,null,2)),`
|
|
139
139
|
`,`Please manually migrate the ones applicable and use the documentation below for reference: ${E.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#start-storybook--build-storybook-binaries-removed")}`].join(`
|
|
140
|
-
`);
|
|
140
|
+
`);A.log(n),A.log()}}};import X from"chalk";import so from"ts-dedent";import Je from"@storybook/semver";import{readConfig as ts,writeConfig as rs}from"@storybook/csf-tools";import{getStorybookInfo as ns}from"@storybook/core-common";var ae=console,Nt={"@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"}},ss=e=>typeof e=="string"?e.includes("vite")?"vite":"webpack5":e?.name.includes("vite")?"vite":"webpack5",as=(e,o)=>o.getFieldValue([`${e}Options`])||{},Bt={id:"newFrameworks",async check({packageManager:e}){let o=e.retrievePackageJson(),t={...o.dependencies,...o.devDependencies},{mainConfig:r,version:n,framework:s}=ns(o);if(!r)return ae.warn("Unable to find storybook main.js config, skipping"),null;let a=n&&Je.coerce(n)?.version;if(!a)return ae.warn(so`
|
|
141
141
|
❌ Unable to determine storybook version, skipping ${X.cyan("newFrameworks")} fix.
|
|
142
142
|
🤔 Are you running automigrate from your project directory?
|
|
143
|
-
`),null;if(!
|
|
143
|
+
`),null;if(!Je.gte(a,"7.0.0"))return null;let i=await ts(r),c=i.getFieldValue(["framework"]),l=i.getFieldValue(["core","builder"]);if(!c||!Object.keys(Nt).includes(c))return null;let u={name:ss(l),options:i.getFieldValue(["core","builder","options"])||{}},b=Nt[c][u.name];if(!b)return null;if(t.vite&&Je.lt(Je.coerce(t.vite).version,"3.0.0"))return ae.warn(so`
|
|
144
144
|
❌ Detected Vite ${t.vite}, which is unsupported in Storybook 7.0, so the ${X.cyan("newFrameworks")} fix will be skipped.
|
|
145
145
|
Please upgrade vite to 3.0.0 or higher and rerun this automigration with "npx storybook@future automigrate".
|
|
146
|
-
`),null;let f=
|
|
146
|
+
`),null;let f=as(s,i),h=["@storybook/builder-webpack5","@storybook/manager-webpack5","@storybook/builder-webpack4","@storybook/manager-webpack4","@storybook/builder-vite","storybook-builder-vite"].filter(Me=>t[Me]),ee=[];return b!==c&&ee.push(b),{main:i,dependenciesToAdd:ee,dependenciesToRemove:h,frameworkPackage:b,frameworkOptions:f,builderInfo:u,packageJson:o}},prompt(){return so`
|
|
147
147
|
We've detected you are using an older format of Storybook frameworks and builders.
|
|
148
148
|
|
|
149
149
|
In Storybook 7, frameworks also specify the builder to be used.
|
|
@@ -160,76 +160,80 @@ Add a project and re-run the installation`)}async function Bo(){return await Ur(
|
|
|
160
160
|
change--especially if your project has a custom webpack configuration.
|
|
161
161
|
|
|
162
162
|
To learn more about migrating from Webpack4, see: ${X.yellow("https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#webpack4-support-discontinued")}
|
|
163
|
-
`},async run({result:{dependenciesToAdd:e,dependenciesToRemove:o,main:t,frameworkPackage:r,frameworkOptions:n,builderInfo:s,packageJson:
|
|
164
|
-
`),
|
|
165
|
-
`));case"REACT_NATIVE":return(t.yes?Promise.resolve({server:!0}):
|
|
166
|
-
`));case"WEBPACK_REACT":return ct(o,r,
|
|
167
|
-
`));case"REACT_PROJECT":return
|
|
168
|
-
`));case"SFC_VUE":return st(o,r,
|
|
169
|
-
`));case"VUE":return
|
|
170
|
-
`));case"VUE3":return
|
|
171
|
-
`));case"ANGULAR":return zo(o,r,
|
|
172
|
-
`));case"EMBER":return Qo(o,r,
|
|
173
|
-
`));case"MITHRIL":return pt(o,r,
|
|
174
|
-
`));case"MARIONETTE":return lt(o,r,
|
|
175
|
-
`));case"MARKO":return dt(o,r,
|
|
176
|
-
`));case"HTML":return mt(o,r,
|
|
177
|
-
`));case"WEB_COMPONENTS":return ut(o,r,
|
|
178
|
-
`));case"RIOT":return
|
|
179
|
-
`));case"PREACT":return
|
|
180
|
-
`));case"SVELTE":return bt(o,r,
|
|
181
|
-
`));case"RAX":return kt(o,r,
|
|
182
|
-
`));case"AURELIA":return Zo(o,r,
|
|
183
|
-
`));case"SERVER":return ht(o,r,
|
|
184
|
-
`));case"UNSUPPORTED":return S("We detected a project type that we don't support yet."),S("If you'd like your framework to be supported, please let use know about it at https://github.com/storybookjs/storybook/issues"),v.log(),Promise.resolve();default:return S(`We couldn't detect your project type. (code: ${e})`),S("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"),v.log(),
|
|
185
|
-
${
|
|
163
|
+
`},async run({result:{dependenciesToAdd:e,dependenciesToRemove:o,main:t,frameworkPackage:r,frameworkOptions:n,builderInfo:s,packageJson:a},packageManager:i,dryRun:c}){if(ae.info(`\u2705 Removing legacy dependencies: ${o.join(", ")}`),c||i.removeDependencies({skipInstall:e.length>0,packageJson:a},o),e.length>0&&(ae.info(`\u2705 Installing new dependencies: ${e.join(", ")}`),!c)){let l=Re(a),d=e.map(u=>`${u}@${l}`);i.addDependencies({installAsDevDependencies:!0},d)}if(!c){ae.info("\u2705 Updating framework field in main.js");let l=t.getFieldValue(["core"]);t.setFieldValue(["framework","name"],r),t.setFieldValue(["framework","options"],n),l?.builder&&delete l.builder,Object.keys(s.options).length>0&&t.setFieldValue(["framework","options","builder"],s.options),l&&(Object.keys(l).length===0?t.setFieldValue(["core"],{}):t.setFieldValue(["core"],l)),await rs(t)}}};var Ie=[vt,j,Pt,Ct,jt,$t,Ft,It,_t,Bt];var x=console,ce=async({fixId:e,dryRun:o,yes:t}={})=>{let r=T.getPackageManager(),n=e?Ie.filter(s=>s.id===e):Ie;x.info("\u{1F50E} checking possible migrations..");for(let s=0;s<n.length;s+=1){let a=Ie[s],i;try{i=await a.check({packageManager:r})}catch{x.info(`failed to check fix: ${a.id}`)}if(i){x.info(`\u{1F50E} found a '${ie.cyan(a.id)}' migration:`),x.info();let c=a.prompt(i);x.info(cs(c,{borderStyle:"round",padding:1,borderColor:"#F1618C"}));let l;if(o?l={fix:!1}:t?l={fix:!0}:l=await is({type:"confirm",name:"fix",message:`Do you want to run the '${ie.cyan(a.id)}' migration on your project?`}),l.fix)try{await a.run({result:i,packageManager:r,dryRun:o}),x.info(`\u2705 ran ${ie.cyan(a.id)} migration`)}catch(d){x.info(`\u274C error when running ${ie.cyan(a.id)} migration:`),x.info(d),x.info()}else x.info(`Skipping the ${ie.cyan(a.id)} migration.`),x.info(),x.info(`If you change your mind, run '${ie.cyan("npx storybook@next automigrate")}'`)}}x.info(),x.info("\u2705 migration check successfully ran"),x.info()};var v=console,Gt=(e,o,t)=>{let r={installAsDevDependencies:!0,skipInstall:t.skipInstall},n;try{n=o.readPackageJson()}catch{}let a={language:$o(n),builder:t.builder||Oo(o),linkable:!!t.linkable,commonJs:t.commonJs,pnp:t.usePnp};return(async()=>{switch(e){case"ALREADY_HAS_STORYBOOK":return v.log(),S("There seems to be a Storybook already available in this project."),S(`Apply following command to force:
|
|
164
|
+
`),Se(["sb init [options] -f"]),v.log(),Promise.resolve();case"REACT_SCRIPTS":return nt(o,r,a).then(g('Adding Storybook support to your "Create React App" based project'));case"REACT":return Xe(o,r,a).then(g(`Adding Storybook support to your "React" app
|
|
165
|
+
`));case"REACT_NATIVE":return(t.yes?Promise.resolve({server:!0}):ao([{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:c})=>ot(o,r,c)).then(g(`Adding Storybook support to your "React Native" app
|
|
166
|
+
`));case"WEBPACK_REACT":return ct(o,r,a).then(g(`Adding Storybook support to your "Webpack React" app
|
|
167
|
+
`));case"REACT_PROJECT":return Xe(o,r,a).then(g(`Adding Storybook support to your "React" library
|
|
168
|
+
`));case"SFC_VUE":return st(o,r,a).then(g(`Adding Storybook support to your "Single File Components Vue" app
|
|
169
|
+
`));case"VUE":return at(o,r,a).then(g(`Adding Storybook support to your "Vue" app
|
|
170
|
+
`));case"VUE3":return it(o,r,a).then(g(`Adding Storybook support to your "Vue 3" app
|
|
171
|
+
`));case"ANGULAR":return zo(o,r,a).then(g(`Adding Storybook support to your "Angular" app
|
|
172
|
+
`));case"EMBER":return Qo(o,r,a).then(g(`Adding Storybook support to your "Ember" app
|
|
173
|
+
`));case"MITHRIL":return pt(o,r,a).then(g(`Adding Storybook support to your "Mithril" app
|
|
174
|
+
`));case"MARIONETTE":return lt(o,r,a).then(g(`Adding Storybook support to your "Marionette.js" app
|
|
175
|
+
`));case"MARKO":return dt(o,r,a).then(g(`Adding Storybook support to your "Marko" app
|
|
176
|
+
`));case"HTML":return mt(o,r,a).then(g(`Adding Storybook support to your "HTML" app
|
|
177
|
+
`));case"WEB_COMPONENTS":return ut(o,r,a).then(g(`Adding Storybook support to your "web components" app
|
|
178
|
+
`));case"RIOT":return ft(o,r,a).then(g(`Adding Storybook support to your "riot.js" app
|
|
179
|
+
`));case"PREACT":return gt(o,r,a).then(g(`Adding Storybook support to your "Preact" app
|
|
180
|
+
`));case"SVELTE":return bt(o,r,a).then(g(`Adding Storybook support to your "Svelte" app
|
|
181
|
+
`));case"RAX":return kt(o,r,a).then(g(`Adding Storybook support to your "Rax" app
|
|
182
|
+
`));case"AURELIA":return Zo(o,r,a).then(g(`Adding Storybook support to your "Aurelia" app
|
|
183
|
+
`));case"SERVER":return ht(o,r,a).then(g(`Adding Storybook support to your "Server" app
|
|
184
|
+
`));case"UNSUPPORTED":return S("We detected a project type that we don't support yet."),S("If you'd like your framework to be supported, please let use know about it at https://github.com/storybookjs/storybook/issues"),v.log(),Promise.resolve();default:return S(`We couldn't detect your project type. (code: ${e})`),S("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"),v.log(),ds(t,o)}})().catch(c=>{v.error(`
|
|
185
|
+
${fe.red(c.stack)}`),process.exit(1)})},ds=async(e,o)=>{let t=e.yes?!0:await ao([{type:"confirm",name:"manual",message:"Do you want to manually choose a Storybook project type to install?"}]);if(t!==!0&&t.manual){let r=await ao([{type:"select",name:"manualFramework",message:"Please choose a project type from the following list:",choices:xe.map(n=>({title:n,value:n.toUpperCase()}))}]);return Gt(r.manualFramework,o,e)}return Promise.resolve()};async function Mt(e,o){let t=T.getPackageManager(e.useNpm),r="storybook init - the simplest way to add a Storybook to your project.";v.log(fe.inverse(`
|
|
186
186
|
${r}
|
|
187
|
-
`)),e.disableTelemetry||
|
|
187
|
+
`)),e.disableTelemetry||ls("init"),new ps({pkg:o,updateCheckInterval:1e3*60*60}).notify();let n,s=e.type,a=s?`Installing Storybook for user specified project type: ${s}`:"Detecting project type",i=g(a),c=t.retrievePackageJson(),l=c&&c.type==="module";try{s?xe.includes(s)?n=We(c,e.force)?"ALREADY_HAS_STORYBOOK":s.toUpperCase():(i(`The provided project type was not recognized by Storybook: ${s}`),v.log(`
|
|
188
188
|
The project types currently supported by Storybook are:
|
|
189
|
-
`),
|
|
189
|
+
`),xe.sort().forEach(d=>S(`- ${d}`)),v.log(),process.exit(1)):n=Fo(c,e)}catch(d){i(d.message),process.exit(1)}if(i(),await Gt(n,t,{...e,...l?{commonJs:!0}:void 0}),e.skipInstall||t.installDependencies(),await ce({yes:e.yes||p.CI==="true"}),v.log(`
|
|
190
190
|
To run your Storybook, type:
|
|
191
|
-
`),
|
|
192
|
-
For more information visit:`,
|
|
193
|
-
`),
|
|
191
|
+
`),Se([t.getRunStorybookCommand()]),v.log(`
|
|
192
|
+
For more information visit:`,fe.cyan("https://storybook.js.org")),n==="REACT_NATIVE"){let d="https://github.com/storybookjs/react-native";v.log(),v.log(fe.red("NOTE: installation is not 100% automated.")),v.log(`To quickly run Storybook, replace contents of your app entry with:
|
|
193
|
+
`),Se(["export {default} from './storybook';"]),v.log(`
|
|
194
194
|
For more in information, see the github readme:
|
|
195
|
-
`),v.log(
|
|
195
|
+
`),v.log(fe.cyan(d)),v.log()}v.log()}import Lt from"path";import Ve from"fs";import{sync as ms}from"cross-spawn";import{getStorybookInfo as us}from"@storybook/core-common";import{readConfig as fs,writeConfig as gs}from"@storybook/csf-tools";var pe=console,ys=["addons","config","presets"],bs=async(e,o)=>{let t=null;o?Ve.existsSync(".storybook")?(t="no codmods found",ys.forEach(r=>{try{let n=U.resolve(`${getPackageName(e,o)}/postinstall/${r}.js`);g(`Running postinstall script for ${e}`)();let s=Lt.join(".storybook",`${r}.ts`);Ve.existsSync(s)||(s=Lt.join(".storybook",`${r}.js`),Ve.existsSync(s)||Ve.writeFileSync(s,"","utf8")),ms("npx",["jscodeshift","-t",n,s],{stdio:"inherit",shell:!0}),t=null}catch{}})):t="no .storybook config":t="unofficial addon",t&&g(`Skipping postinstall for ${e}, ${t}`)()},ks=e=>{let o=/^(...*)@(.*)$/.exec(e);return o?[o[1],o[2]]:[e,void 0]};async function Ut(e,o){let t=T.getPackageManager(o.useNpm),r=t.retrievePackageJson(),[n,s]=ks(e),{mainConfig:a,version:i}=us(r);if(!a){pe.error("Unable to find storybook main.js config");return}let c=await fs(a),l=c.getFieldValue(["addons"]);l&&!Array.isArray(l)&&pe.error("Expected addons array in main.js config"),pe.log(`Verifying ${n}`);let d=t.latestVersion(n);d||pe.error(`Unknown addon ${n}`);let u=n.startsWith("@storybook/"),f=`${n}@${s||(u?i:d)}`;pe.log(`Installing ${f}`),t.addDependencies({installAsDevDependencies:!0},[f]),pe.log(`Adding '${e}' to main.js addons field.`);let h=[...l||[],n];c.setFieldValue(["addons"],h),await gs(c),o.skipPostinstall||await bs(e,u)}import{listCodemods as hs,runCodemod as ws}from"@storybook/codemod";async function Wt(e,{configDir:o,glob:t,dryRun:r,list:n,rename:s,logger:a,parser:i}){if(n)hs().forEach(c=>a.log(c));else if(e)await ws(e,{configDir:o,glob:t,dryRun:r,logger:a,rename:s,parser:i});else throw new Error("Migrate: please specify a migration name or --list")}import Kt from"path";import{writeFile as vs,stat as xs}from"fs-extra";import Yt from"puppeteer-core";import Ht from"express";import Ps from"get-port";import{logger as qt}from"@storybook/node-logger";var Ss=async e=>{let o=await Rs(),t=await o.newPage();await t.goto(e),await t.waitForFunction(`
|
|
196
196
|
(window.__STORYBOOK_PREVIEW__ && window.__STORYBOOK_PREVIEW__.extract && window.__STORYBOOK_PREVIEW__.extract()) ||
|
|
197
197
|
(window.__STORYBOOK_STORY_STORE__ && window.__STORYBOOK_STORY_STORE__.extract && window.__STORYBOOK_STORY_STORE__.extract())
|
|
198
|
-
`);let r=JSON.parse(await t.evaluate(async()=>JSON.stringify(window.__STORYBOOK_STORY_STORE__.getStoriesJsonData(),null,2)));return setImmediate(()=>{o.close()}),r},
|
|
199
|
-
`).map(
|
|
198
|
+
`);let r=JSON.parse(await t.evaluate(async()=>JSON.stringify(window.__STORYBOOK_STORY_STORE__.getStoriesJsonData(),null,2)));return setImmediate(()=>{o.close()}),r},Cs=async e=>{if(await xs(Kt.resolve(e)),e.match(/^http/))return[e,async()=>{}];let o=Ht();o.use(Ht.static(e));let t=await Ps();return new Promise(r=>{let n=o.listen(t,()=>{let s=`http://localhost:${t}/iframe.html`;qt.info(`connecting to: ${s}`),r([s,n.close.bind(n)])})})},Rs=async()=>{let e=["--no-sandbox ","--disable-setuid-sandbox"];try{return await Yt.launch({args:e,executablePath:p.SB_CHROMIUM_PATH})}catch{return qt.info("installing puppeteer..."),new Promise((t,r)=>{U("child_process").exec(`node ${U.resolve(Kt.join("puppeteer-core","install.js"))}`,n=>n?r(n):t(Yt.launch({args:e})))})}};async function Xt(e,o){if(e&&o){let[t,r]=await Cs(e),n=await Ss(t);await vs(o,JSON.stringify(n,null,2)),await r()}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 Zt}from"cross-spawn";import{telemetry as Ds}from"@storybook/telemetry";import ge from"@storybook/semver";import{logger as B}from"@storybook/node-logger";var js=/(@storybook\/[^@]+)@(\S+)/,Es=e=>{if(e.startsWith("npm "))return null;let o=js.exec(e);return!o||!ge.clean(o[2])?null:{package:o[1],version:o[2]}},Ts=["@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/semver","@storybook/storybook-deployer","@storybook/test-runner","@storybook/testing-library","@storybook/testing-react"],As=e=>e.startsWith("@storybook/")&&!e.startsWith("@storybook/preset-")&&!Ts.includes(e),Os=[{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"]}],Qt=e=>`${e.package}@${e.version}`,zt=e=>e.forEach(o=>B.warn(`- ${Qt(o)}`)),$s=()=>{let o=Zt("npm",["ls"],{stdio:"pipe",shell:!0}).output.toString().split(`
|
|
199
|
+
`).map(Es).filter(Boolean).filter(n=>As(n.package));if(!o.length){B.warn("No storybook core packages found."),B.warn("'npm ls | grep storybook' can show if multiple versions are installed.");return}o.sort((n,s)=>ge.rcompare(n.version,s.version));let t=o[0].version,r=o.filter(n=>n.version!==t);r.length>0&&(B.warn(`Found ${r.length} outdated packages (relative to '${Qt(o[0])}')`),B.warn("Please make sure your packages are updated to ensure a consistent experience."),zt(r)),Os.forEach(({minVersion:n,url:s,deprecations:a})=>{if(ge.gte(t,n)){let i=o.filter(c=>a.includes(c.package));i.length>0&&(B.warn(`Found ${i.length} deprecated packages since ${n}`),B.warn(`See ${s}`),zt(i))}})},Fs={"react-scripts@<5":["--reject","/preset-create-react-app/"]},Js=(e,o,{dependencies:t,devDependencies:r})=>Object.entries(e).reduce((n,s)=>{let[a,i]=s,[c,l]=q(a),d=t[c]||r[c];return d&&ge.satisfies(ge.coerce(d),l)?[...n,...i]:n},[...o]),er=async({prerelease:e,skipCheck:o,useNpm:t,dryRun:r,yes:n,...s})=>{let a=T.getPackageManager(t);g("Checking for latest versions of '@storybook/*' packages"),s.disableTelemetry||Ds("upgrade",{prerelease:e});let i=[];r||i.push("--upgrade"),i.push("--target"),i.push(e?"greatest":"latest"),i=Js(Fs,i,a.retrievePackageJson());let c=Zt("npx",["npm-check-updates@latest","/storybook/",...i],{stdio:"pipe",shell:!0}).output.toString();B.info(c),r||(g("Installing upgrades"),a.installDependencies()),o||($s(),await ce({dryRun:r,yes:n}))};import mo from"prompts";import ma from"fs";import nr from"path";import ye from"chalk";import sr from"boxen";import{dedent as ar}from"ts-dedent";import C from"path";import{readJSON as or,writeJSON as lo,outputFile as Zs}from"fs-extra";import tr from"shelljs";import Qs from"chalk";import{command as ea}from"execa";var Ne={};Rr(Ne,{angular:()=>Ls,angular12:()=>Bs,angular13:()=>Ms,angular130:()=>Gs,cra:()=>io,cra_typescript:()=>co,html:()=>Ks,preact:()=>qs,react:()=>Is,react_in_yarn_workspace:()=>Ns,react_legacy_root_api:()=>Vs,react_typescript:()=>_s,sfcVue:()=>Xs,svelte:()=>zs,vue:()=>Ys,vue3:()=>Hs,web_components:()=>po,web_components_lit2:()=>Ws,web_components_typescript:()=>Us});var z=(...e)=>["mkdir {{appName}}","cd {{appName}}","touch yarn.lock","yarn init --yes",e.length&&`yarn add ${e.join(" ")}`].filter(Boolean).join(" && "),io={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(" && ")},co={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(" && ")},Is={renderer:"react",name:"react",version:"latest",generator:z("react","react-dom","@babel/preset-react"),additionalDeps:["prop-types"],additionalFiles:[{path:".babelrc",contents:'{ "presets": ["@babel/preset-react"] }'}]},Vs={renderer:"react",name:"react_legacy_root_api",version:"latest",generator:z("react","react-dom"),additionalDeps:["prop-types","@babel/preset-react"],additionalFiles:[{path:".babelrc",contents:'{ "presets": ["@babel/preset-react"] }'}],mainOverrides:{reactOptions:{legacyRootApi:!0}}},_s={renderer:"react",name:"react_typescript",version:"latest",generator:z("react","react-dom"),typescript:!0,additionalDeps:["@babel/preset-react","@babel/preset-typescript"],additionalFiles:[{path:".babelrc",contents:'{ "presets": ["@babel/preset-react", "@babel/preset-typescript"] }'}]},Ns={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(" && ")},_e={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"},Bs={..._e,name:"angular12",version:"v12-lts"},Gs={..._e,name:"angular130",version:"13.0.x"},Ms={..._e,name:"angular13",version:"13.1.x"},Ls=_e,po={renderer:"web-components",name:"web_components",version:"2",generator:z("lit-element")},Us={...po,name:"web_components_typescript",typescript:!0,additionalDeps:["@babel/preset-typescript"],additionalFiles:[{path:".babelrc",contents:'{ "presets": ["@babel/preset-typescript"] }'}]},Ws={...po,version:"next",name:"web_components_lit2",generator:z("lit"),typescript:!0,additionalDeps:["@babel/preset-typescript"],additionalFiles:[{path:".babelrc",contents:'{ "presets": ["@babel/preset-typescript"] }'}]},Ys={renderer:"vue",name:"vue",version:"latest",generator:['npx -p @vue/cli vue create {{appName}} --default --packageManager=yarn --force --merge --preset="Default (Vue 2)"'].join(" && ")},Hs={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(" && ")},Ks={renderer:"html",name:"html",version:"latest",generator:z(),autoDetect:!1},qs={renderer:"preact",name:"preact",version:"latest",generator:"npx preact-cli@{{version}} create preactjs-templates/default {{appName}} --install=false --git=false"},Xs={renderer:"vue",name:"sfcVue",version:"latest",generator:z("vue@2.6","vue-loader@15.9","vue-template-compiler@2.6","webpack")},zs={renderer:"svelte",name:"svelte",version:"latest",generator:"npx degit sveltejs/template {{appName}}"};var P=console,w=async(e,o={},{startMessage:t,errorMessage:r,dryRun:n}={})=>{if(t&&P.info(t),n){P.info(`
|
|
200
200
|
> ${e}
|
|
201
|
-
`);return}return P.debug(e),new Promise((s,
|
|
202
|
-
`).join(",")}]`);console.log({workspaces:s}),t.resolutions=Object.keys(D).reduce((i
|
|
203
|
-
🤗 Welcome to ${
|
|
201
|
+
`);return}return P.debug(e),new Promise((s,a)=>{let i={silent:!1},c=tr.exec(e,{...i,...o,async:!0,silent:!1});c.stderr.pipe(process.stderr),c.on("exit",l=>{l===0?s(void 0):(P.error(Qs.red(`An error occurred while executing: \`${e}\``)),P.log(r),a(new Error(`command exited with code: ${l}: `)))})})},oa=async({cwd:e})=>{P.info("\u{1F522} Adding package resolutions:");let o=C.join(e,"package.json"),t=await or(o);t.resolutions=D,await lo(o,t,{spaces:2})},ta=async({cwd:e})=>{P.info("\u{1F522} Adding package resolutions:");let o=C.join(e,"package.json"),t=await or(o),r=C.join(__dirname,"..","..","..","..",".."),{stdout:n}=await ea("yarn workspaces list --json",{cwd:r});console.log({stdout:n,workspaceDir:r});let s=JSON.parse(`[${n.split(`
|
|
202
|
+
`).join(",")}]`);console.log({workspaces:s}),t.resolutions=Object.keys(D).reduce((a,i)=>({...a,[i]:C.join(r,s.find(c=>c.name===i).location)}),{}),await lo(o,t,{spaces:2})},ra=async({cwd:e,pnp:o,name:t})=>{let r=["yarn set version berry","yarn config set enableGlobalCache true",`yarn config set nodeLinker ${o?"pnp":"node-modules"}`];[io.name,co.name].includes(t)&&r.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 w(r.join(" && "),{cwd:e},{startMessage:"\u{1F9F6} Installing Yarn 2",errorMessage:"\u{1F6A8} Installing Yarn 2 failed"})},na=async({cwd:e})=>{let o=[`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 w(o,{cwd:e},{startMessage:"\u{1F39B} Configuring Yarn 2",errorMessage:"\u{1F6A8} Configuring Yarn 2 failed"})},sa=async({cwd:e,name:o,appName:t,version:r,generator:n})=>{let s=n.replace(/{{appName}}/g,t).replace(/{{version}}/g,r);await w(s,{cwd:e},{startMessage:`\u{1F3D7} Bootstrapping ${o} project (this might take a few minutes)`,errorMessage:`\u{1F6A8} Bootstrapping ${o} failed`})},aa=async({additionalFiles:e,cwd:o})=>{P.info("\u2935\uFE0F Adding required files"),await Promise.all(e.map(async t=>{await Zs(C.resolve(o,t.path),t.contents,{encoding:"UTF-8"})}))},ia=async({cwd:e,autoDetect:o=!0,name:t,e2e:r,pnp:n})=>{let s=["--yes"];o||s.push(`--type ${t}`),r&&s.push("--linkable"),n&&s.push("--use-pnp");let i=`${`node ${__filename}`} init ${s.join(" ")}`;await w(i,{cwd:e},{startMessage:"\u{1F3A8} Initializing Storybook with @storybook/cli",errorMessage:"\u{1F6A8} Storybook initialization failed"})},ca=async({cwd:e,additionalDeps:o})=>{tr.rm("-f",C.join(e,"package-lock.json"),C.join(e,"yarn.lock"));let t=o&&o.length>0?`yarn add -D ${o.join(" ")}`:"yarn install";await w(t,{cwd:e},{startMessage:"\u{1F30D} Adding needed deps & installing all deps",errorMessage:"\u{1F6A8} Dependencies installation failed"})},pa=async({cwd:e})=>{P.info("\u{1F46E} Adding typescript and tsconfig.json");try{await w("yarn add -D typescript@latest",{cwd:e});let o={compilerOptions:{baseUrl:".",esModuleInterop:!0,jsx:"preserve",skipLibCheck:!0,strict:!0},include:["src/*"]},t=C.resolve(e,"tsconfig.json");await lo(t,o,{encoding:"utf8",spaces:2})}catch(o){throw P.error("\u{1F6A8} Creating tsconfig.json failed"),o}},F=async(e,o,t=!0)=>{t&&(await e(o),P.log())},la=e=>w(`npm ${["config","set","registry",e].join(" ")}`,{cwd:C.join(process.cwd(),"..")}),da=e=>w(`yarn ${["config","set","npmRegistryServer",e].join(" ")}`,{cwd:C.join(__dirname,"..")}),rr=async(e,{name:o,version:t,...r},{e2e:n,pnp:s,local:a,registry:i})=>{let c={name:o,version:t,appName:C.basename(e),creationPath:C.join(e,".."),cwd:e,e2e:n,pnp:s,...r};P.log(),P.info(`\u{1F3C3} Starting for ${o} ${t}`),P.log(),await F(sa,{...c,cwd:c.creationPath}),await F(aa,{...c,cwd:e},!!c.additionalFiles),n&&await F(oa,c),a&&await F(ta,c),await F(ra,c),n&&await F(na,c,n),await F(pa,c,!!c.typescript),await F(ca,c),i&&(await la(i),await da(i)),await F(ia,c)};var G=console,ua=Ne,fa=Object.fromEntries(Object.entries(Ne).filter(e=>e[0]!=="react_in_yarn_workspace")),uo=Object.values(fa).reduce((e,o)=>(e[o.renderer]=[...e[o.renderer]||[],o],e),{}),ir=async({outputDirectory:e,list:o,template:t,renderer:r,generator:n,e2e:s,local:a,registry:i,pnp:c})=>{if(G.info(sr(ar`
|
|
203
|
+
🤗 Welcome to ${ye.yellow("sb repro")}! 🤗
|
|
204
204
|
|
|
205
|
-
Create a ${
|
|
205
|
+
Create a ${ye.green("new project")} to minimally reproduce Storybook issues.
|
|
206
206
|
|
|
207
207
|
1. select an environment that most closely matches your project setup.
|
|
208
208
|
2. select a location for the reproduction, outside of your project.
|
|
209
209
|
|
|
210
210
|
After the reproduction is ready, we'll guide you through the next steps.
|
|
211
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),o){G.info("\u{1F308} Available templates"),Object.entries(uo).forEach(([f,h])=>{G.info(f),h.forEach(ee=>G.info(`- ${ee.name}`)),f==="other"&&G.info("- blank")});return}let l=t,d=r;if(!l&&!n){if(!d){let{renderer:f}=await mo({type:"select",message:"\u{1F308} Select the repro renderer",name:"renderer",choices:Object.keys(uo).map(h=>({title:h,value:h}))});d=f}if(!d)throw new Error("\u{1F6A8} Repro: please select a renderer!");l=(await mo({type:"select",message:"\u{1F4DD} Select the repro base template",name:"template",choices:uo[d].map(f=>({title:f.name,value:f.name}))})).template}let
|
|
211
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),o){G.info("\u{1F308} Available templates"),Object.entries(uo).forEach(([f,h])=>{G.info(f),h.forEach(ee=>G.info(`- ${ee.name}`)),f==="other"&&G.info("- blank")});return}let l=t,d=r;if(!l&&!n){if(!d){let{renderer:f}=await mo({type:"select",message:"\u{1F308} Select the repro renderer",name:"renderer",choices:Object.keys(uo).map(h=>({title:h,value:h}))});d=f}if(!d)throw new Error("\u{1F6A8} Repro: please select a renderer!");l=(await mo({type:"select",message:"\u{1F4DD} Select the repro base template",name:"template",choices:uo[d].map(f=>({title:f.name,value:f.name}))})).template}let u=n?{name:"custom",version:"custom",generator:n}:ua[l];if(!u)throw new Error("\u{1F6A8} Repro: please specify a valid template type");let b=e;if(!b){let{directory:f}=await mo({type:"text",message:"Enter the output directory",name:"directory",initial:u.name,validate:h=>ma.existsSync(h)?`${h} already exists. Please choose another name.`:!0});b=f}try{let f=nr.isAbsolute(b)?b:nr.join(process.cwd(),b);G.info(`\u{1F3C3} Running ${l} into ${f}`),await rr(f,u,{registry:i,e2e:!!s,pnp:!!c,local:!!a}),s||await ga(f),G.info(sr(ar`
|
|
212
212
|
🎉 Your Storybook reproduction project is ready to use! 🎉
|
|
213
213
|
|
|
214
|
-
${
|
|
215
|
-
${
|
|
214
|
+
${ye.yellow(`cd ${b}`)}
|
|
215
|
+
${ye.yellow("yarn storybook")}
|
|
216
216
|
|
|
217
217
|
Once you've recreated the problem you're experiencing, please:
|
|
218
218
|
|
|
219
|
-
1. Document any additional steps in ${
|
|
219
|
+
1. Document any additional steps in ${ye.cyan("README.md")}
|
|
220
220
|
2. Publish the repository to github
|
|
221
221
|
3. Link to the repro repository in your issue
|
|
222
222
|
|
|
223
223
|
Having a clean repro helps us solve your issue faster! 🙏
|
|
224
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}))}catch(f){throw G.error("\u{1F6A8} Failed to create repro"),f}},
|
|
224
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}))}catch(f){throw G.error("\u{1F6A8} Failed to create repro"),f}},ga=async e=>{await w("git init",{cwd:e}),await w('echo "node_modules" >> .gitignore',{cwd:e}),await w("git add --all",{cwd:e}),await w('git commit -am "added storybook"',{cwd:e}),await w("git tag repro-base",{cwd:e})};import lr from"prompts";import cr from"path";import M from"chalk";import fo from"boxen";import{dedent as go}from"ts-dedent";import Sa from"degit";import{existsSync as pr}from"fs-extra";var ya={"cra/default-js":{name:"Create React App (Javascript)",script:"npx create-react-app .",cadence:["ci","daily","weekly"],expected:{framework:"@storybook/cra",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"}},"cra/default-ts":{name:"Create React App (Typescript)",script:"npx create-react-app . --template typescript",cadence:["ci","daily","weekly"],skipTasks:["smoke-test"],expected:{framework:"@storybook/cra",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"}}},ba={"react-vite/default-js":{name:"React Vite (JS)",script:"yarn create vite . --template react",cadence:["ci","daily","weekly"],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",cadence:["ci","daily","weekly"],expected:{framework:"@storybook/react-vite",renderer:"@storybook/react",builder:"@storybook/builder-vite"}}},ka={"react-webpack/18-ts":{name:"React Webpack5 (TS)",script:"yarn create webpack5-react .",cadence:["ci","daily","weekly"],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"',cadence:["ci","daily","weekly"],expected:{framework:"@storybook/react-webpack5",renderer:"@storybook/react",builder:"@storybook/builder-webpack5"}}},ha={"vue3-vite/default-js":{name:"Vue3 Vite (JS)",script:"yarn create vite . --template vue",cadence:["ci","daily","weekly"],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",cadence:["ci","daily","weekly"],expected:{framework:"@storybook/vue3-vite",renderer:"@storybook/vue3",builder:"@storybook/builder-vite"}}},wa={"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';
|
|
225
|
+
|
|
226
|
+
export default {
|
|
227
|
+
plugins: [vue2()]
|
|
228
|
+
};" > vite.config.js`,cadence:["ci","daily","weekly"],expected:{framework:"@storybook/vue2-vite",renderer:"@storybook/vue",builder:"@storybook/builder-vite"}}},va={"svelte-vite/default-js":{name:"Svelte Vite (JS)",script:"yarn create vite . --template svelte",cadence:["ci","daily","weekly"],expected:{framework:"@storybook/svelte-vite",renderer:"@storybook/svelte",builder:"@storybook/builder-vite"}}},xa={"lit-vite/default-js":{name:"Lit Vite (JS)",script:"yarn create vite . --template lit",cadence:[],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",cadence:[],expected:{framework:"@storybook/web-components-vite",renderer:"@storybook/web-components",builder:"@storybook/builder-vite"}}},Pa={"vue-cli/default-js":{name:"Vue-CLI (Default JS)",script:"npx -p @vue/cli vue create . --default --packageManager=yarn --force --merge",cadence:["ci","daily","weekly"],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)",cadence:["ci","daily","weekly"],expected:{framework:"@storybook/vue-webpack5",renderer:"@storybook/vue",builder:"@storybook/builder-webpack5"}}},be={...ya,...ka,...ba,...wa,...ha,...va,...xa,...Pa};var J=console,Ca=e=>({title:be[e].name,value:e}),dr=async({output:e,filterValue:o,branch:t,init:r})=>{let n=Object.keys(be),s=n.reduce((u,b)=>{let f=be[b],h=new RegExp(o,"i");return(!o||f.name.match(h)||b.match(h)||f.expected.builder.match(h)||f.expected.framework.match(h)||f.expected.renderer.match(h))&&u.push(b),u},[]);s.length===0&&(J.info(fo(go`
|
|
225
229
|
🔎 You filtered out all templates. 🔍
|
|
226
230
|
|
|
227
231
|
After filtering all the templates with "${M.yellow(o)}", we found no results. Please try again with a different filter.
|
|
228
232
|
|
|
229
233
|
Available templates:
|
|
230
|
-
${n.map(
|
|
234
|
+
${n.map(u=>M.blue`- ${u}`).join(`
|
|
231
235
|
`)}
|
|
232
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),process.exit(1));let
|
|
236
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),process.exit(1));let a=null;if(s.length===1?[a]=s:(J.info(fo(go`
|
|
233
237
|
🤗 Welcome to ${M.yellow("sb repro NEXT")}! 🤗
|
|
234
238
|
|
|
235
239
|
Create a ${M.green("new project")} to minimally reproduce Storybook issues.
|
|
@@ -238,11 +242,11 @@ For more information visit:`,me.cyan("https://storybook.js.org")),n==="REACT_NAT
|
|
|
238
242
|
2. select a location for the reproduction, outside of your project.
|
|
239
243
|
|
|
240
244
|
After the reproduction is ready, we'll guide you through the next steps.
|
|
241
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),
|
|
245
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"})),a=await Ra(s)),!!!(a??null)){J.error("Somehow we got no templates. Please rerun this command!");return}let c=be[a];if(!c)throw new Error("\u{1F6A8} Repro: please specify a valid template type");let l=e,d=e||a;if(l&&pr(`${l}`)&&J.info(`\u26A0\uFE0F ${l} already exists! Overwriting...`),!l){let{directory:u}=await lr({type:"text",message:"Enter the output directory",name:"directory",initial:d,validate:async b=>pr(b)?`${b} already exists. Please choose another name.`:!0});l=u}try{let u=cr.isAbsolute(l)?l:cr.join(process.cwd(),l);J.info(`\u{1F3C3} Adding ${c.name} into ${u}`),J.log("\u{1F4E6} Downloading repro template...");try{await Sa(`storybookjs/repro-templates-temp/${a}/${r?"after-storybook":"before-storybook"}#${t}`,{force:!0}).clone(u)}catch(f){throw J.error(`\u{1F6A8} Failed to download repro template: ${f.message}`),f}let b=r?M.yellow("yarn storybook"):`Recreate your setup, then ${M.yellow("run npx storybook init")}`;J.info(fo(go`
|
|
242
246
|
🎉 Your Storybook reproduction project is ready to use! 🎉
|
|
243
247
|
|
|
244
248
|
${M.yellow(`cd ${l}`)}
|
|
245
|
-
${
|
|
249
|
+
${b}
|
|
246
250
|
|
|
247
251
|
Once you've recreated the problem you're experiencing, please:
|
|
248
252
|
|
|
@@ -251,15 +255,15 @@ For more information visit:`,me.cyan("https://storybook.js.org")),n==="REACT_NAT
|
|
|
251
255
|
3. Link to the repro repository in your issue
|
|
252
256
|
|
|
253
257
|
Having a clean repro helps us solve your issue faster! 🙏
|
|
254
|
-
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}))}catch(
|
|
258
|
+
`.trim(),{borderStyle:"round",padding:1,borderColor:"#F1618C"}))}catch(u){throw J.error("\u{1F6A8} Failed to create repro"),u}};async function Ra(e){let{template:o}=await lr({type:"select",message:"\u{1F308} Select the template",name:"template",choices:e.map(Ca)});return o||null}import mr from"fs-extra";import ke from"path";import{sync as Da}from"cross-spawn";import{logger as O}from"@storybook/node-logger";var ur=async({target:e,local:o,start:t})=>{let r=process.cwd();try{if(JSON.parse(mr.readFileSync("package.json","utf8")).name!=="@storybook/root")throw new Error}catch{throw new Error("Expected to run link from the root of the storybook monorepo")}let n=e,s=ke.basename(e);if(!o){let i=ke.join(r,"../storybook-repros");O.info(`Ensuring directory ${i}`),mr.ensureDirSync(i),O.info(`Cloning ${e}`),await w(`git clone ${e}`,{cwd:i}),s=ke.basename(e,ke.extname(e)),n=ke.join(i,s)}let a=Da("yarn",["--version"],{cwd:n,stdio:"pipe",shell:!0}).stdout.toString();if(!/^[23]\./.test(a)){O.warn(`\u{1F6A8} Expected yarn 2 or 3 in ${n}!`),O.warn(""),O.warn("Please set it up with `yarn set version berry`,"),O.warn(`then link '${n}' with the '--local' flag.`);return}O.info(`Linking ${n}`),await w(`yarn link --all ${r}`,{cwd:n}),O.info(`Installing ${s}`),await w("yarn install",{cwd:n}),O.info("Magic stuff related to @storybook/preset-create-react-app, we need to fix peerDependencies"),await w("yarn add -D webpack-hot-middleware",{cwd:n}),t&&(O.info(`Running ${s} storybook`),await w("yarn run storybook",{cwd:n}))};import{dedent as fr}from"ts-dedent";import{sync as ja}from"read-pkg-up";import{logger as Z,instance as Ea}from"@storybook/node-logger";import{buildDevStandalone as Ta}from"@storybook/core-server";import{cache as Aa}from"@storybook/core-common";var gr=async e=>{"production"="production";try{await Ta({...e,configDir:e.configDir||"./.storybook",configType:"DEVELOPMENT",ignorePreview:!!e.previewUrl&&!e.forceBuildPreview,docsMode:!!e.docs,cache:Aa,packageJson:ja({cwd:__dirname}).packageJson})}catch(o){Ea.heading="",o instanceof Error?o.error?Z.error(o.error):o.stats&&o.stats.compilation.errors?o.stats.compilation.errors.forEach(t=>Z.plain(t)):Z.error(o):o.compilation?.errors&&o.compilation.errors.forEach(t=>Z.plain(t)),Z.line(),Z.warn(o.close?fr`
|
|
255
259
|
FATAL broken build!, will close the process,
|
|
256
260
|
Fix the error below and restart storybook.
|
|
257
|
-
`:
|
|
261
|
+
`:fr`
|
|
258
262
|
Broken build, fix the error above.
|
|
259
263
|
You may need to refresh the browser.
|
|
260
|
-
`),Z.line(),process.exit(1)}};import{sync as
|
|
261
|
-
Environment Info:`)),
|
|
262
|
-
`)),yo(
|
|
263
|
-
`)),yo(
|
|
264
|
-
See --help for a list of available commands.`,e);let t=
|
|
265
|
-
Did you mean ${t}?`),process.exit(1)});
|
|
264
|
+
`),Z.line(),process.exit(1)}};import{sync as Oa}from"read-pkg-up";import{logger as $a}from"@storybook/node-logger";import{buildStaticStandalone as Fa}from"@storybook/core-server";import{cache as Ja}from"@storybook/core-common";var yr=async e=>{try{await Fa({...e,configDir:e.configDir||"./.storybook",outputDir:e.outputDir||"./storybook-static",ignorePreview:!!e.previewUrl&&!e.forceBuildPreview,docsMode:!!e.docs,configType:"PRODUCTION",cache:Ja,packageJson:Oa({cwd:__dirname}).packageJson})}catch(o){$a.error(o),process.exit(1)}};function Be(e){return e.split(",").map(o=>o.trim()).filter(o=>o.length>0)}function yo(e,o){Object.keys(o).forEach(t=>{let r=o[t],n=p[r];n&&(e[t]=n)})}var L=Na({cwd:__dirname}).packageJson,Q=console;k.option("--disable-telemetry","disable sending telemetry data",p.STORYBOOK_DISABLE_TELEMETRY&&p.STORYBOOK_DISABLE_TELEMETRY!=="false");k.option("--enable-crash-reports","enable sending crash reports to telemetry data");k.command("init").description("Initialize Storybook into your project.").option("-f --force","Force add Storybook").option("-s --skip-install","Skip installing deps").option("-N --use-npm","Use npm to install deps").option("--use-pnp","Enable pnp mode").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 <builder>","Builder library").option("-l --linkable","Prepare installation for link (contributor helper)").action(e=>Mt(e,L).catch(o=>{I.error(o),process.exit(1)}));k.command("add <addon>").description("Add an addon to your Storybook").option("-N --use-npm","Use NPM to build the Storybook server").option("-s --skip-postinstall","Skip package specific postinstall config modifications").action((e,o)=>Ut(e,o));k.command("babelrc").description("generate the default storybook babel config into your current working directory").action(()=>Ae());k.command("upgrade").description("Upgrade your Storybook packages to the latest").option("-N --use-npm","Use NPM to build the Storybook server").option("-y --yes","Skip prompting the user").option("-n --dry-run","Only check for upgrades, do not install").option("-p --prerelease","Upgrade to the pre-release packages").option("-s --skip-check","Skip postinstall version and automigration checks").action(e=>er(e));k.command("info").description("Prints debugging information about the local environment").action(()=>{Q.log(Ge.bold(`
|
|
265
|
+
Environment Info:`)),Va.run({System:["OS","CPU"],Binaries:["Node","Yarn","npm"],Browsers:["Chrome","Edge","Firefox","Safari"],npmPackages:"@storybook/*",npmGlobalPackages:"@storybook/*"}).then(Q.log)});k.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((e,{configDir:o,glob:t,dryRun:r,list:n,rename:s,parser:a})=>{Wt(e,{configDir:o,glob:t,dryRun:r,list:n,rename:s,parser:a,logger:Q}).catch(i=>{I.error(i),process.exit(1)})});k.command("extract [location] [output]").description("extract stories.json from a built version").action((e="storybook-static",o=Ia.join(e,"stories.json"))=>Xt(e,o).catch(t=>{I.error(t),process.exit(1)}));k.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((e,{renderer:o,template:t,list:r,e2e:n,generator:s,pnp:a,local:i})=>ir({outputDirectory:e,renderer:o,template:t,list:r,e2e:n,local:i,generator:s,pnp:a}).catch(c=>{I.error(c),process.exit(1)}));k.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 degit from","next").option("--no-init","Whether to download a template without an initialized Storybook",!1).action((e,o)=>dr({filterValue:e,...o}).catch(t=>{I.error(t),process.exit(1)}));k.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((e,{local:o,start:t})=>ur({target:e,local:o,start:t}).catch(r=>{I.error(r),process.exit(1)}));k.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").action((e,o)=>ce({fixId:e,...o}).catch(t=>{I.error(t),process.exit(1)}));k.command("dev").option("-p, --port <number>","Port to run Storybook",e=>parseInt(e,10)).option("-h, --host <string>","Host to run Storybook").option("-s, --static-dir <dir-names>","Directory where to load static files from",Be).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)",Be).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(e=>{I.setLevel(k.loglevel),Q.log(Ge.bold(`${L.name} v${L.version}`)+Ge.reset(`
|
|
266
|
+
`)),yo(k,{port:"SBCONFIG_PORT",host:"SBCONFIG_HOSTNAME",staticDir:"SBCONFIG_STATIC_DIR",configDir:"SBCONFIG_CONFIG_DIR",ci:"CI"}),typeof k.port=="string"&&k.port.length>0&&(k.port=parseInt(k.port,10)),gr({...e,packageJson:L})});k.command("build").option("-s, --static-dir <dir-names>","Directory where to load static files from",Be).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(e=>{"production"="production",I.setLevel(k.loglevel),Q.log(Ge.bold(`${L.name} v${L.version}
|
|
267
|
+
`)),yo(k,{staticDir:"SBCONFIG_STATIC_DIR",outputDir:"SBCONFIG_OUTPUT_DIR",configDir:"SBCONFIG_CONFIG_DIR"}),yr({...e,packageJson:L})});k.on("command:*",([e])=>{Q.error(` Invalid command: %s.
|
|
268
|
+
See --help for a list of available commands.`,e);let t=k.commands.map(r=>r._name).find(r=>_a(r,e)<3);t&&Q.info(`
|
|
269
|
+
Did you mean ${t}?`),process.exit(1)});k.usage("<command> [options]").version(L.version).parse(process.argv);
|