@nx/storybook 20.2.2 → 20.3.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/storybook",
-  "version": "20.2.2",
+  "version": "20.3.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,13 +33,13 @@
     "migrations": "./migrations.json"
   },
   "dependencies": {
-    "@nx/devkit": "20.2.2",
+    "@nx/devkit": "20.3.0-beta.0",
     "@phenomnomnominal/tsquery": "~5.0.1",
     "semver": "^7.5.3",
     "tslib": "^2.3.0",
-    "@nx/cypress": "20.2.2",
-    "@nx/js": "20.2.2",
-    "@nx/eslint": "20.2.2"
+    "@nx/cypress": "20.3.0-beta.0",
+    "@nx/js": "20.3.0-beta.0",
+    "@nx/eslint": "20.3.0-beta.0"
   },
   "publishConfig": {
     "access": "public"

package/plugin.d.ts

@@ -1 +1 @@
-export { createNodes, StorybookPluginOptions, createDependencies, } from './src/plugins/plugin';
+export { createNodes, createNodesV2, StorybookPluginOptions, createDependencies, } from './src/plugins/plugin';

package/plugin.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDependencies = exports.createNodes = void 0;
+exports.createDependencies = exports.createNodesV2 = exports.createNodes = void 0;
 var plugin_1 = require("./src/plugins/plugin");
 Object.defineProperty(exports, "createNodes", { enumerable: true, get: function () { return plugin_1.createNodes; } });
+Object.defineProperty(exports, "createNodesV2", { enumerable: true, get: function () { return plugin_1.createNodesV2; } });
 Object.defineProperty(exports, "createDependencies", { enumerable: true, get: function () { return plugin_1.createDependencies; } });

package/src/generators/convert-to-inferred/convert-to-inferred.js

@@ -11,7 +11,7 @@ const versions_1 = require("../../utils/versions");
 async function convertToInferred(tree, options) {
     const projectGraph = await (0, devkit_1.createProjectGraphAsync)();
     const migrationLogs = new aggregate_log_util_1.AggregatedLog();
-    const migratedProjects = await (0, executor_to_plugin_migrator_1.migrateProjectExecutorsToPluginV1)(tree, projectGraph, '@nx/storybook/plugin', plugin_1.createNodes, {
+    const migratedProjects = await (0, executor_to_plugin_migrator_1.migrateProjectExecutorsToPlugin)(tree, projectGraph, '@nx/storybook/plugin', plugin_1.createNodesV2, {
         buildStorybookTargetName: 'build-storybook',
         serveStorybookTargetName: 'storybook',
         staticStorybookTargetName: 'static-storybook',

package/src/generators/init/init.js

@@ -58,7 +58,7 @@ async function initGeneratorInternal(tree, schema) {
         nxJson.useInferencePlugins !== false;
     schema.addPlugin ??= addPluginDefault;
     if (schema.addPlugin) {
-        await (0, add_plugin_1.addPluginV1)(tree, await (0, devkit_1.createProjectGraphAsync)(), '@nx/storybook/plugin', plugin_1.createNodes, {
+        await (0, add_plugin_1.addPlugin)(tree, await (0, devkit_1.createProjectGraphAsync)(), '@nx/storybook/plugin', plugin_1.createNodesV2, {
             serveStorybookTargetName: [
                 'storybook',
                 'serve:storybook',

package/src/plugins/plugin.d.ts

@@ -1,9 +1,13 @@
-import { CreateDependencies, CreateNodes } from '@nx/devkit';
+import { CreateDependencies, CreateNodes, CreateNodesV2 } from '@nx/devkit';
 export interface StorybookPluginOptions {
     buildStorybookTargetName?: string;
     serveStorybookTargetName?: string;
     staticStorybookTargetName?: string;
     testStorybookTargetName?: string;
 }
+/**
+ * @deprecated The 'createDependencies' function is now a no-op. This functionality is included in 'createNodesV2'.
+ */
 export declare const createDependencies: CreateDependencies;
+export declare const createNodesV2: CreateNodesV2<StorybookPluginOptions>;
 export declare const createNodes: CreateNodes<StorybookPluginOptions>;

package/src/plugins/plugin.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createNodes = exports.createDependencies = void 0;
+exports.createNodes = exports.createNodesV2 = exports.createDependencies = void 0;
 const devkit_1 = require("@nx/devkit");
 const path_1 = require("path");
 const get_named_inputs_1 = require("@nx/devkit/src/utils/get-named-inputs");
@@ -9,57 +9,73 @@ const calculate_hash_for_create_nodes_1 = require("@nx/devkit/src/utils/calculat
 const cache_directory_1 = require("nx/src/utils/cache-directory");
 const js_1 = require("@nx/js");
 const config_utils_1 = require("@nx/devkit/src/utils/config-utils");
-const cachePath = (0, path_1.join)(cache_directory_1.workspaceDataDirectory, 'storybook.hash');
-const targetsCache = readTargetsCache();
-function readTargetsCache() {
+const file_hasher_1 = require("nx/src/hasher/file-hasher");
+function readTargetsCache(cachePath) {
     return (0, fs_1.existsSync)(cachePath) ? (0, devkit_1.readJsonFile)(cachePath) : {};
 }
-function writeTargetsToCache() {
-    const oldCache = readTargetsCache();
-    (0, devkit_1.writeJsonFile)(cachePath, {
-        ...oldCache,
-        ...targetsCache,
-    });
+function writeTargetsToCache(cachePath, results) {
+    (0, devkit_1.writeJsonFile)(cachePath, results);
 }
+/**
+ * @deprecated The 'createDependencies' function is now a no-op. This functionality is included in 'createNodesV2'.
+ */
 const createDependencies = () => {
-    writeTargetsToCache();
     return [];
 };
 exports.createDependencies = createDependencies;
-exports.createNodes = [
-    '**/.storybook/main.{js,ts,mjs,mts,cjs,cts}',
-    async (configFilePath, options, context) => {
-        let projectRoot = '';
-        if (configFilePath.includes('/.storybook')) {
-            projectRoot = (0, path_1.dirname)(configFilePath).replace('/.storybook', '');
-        }
-        else {
-            projectRoot = (0, path_1.dirname)(configFilePath).replace('.storybook', '');
-        }
-        if (projectRoot === '') {
-            projectRoot = '.';
+const storybookConfigGlob = '**/.storybook/main.{js,ts,mjs,mts,cjs,cts}';
+exports.createNodesV2 = [
+    storybookConfigGlob,
+    async (configFilePaths, options, context) => {
+        const normalizedOptions = normalizeOptions(options);
+        const optionsHash = (0, file_hasher_1.hashObject)(normalizedOptions);
+        const cachePath = (0, path_1.join)(cache_directory_1.workspaceDataDirectory, `storybook-${optionsHash}.hash`);
+        const targetsCache = readTargetsCache(cachePath);
+        try {
+            return await (0, devkit_1.createNodesFromFiles)((configFile, _, context) => createNodesInternal(configFile, normalizedOptions, context, targetsCache), configFilePaths, normalizedOptions, context);
         }
-        // Do not create a project if package.json and project.json isn't there.
-        const siblingFiles = (0, fs_1.readdirSync)((0, path_1.join)(context.workspaceRoot, projectRoot));
-        if (!siblingFiles.includes('package.json') &&
-            !siblingFiles.includes('project.json')) {
-            return {};
+        finally {
+            writeTargetsToCache(cachePath, targetsCache);
         }
-        options = normalizeOptions(options);
-        const hash = await (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, options, context, [(0, js_1.getLockFileName)((0, devkit_1.detectPackageManager)(context.workspaceRoot))]);
-        const projectName = buildProjectName(projectRoot, context.workspaceRoot);
-        targetsCache[hash] ??= await buildStorybookTargets(configFilePath, projectRoot, options, context, projectName);
-        const result = {
-            projects: {
-                [projectRoot]: {
-                    root: projectRoot,
-                    targets: targetsCache[hash],
-                },
-            },
-        };
-        return result;
     },
 ];
+exports.createNodes = [
+    storybookConfigGlob,
+    (configFilePath, options, context) => {
+        devkit_1.logger.warn('`createNodes` is deprecated. Update your plugin to utilize createNodesV2 instead. In Nx 20, this will change to the createNodesV2 API.');
+        return createNodesInternal(configFilePath, normalizeOptions(options), context, {});
+    },
+];
+async function createNodesInternal(configFilePath, options, context, targetsCache) {
+    let projectRoot = '';
+    if (configFilePath.includes('/.storybook')) {
+        projectRoot = (0, path_1.dirname)(configFilePath).replace('/.storybook', '');
+    }
+    else {
+        projectRoot = (0, path_1.dirname)(configFilePath).replace('.storybook', '');
+    }
+    if (projectRoot === '') {
+        projectRoot = '.';
+    }
+    // Do not create a project if package.json and project.json isn't there.
+    const siblingFiles = (0, fs_1.readdirSync)((0, path_1.join)(context.workspaceRoot, projectRoot));
+    if (!siblingFiles.includes('package.json') &&
+        !siblingFiles.includes('project.json')) {
+        return {};
+    }
+    const hash = await (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, options, context, [(0, js_1.getLockFileName)((0, devkit_1.detectPackageManager)(context.workspaceRoot))]);
+    const projectName = buildProjectName(projectRoot, context.workspaceRoot);
+    targetsCache[hash] ??= await buildStorybookTargets(configFilePath, projectRoot, options, context, projectName);
+    const result = {
+        projects: {
+            [projectRoot]: {
+                root: projectRoot,
+                targets: targetsCache[hash],
+            },
+        },
+    };
+    return result;
+}
 async function buildStorybookTargets(configFilePath, projectRoot, options, context, projectName) {
     const buildOutputs = getOutputs();
     const namedInputs = (0, get_named_inputs_1.getNamedInputs)(projectRoot, context);
@@ -184,12 +200,12 @@ function getOutputs() {
     return outputs;
 }
 function normalizeOptions(options) {
-    options ??= {};
-    options.buildStorybookTargetName ??= 'build-storybook';
-    options.serveStorybookTargetName ??= 'storybook';
-    options.testStorybookTargetName ??= 'test-storybook';
-    options.staticStorybookTargetName ??= 'static-storybook';
-    return options;
+    return {
+        buildStorybookTargetName: options.buildStorybookTargetName ?? 'build-storybook',
+        serveStorybookTargetName: options.serveStorybookTargetName ?? 'storybook',
+        testStorybookTargetName: options.testStorybookTargetName ?? 'test-storybook',
+        staticStorybookTargetName: options.staticStorybookTargetName ?? 'static-storybook',
+    };
 }
 function buildProjectName(projectRoot, workspaceRoot) {
     const packageJsonPath = (0, path_1.join)(workspaceRoot, projectRoot, 'package.json');