@nx/storybook 16.0.0-beta.1

package/src/generators/migrate-7/calling-storybook-cli.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.callAutomigrate = exports.callUpgrade = void 0;
+const devkit_1 = require("@nx/devkit");
+const child_process_1 = require("child_process");
+function callUpgrade(schema) {
+    try {
+        devkit_1.output.log({
+            title: `Calling sb upgrade`,
+            bodyLines: [
+                `ℹ️ Nx will call the Storybook CLI to upgrade your @storybook/* packages to the latest version.`,
+                `📖 You can read more about the Storybook upgrade command here: https://storybook.js.org/docs/7.0/react/configure/upgrading`,
+            ],
+            color: 'blue',
+        });
+        (0, child_process_1.execSync)(`npx storybook@next upgrade --prerelease ${schema.autoAcceptAllPrompts ? '--yes' : ''}`, {
+            stdio: [0, 1, 2],
+        });
+        devkit_1.output.log({
+            title: `Storybook packages upgraded.`,
+            bodyLines: [
+                `☑️ The upgrade command was successful.`,
+                `Your Storybook packages are now at the latest version.`,
+            ],
+            color: 'green',
+        });
+    }
+    catch (e) {
+        devkit_1.output.log({
+            title: 'Migration failed',
+            bodyLines: [
+                `🚨 The Storybook CLI failed to upgrade your @storybook/* packages to the latest version.`,
+                `Please try running the sb upgrade command manually:`,
+                `npx storybook@next upgrade --prerelease`,
+            ],
+            color: 'red',
+        });
+        console.log(e);
+        return 1;
+    }
+}
+exports.callUpgrade = callUpgrade;
+function callAutomigrate(allStorybookProjects, schema) {
+    devkit_1.output.log({
+        title: `⚙️ Calling sb automigrate`,
+        bodyLines: [
+            `ℹ️  Nx will call the Storybook CLI to automigrate the Storybook configuration of all your projects that use Storybook.`,
+            `📖 You can read more about the Storybook automigrate command here: https://storybook.js.org/docs/7.0/react/configure/upgrading#automigrate-script`,
+        ],
+        color: 'green',
+    });
+    const resultOfMigration = {
+        successfulProjects: {},
+        failedProjects: {},
+    };
+    Object.entries(allStorybookProjects).forEach(([projectName, storybookProjectInfo]) => {
+        const commandToRun = `npx sb@next automigrate --config-dir ${storybookProjectInfo.configDir} --renderer ${storybookProjectInfo.uiFramework}`;
+        try {
+            devkit_1.output.log({
+                title: `Calling sb automigrate for ${projectName}`,
+                bodyLines: ['Command:', commandToRun],
+                color: 'green',
+            });
+            (0, child_process_1.execSync)(`${commandToRun}  ${schema.autoAcceptAllPrompts ? '--yes' : ''}`, {
+                stdio: 'inherit',
+            });
+            resultOfMigration.successfulProjects[projectName] = commandToRun;
+        }
+        catch (e) {
+            devkit_1.output.error({
+                title: 'Migration failed',
+                bodyLines: [
+                    `🚨 The Storybook CLI failed to automigrate the Storybook configuration of your project.`,
+                    `The error was: ${e}`,
+                    `Please try running the sb automigrate command manually:`,
+                    commandToRun,
+                ],
+            });
+            resultOfMigration.failedProjects[projectName] = commandToRun;
+        }
+    });
+    return resultOfMigration;
+}
+exports.callAutomigrate = callAutomigrate;
+//# sourceMappingURL=calling-storybook-cli.js.map

