@nx/storybook 17.1.1 → 17.2.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/storybook",
-  "version": "17.1.1",
+  "version": "17.2.0-beta.0",
   "private": false,
   "description": "The Nx Plugin for Storybook contains executors and generators for allowing your workspace to use the powerful Storybook integration testing & documenting capabilities.",
   "repository": {
@@ -33,11 +33,11 @@
     "@phenomnomnominal/tsquery": "~5.0.1",
     "semver": "7.5.3",
     "tslib": "^2.3.0",
-    "@nx/cypress": "17.1.1",
-    "@nx/devkit": "17.1.1",
-    "@nx/js": "17.1.1",
-    "@nx/eslint": "17.1.1",
-    "@nrwl/storybook": "17.1.1"
+    "@nx/cypress": "17.2.0-beta.0",
+    "@nx/devkit": "17.2.0-beta.0",
+    "@nx/js": "17.2.0-beta.0",
+    "@nx/eslint": "17.2.0-beta.0",
+    "@nrwl/storybook": "17.2.0-beta.0"
   },
   "publishConfig": {
     "access": "public"

package/presets/cypress.d.ts

@@ -1,20 +1 @@
-export declare function nxE2EStorybookPreset(filePath: string): {
-    baseUrl: string;
-    fileServerFolder: string;
-    supportFile: string;
-    specPattern: string;
-    fixturesFolder: string;
-    videosFolder: string;
-    screenshotsFolder: string;
-    chromeWebSecurity: boolean;
-} | {
-    baseUrl: string;
-    setupNodeEvents(on: any): void;
-    fileServerFolder: string;
-    supportFile: string;
-    specPattern: string;
-    fixturesFolder: string;
-    videosFolder: string;
-    screenshotsFolder: string;
-    chromeWebSecurity: boolean;
-};
+export declare function nxE2EStorybookPreset(filePath: string): any;

package/src/generators/configuration/configuration.js

@@ -15,7 +15,7 @@ async function configurationGenerator(tree, rawSchema) {
     }
     const schema = normalizeSchema(rawSchema);
     const tasks = [];
-    const { projectType, targets, root } = (0, devkit_1.readProjectConfiguration)(tree, schema.name);
+    const { projectType, targets, root } = (0, devkit_1.readProjectConfiguration)(tree, schema.project);
     const { nextBuildTarget, compiler, viteBuildTarget } = (0, utilities_1.findStorybookAndBuildTargetsAndCompiler)(targets);
     let viteConfigFilePath;
     if (viteBuildTarget) {
@@ -23,12 +23,12 @@ async function configurationGenerator(tree, rawSchema) {
     }
     if (viteBuildTarget) {
         if (schema.uiFramework === '@storybook/react-webpack5') {
-            devkit_1.logger.info(`Your project ${schema.name} uses Vite as a bundler.
+            devkit_1.logger.info(`Your project ${schema.project} uses Vite as a bundler.
         Nx will configure Storybook for this project to use Vite as well.`);
             schema.uiFramework = '@storybook/react-vite';
         }
         if (schema.uiFramework === '@storybook/web-components-webpack5') {
-            devkit_1.logger.info(`Your project ${schema.name} uses Vite as a bundler.
+            devkit_1.logger.info(`Your project ${schema.project} uses Vite as a bundler.
         Nx will configure Storybook for this project to use Vite as well.`);
             schema.uiFramework = '@storybook/web-components-vite';
         }
@@ -43,7 +43,7 @@ async function configurationGenerator(tree, rawSchema) {
     tasks.push(initTask);
     const mainDir = !!nextBuildTarget && projectType === 'application' ? 'components' : 'src';
     const usesVite = !!viteBuildTarget || schema.uiFramework.endsWith('-vite');
-    (0, util_functions_1.createProjectStorybookDir)(tree, schema.name, schema.uiFramework, schema.js, schema.tsConfiguration, root, projectType, (0, util_functions_1.projectIsRootProjectInStandaloneWorkspace)(root), schema.interactionTests, mainDir, !!nextBuildTarget, compiler === 'swc', usesVite, viteConfigFilePath);
+    (0, util_functions_1.createProjectStorybookDir)(tree, schema.project, schema.uiFramework, schema.js, schema.tsConfiguration, root, projectType, (0, util_functions_1.projectIsRootProjectInStandaloneWorkspace)(root), schema.interactionTests, mainDir, !!nextBuildTarget, compiler === 'swc', usesVite, viteConfigFilePath);
     if (schema.uiFramework !== '@storybook/angular') {
         (0, util_functions_1.createStorybookTsconfigFile)(tree, root, schema.uiFramework, (0, util_functions_1.projectIsRootProjectInStandaloneWorkspace)(root), mainDir);
     }
@@ -54,20 +54,20 @@ async function configurationGenerator(tree, rawSchema) {
     (0, util_functions_1.addBuildStorybookToCacheableOperations)(tree);
     (0, util_functions_1.addStorybookToNamedInputs)(tree);
     if (schema.uiFramework === '@storybook/angular') {
-        (0, util_functions_1.addAngularStorybookTask)(tree, schema.name, schema.interactionTests);
+        (0, util_functions_1.addAngularStorybookTask)(tree, schema.project, schema.interactionTests);
     }
     else {
-        (0, util_functions_1.addStorybookTask)(tree, schema.name, schema.uiFramework, schema.interactionTests);
+        (0, util_functions_1.addStorybookTask)(tree, schema.project, schema.uiFramework, schema.interactionTests);
     }
     if (schema.configureStaticServe) {
         (0, util_functions_1.addStaticTarget)(tree, schema);
     }
     // TODO(katerina): Nx 18 -> remove Cypress
     if (schema.configureCypress) {
-        const e2eProject = await (0, util_functions_1.getE2EProjectName)(tree, schema.name);
+        const e2eProject = await (0, util_functions_1.getE2EProjectName)(tree, schema.project);
         if (!e2eProject) {
             const cypressTask = await (0, cypress_project_1.cypressProjectGenerator)(tree, {
-                name: schema.name,
+                name: schema.project,
                 js: schema.js,
                 linter: schema.linter,
                 directory: schema.cypressDirectory,
@@ -80,7 +80,7 @@ async function configurationGenerator(tree, rawSchema) {
             tasks.push(cypressTask);
         }
         else {
-            devkit_1.logger.warn(`There is already an e2e project setup for ${schema.name}, called ${e2eProject}.`);
+            devkit_1.logger.warn(`There is already an e2e project setup for ${schema.project}, called ${e2eProject}.`);
         }
     }
     let devDeps = {};

package/src/generators/configuration/lib/util-functions.js

@@ -97,17 +97,17 @@ exports.addAngularStorybookTask = addAngularStorybookTask;
 function addStaticTarget(tree, opts) {
     const nrwlWeb = (0, devkit_1.ensurePackage)('@nx/web', versions_1.nxVersion);
     nrwlWeb.webStaticServeGenerator(tree, {
-        buildTarget: `${opts.name}:build-storybook`,
-        outputPath: (0, devkit_1.joinPathFragments)('dist/storybook', opts.name),
+        buildTarget: `${opts.project}:build-storybook`,
+        outputPath: (0, devkit_1.joinPathFragments)('dist/storybook', opts.project),
         targetName: 'static-storybook',
     });
-    const projectConfig = (0, devkit_1.readProjectConfiguration)(tree, opts.name);
+    const projectConfig = (0, devkit_1.readProjectConfiguration)(tree, opts.project);
     projectConfig.targets['static-storybook'].configurations = {
         ci: {
-            buildTarget: `${opts.name}:build-storybook:ci`,
+            buildTarget: `${opts.project}:build-storybook:ci`,
         },
     };
-    (0, devkit_1.updateProjectConfiguration)(tree, opts.name, projectConfig);
+    (0, devkit_1.updateProjectConfiguration)(tree, opts.project, projectConfig);
 }
 exports.addStaticTarget = addStaticTarget;
 function createStorybookTsconfigFile(tree, projectRoot, uiFramework, isRootProject, mainDir) {
@@ -186,7 +186,7 @@ function editTsconfigBaseJson(tree) {
 }
 exports.editTsconfigBaseJson = editTsconfigBaseJson;
 function configureTsProjectConfig(tree, schema) {
-    const { name: projectName } = schema;
+    const { project: projectName } = schema;
     let tsConfigPath;
     let tsConfigContent;
     try {
@@ -218,7 +218,7 @@ function configureTsProjectConfig(tree, schema) {
 }
 exports.configureTsProjectConfig = configureTsProjectConfig;
 function configureTsSolutionConfig(tree, schema) {
-    const { name: projectName } = schema;
+    const { project: projectName } = schema;
     const { root } = (0, devkit_1.readProjectConfiguration)(tree, projectName);
     const tsConfigPath = (0, path_1.join)(root, 'tsconfig.json');
     const tsConfigContent = (0, devkit_1.readJson)(tree, tsConfigPath);
@@ -257,7 +257,7 @@ exports.configureTsSolutionConfig = configureTsSolutionConfig;
  * This is done within the eslint config file.
  */
 function updateLintConfig(tree, schema) {
-    const { name: projectName } = schema;
+    const { project: projectName } = schema;
     const { root } = (0, devkit_1.readProjectConfiguration)(tree, projectName);
     const eslintFile = (0, eslint_file_1.findEslintFile)(tree, root);
     if (!eslintFile) {

package/src/generators/configuration/schema.d.ts

@@ -2,7 +2,7 @@ import { Linter } from '@nx/eslint';
 import { UiFramework } from '../../utils/models';
 
 export interface StorybookConfigureSchema {
-  name: string;
+  project: string;
   uiFramework?: UiFramework;
   linter?: Linter;
   js?: boolean;

package/src/generators/configuration/schema.json

@@ -6,9 +6,9 @@
   "description": "Add Storybook configuration to a UI library or an application.",
   "type": "object",
   "properties": {
-    "name": {
+    "project": {
       "type": "string",
-      "aliases": ["project", "projectName"],
+      "aliases": ["name", "projectName"],
       "description": "Project for which to generate Storybook configuration.",
       "$default": {
         "$source": "argv",
@@ -103,6 +103,6 @@
       "x-priority": "internal"
     }
   },
-  "required": ["name", "uiFramework"],
+  "required": ["project", "uiFramework"],
   "examplesFile": "../../../docs/configuration-generator-examples.md"
 }