package/src/generators/migrate-7/calling-storybook-cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calling-storybook-cli.js","sourceRoot":"","sources":["../../../../../../packages/storybook/src/generators/migrate-7/calling-storybook-cli.ts"],"names":[],"mappings":";;;AAAA,uCAAoC;AACpC,iDAAyC;AAGzC,SAAgB,WAAW,CAAC,MAAc;IACxC,IAAI;QACF,eAAM,CAAC,GAAG,CAAC;YACT,KAAK,EAAE,oBAAoB;YAC3B,SAAS,EAAE;gBACT,gGAAgG;gBAChG,4HAA4H;aAC7H;YACD,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,IAAA,wBAAQ,EACN,2CACE,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAC1C,EAAE,EACF;YACE,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;SACjB,CACF,CAAC;QAEF,eAAM,CAAC,GAAG,CAAC;YACT,KAAK,EAAE,8BAA8B;YACrC,SAAS,EAAE;gBACT,wCAAwC;gBACxC,wDAAwD;aACzD;YACD,KAAK,EAAE,OAAO;SACf,CAAC,CAAC;KACJ;IAAC,OAAO,CAAC,EAAE;QACV,eAAM,CAAC,GAAG,CAAC;YACT,KAAK,EAAE,kBAAkB;YACzB,SAAS,EAAE;gBACT,0FAA0F;gBAC1F,qDAAqD;gBACrD,yCAAyC;aAC1C;YACD,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACf,OAAO,CAAC,CAAC;KACV;AACH,CAAC;AAzCD,kCAyCC;AAED,SAAgB,eAAe,CAC7B,oBAMC,EACD,MAAc;IAEd,eAAM,CAAC,GAAG,CAAC;QACT,KAAK,EAAE,2BAA2B;QAClC,SAAS,EAAE;YACT,wHAAwH;YACxH,mJAAmJ;SACpJ;QACD,KAAK,EAAE,OAAO;KACf,CAAC,CAAC;IAEH,MAAM,iBAAiB,GAAG;QACxB,kBAAkB,EAAE,EAAE;QACtB,cAAc,EAAE,EAAE;KACnB,CAAC;IAEF,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAC1C,CAAC,CAAC,WAAW,EAAE,oBAAoB,CAAC,EAAE,EAAE;QACtC,MAAM,YAAY,GAAG,wCAAwC,oBAAoB,CAAC,SAAS,eAAe,oBAAoB,CAAC,WAAW,EAAE,CAAC;QAC7I,IAAI;YACF,eAAM,CAAC,GAAG,CAAC;gBACT,KAAK,EAAE,8BAA8B,WAAW,EAAE;gBAClD,SAAS,EAAE,CAAC,UAAU,EAAE,YAAY,CAAC;gBACrC,KAAK,EAAE,OAAO;aACf,CAAC,CAAC;YAEH,IAAA,wBAAQ,EACN,GAAG,YAAY,KAAK,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,EAChE;gBACE,KAAK,EAAE,SAAS;aACjB,CACF,CAAC;YAEF,iBAAiB,CAAC,kBAAkB,CAAC,WAAW,CAAC,GAAG,YAAY,CAAC;SAClE;QAAC,OAAO,CAAC,EAAE;YACV,eAAM,CAAC,KAAK,CAAC;gBACX,KAAK,EAAE,kBAAkB;gBACzB,SAAS,EAAE;oBACT,yFAAyF;oBACzF,kBAAkB,CAAC,EAAE;oBACrB,yDAAyD;oBACzD,YAAY;iBACb;aACF,CAAC,CAAC;YACH,iBAAiB,CAAC,cAAc,CAAC,WAAW,CAAC,GAAG,YAAY,CAAC;SAC9D;IACH,CAAC,CACF,CAAC;IAEF,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AA1DD,0CA0DC"}

package/src/generators/migrate-7/files/storybook-migration-summary.md__tmpl__

@@ -0,0 +1,80 @@
+# Storybook 7 Migration Summary
+
+## Upgrade Storybook packages
+
+The following command was ran to upgrade the Storybook packages:
+
+```bash
+npx storybook@next upgrade --prerelease
+```
+
+## Your `.storybook/main.js|ts` files were prepared for Storybook's automigration scripts
+
+Some adjustments were made to your `.storybook/main.js|ts` files so that
+the Storybook automigration scripts could run successfully. The changes that were made are as follows:
+
+- Remove the `as StorybookConfig` typecast from the main.ts files, if any,
+  since it is not needed any more.
+- Remove the `path.resolve` calls from the Next.js Storybook configuration, if any, since it breaks the Storybook automigration scripts.
+
+## The Storybook automigration scripts were ran
+
+<% if ( hasSuccessfulProjects ) { %>
+The following commands ran successfully and your Storybook configuration was successfully migrated to the latest version 7:
+
+<% for (let command of successfulProjects) { %>
+- `<%= command %>`
+<% } %>
+
+Please make sure to check the results yourself and make sure that everything is working as expected.
+<% } %>
+
+<% if ( hasFailedProjects ) { %>
+### Some migrations failed
+
+The following commands failed and your Storybook configuration for these projects was not
+migrated to the latest version 7:
+
+<% for (let command of failedProjects) { %>
+- `<%= command %>`
+<% } %>
+
+You can run these commands again, manually, and follow the instructions in the
+output of these commands to migrate your Storybook configuration to the latest version 7.
+<% } %>
+
+Also, we may have missed something. Please make sure to check the logs of the Storybook CLI commands that were run, and look for 
+the `❌ Failed trying to evaluate` message or `❌ The migration failed to update` message. This will indicate if a command was 
+unsuccessful, and will help you run the migration again, manually.
+
+## Final adjustments
+
+After the Storybook automigration scripts have run, some additional adjustments were made to your
+workspace, to make sure that everything is working as expected. These adjustments are as follows:
+
+- The `vite-tsconfig-paths` plugin was removed from the Storybook configuration files since it's no longer needed.
+- The `viteConfigPath` option was added to the Storybook builder, where needed.
+- The import package for the `StorybookConfig` type was changed to be framework specific.
+- The `uiFramework` option was removed from your project's Storybook targets.
+- The `lit` package was added to your workspace, if you are using the 
+Web Components `@storybook/web-components` package. Please note that the `lit-html` package is 
+no longer needed by Storybook v7. So, if you are not using it anywhere else, you can safely remove it.
+
+## Next steps
+
+You can make sure everything is working as expected by trying
+to build or serve your Storybook as you normally would.
+
+```bash
+npx nx build-storybook project-name
+```
+
+```bash
+npx nx storybook project-name
+```
+
+Please read the [Storybook 7.0.0 release notes](https://storybook.js.org/blog/7-0-beta/) and the
+official [Storybook 7.0.0 migration guide](https://chromatic-ui.notion.site/Storybook-7-migration-guide-dbf41fa347304eb2a5e9c69b34503937)
+for more information.
+
+You can also read the docs for the [@nrwl/storybook:migrate-7 generator](https://nx.dev/packages/storybook/generators/migrate-7) and our [Storybook 7 setup guide](https://nx.dev/packages/storybook/documents/storybook-7-setup).

package/src/generators/migrate-7/helper-functions.d.ts

@@ -0,0 +1,69 @@
+import { Tree } from '@nx/devkit';
+export declare function onlyShowGuide(storybookProjects: {
+    [key: string]: {
+        configDir: string;
+        uiFramework: string;
+        viteConfigFilePath?: string;
+    };
+}): void;
+export declare function writeFile(file?: {
+    path?: string;
+    content?: string;
+}): void;
+export declare function removePathResolvesFromNextConfig(tree: Tree, mainJsTsPath: string): {
+    path: string;
+    content: string;
+} | undefined;
+export declare function removeViteTsConfigPathsPlugin(tree: Tree, mainJsTsPath: string): void;
+export declare function addViteConfigFilePathInFrameworkOptions(tree: Tree, mainJsTsPath: string, viteConfigPath: string): void;
+export declare function normalizeViteConfigFilePathWithTree(tree: Tree, projectRoot: string, configFile?: string): string;
+export declare function removeTypecastFromMainTs(tree: Tree, mainTsPath: string): {
+    path: string;
+    content: string;
+} | undefined;
+export declare function removeUiFrameworkFromProjectJson(tree: Tree): void;
+export declare function changeCoreCommonImportToFramework(tree: Tree, mainTsPath: string): void;
+export declare function getAllStorybookInfo(tree: Tree): {
+    [key: string]: {
+        configDir: string;
+        uiFramework: string;
+        viteConfigFilePath?: string;
+    };
+};
+export declare function prepareFiles(tree: Tree, allStorybookProjects: {
+    [key: string]: {
+        configDir: string;
+        uiFramework: string;
+        viteConfigFilePath?: string;
+    };
+}): void;
+export declare function handleMigrationResult(migrateResult: {
+    successfulProjects: {};
+    failedProjects: {};
+}, allStorybookProjects: {
+    [key: string]: {
+        configDir: string;
+        uiFramework: string;
+        viteConfigFilePath?: string;
+    };
+}): {
+    successfulProjects: {};
+    failedProjects: {};
+};
+export declare function checkStorybookInstalled(packageJson: any): boolean;
+export declare function checkWebComponentsInstalled(packageJson: any): boolean;
+export declare function afterMigration(tree: Tree, allStorybookProjects: {
+    [key: string]: {
+        configDir: string;
+        uiFramework: string;
+        viteConfigFilePath?: string;
+    };
+}): void;
+export declare function logResult(tree: Tree, migrationSummary: {
+    successfulProjects: {
+        [key: string]: string;
+    };
+    failedProjects: {
+        [key: string]: string;
+    };
+}): void;