nx 20.8.4 → 22.7.7

package/dist/src/utils/analytics-prompt.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureAnalyticsPreferenceSet = ensureAnalyticsPreferenceSet;
+exports.promptForAnalyticsPreference = promptForAnalyticsPreference;
+exports.generateWorkspaceId = generateWorkspaceId;
+const crypto_1 = require("crypto");
+const child_process_1 = require("child_process");
+const fs_1 = require("fs");
+const enquirer_1 = require("enquirer");
+const path_1 = require("path");
+const output_1 = require("./output");
+const is_ci_1 = require("./is-ci");
+const nx_json_1 = require("../config/nx-json");
+const fileutils_1 = require("./fileutils");
+const write_formatted_json_file_1 = require("./write-formatted-json-file");
+const workspace_root_1 = require("./workspace-root");
+/**
+ * Prompts user for analytics preference if not already set in nx.json.
+ * Only prompts in interactive terminals, not in CI.
+ */
+async function ensureAnalyticsPreferenceSet() {
+    if ((0, is_ci_1.isCI)()) {
+        return;
+    }
+    // Only prompt in interactive terminals
+    const isInteractive = process.stdin.isTTY && process.stdout.isTTY;
+    if (!isInteractive) {
+        return;
+    }
+    // Only prompt inside a workspace that has nx.json — avoid creating
+    // nx.json in arbitrary directories (e.g. when running cloud commands
+    // outside a workspace).
+    const nxJsonPath = (0, path_1.join)(workspace_root_1.workspaceRoot, 'nx.json');
+    if (!(0, fs_1.existsSync)(nxJsonPath)) {
+        return;
+    }
+    const nxJson = (0, nx_json_1.readNxJson)(workspace_root_1.workspaceRoot);
+    // Check if already set (true = enabled, false = disabled)
+    if (typeof nxJson?.analytics === 'boolean') {
+        return;
+    }
+    const analyticsEnabled = await promptForAnalyticsPreference();
+    await saveAnalyticsPreference(analyticsEnabled);
+}
+async function promptForAnalyticsPreference() {
+    try {
+        output_1.output.log({
+            title: 'Help improve Nx by sharing usage data',
+            bodyLines: [
+                'Nx collects usage analytics to help improve the developer experience.',
+                'No project-specific information is collected.',
+                'Learn more: https://cloud.nx.app/privacy',
+            ],
+        });
+        const { enableAnalytics } = await (0, enquirer_1.prompt)({
+            type: 'confirm',
+            name: 'enableAnalytics',
+            message: 'Share usage data with the Nx team?',
+            initial: true,
+        });
+        return enableAnalytics;
+    }
+    catch {
+        // User cancelled - default to false
+        return false;
+    }
+}
+async function saveAnalyticsPreference(enabled) {
+    try {
+        const nxJsonPath = (0, path_1.join)(workspace_root_1.workspaceRoot, 'nx.json');
+        const nxJson = (0, fileutils_1.readJsonFile)(nxJsonPath);
+        nxJson.analytics = enabled;
+        await (0, write_formatted_json_file_1.writeFormattedJsonFile)(nxJsonPath, nxJson);
+        if (enabled) {
+            output_1.output.success({ title: 'Thank you for helping improve Nx!' });
+        }
+        else {
+            output_1.output.log({
+                title: 'Analytics disabled.',
+                bodyLines: [
+                    'You can change this anytime by setting "analytics" in nx.json.',
+                ],
+            });
+        }
+    }
+    catch {
+        // Silently fail - don't block user's command
+    }
+}
+/**
+ * Generates a deterministic workspace ID.
+ * Priority: nxCloudId > git remote URL (hashed).
+ * Returns null if neither is available (no telemetry).
+ */
+function generateWorkspaceId(cwd) {
+    const root = cwd ?? workspace_root_1.workspaceRoot;
+    // Use nxCloudId if available — most stable identifier
+    const nxJson = (0, nx_json_1.readNxJson)(root);
+    const nxCloudId = nxJson?.nxCloudId ?? nxJson?.nxCloudAccessToken;
+    if (nxCloudId) {
+        return nxCloudId;
+    }
+    // Fall back to git remote URL hash
+    try {
+        const remoteUrl = (0, child_process_1.execSync)('git remote get-url origin', {
+            stdio: 'pipe',
+            cwd: root,
+            windowsHide: true,
+        })
+            .toString()
+            .trim();
+        if (remoteUrl) {
+            return (0, crypto_1.createHash)('sha256').update(remoteUrl).digest('hex').slice(0, 32);
+        }
+    }
+    catch {
+        // No git remote available
+    }
+    // Fall back to first commit SHA — already a hash
+    try {
+        const firstCommit = (0, child_process_1.execSync)('git rev-list --max-parents=0 HEAD', {
+            stdio: 'pipe',
+            cwd: root,
+            windowsHide: true,
+        })
+            .toString()
+            .trim()
+            .split('\n')[0];
+        if (firstCommit) {
+            return firstCommit;
+        }
+    }
+    catch {
+        // Not a git repo
+    }
+    return null;
+}

package/dist/src/utils/assert-workspace-validity.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertWorkspaceValidity = assertWorkspaceValidity;
+const find_matching_projects_1 = require("./find-matching-projects");
+const output_1 = require("./output");
+const devkit_internals_1 = require("../devkit-internals");
+function assertWorkspaceValidity(projects, nxJson) {
+    const projectNames = Object.keys(projects);
+    const projectGraphNodes = projectNames.reduce((graph, project) => {
+        const projectConfiguration = projects[project];
+        graph[project] = {
+            name: project,
+            type: projectConfiguration.projectType === 'library' ? 'lib' : 'app', // missing fallback to `e2e`
+            data: {
+                ...projectConfiguration,
+            },
+        };
+        return graph;
+    }, {});
+    const invalidImplicitDependencies = new Map();
+    if (nxJson.implicitDependencies) {
+        output_1.output.warn({
+            title: 'Using `implicitDependencies` for global implicit dependencies configuration is no longer supported.',
+            bodyLines: [
+                'Use "namedInputs" instead. You can run "nx repair" to automatically migrate your configuration.',
+                'For more information about the usage of "namedInputs" see https://nx.dev/deprecated/global-implicit-dependencies#global-implicit-dependencies',
+            ],
+        });
+    }
+    const projectsWithNonArrayImplicitDependencies = new Map();
+    projectNames.reduce((map, projectName) => {
+        const project = projects[projectName];
+        if (!!project.implicitDependencies &&
+            !Array.isArray(project.implicitDependencies)) {
+            projectsWithNonArrayImplicitDependencies.set(projectName, project.implicitDependencies);
+            return map;
+        }
+        if (!project.implicitDependencies) {
+            return map;
+        }
+        detectAndSetInvalidProjectGlobValues(map, projectName, project.implicitDependencies, projects, projectGraphNodes);
+        return map;
+    }, invalidImplicitDependencies);
+    if (projectsWithNonArrayImplicitDependencies.size === 0 &&
+        invalidImplicitDependencies.size === 0) {
+        // No issues
+        return;
+    }
+    let message = '';
+    if (projectsWithNonArrayImplicitDependencies.size > 0) {
+        message += `The following implicitDependencies should be an array of strings:\n`;
+        projectsWithNonArrayImplicitDependencies.forEach((implicitDependencies, projectName) => {
+            message += `  ${projectName}.implicitDependencies: "${implicitDependencies}"\n`;
+        });
+        message += '\n';
+    }
+    if (invalidImplicitDependencies.size > 0) {
+        message += `The following implicitDependencies point to non-existent project(s):\n`;
+        message += [...invalidImplicitDependencies.keys()]
+            .map((key) => {
+            const projectNames = invalidImplicitDependencies.get(key);
+            return `  ${key}\n${projectNames
+                .map((projectName) => `    ${projectName}`)
+                .join('\n')}`;
+        })
+            .join('\n\n');
+    }
+    throw new devkit_internals_1.WorkspaceValidityError(message);
+}
+function detectAndSetInvalidProjectGlobValues(map, sourceName, desiredImplicitDeps, projectConfigurations, projects) {
+    const invalidProjectsOrGlobs = desiredImplicitDeps.filter((implicit) => {
+        const projectName = implicit.startsWith('!')
+            ? implicit.substring(1)
+            : implicit;
+        // Do not error on cross-workspace implicit dependency references
+        if (projectName.startsWith('nx-cloud:')) {
+            return false;
+        }
+        return !(projectConfigurations[projectName] ||
+            (0, find_matching_projects_1.findMatchingProjects)([implicit], projects).length);
+    });
+    if (invalidProjectsOrGlobs.length > 0) {
+        map.set(sourceName, invalidProjectsOrGlobs);
+    }
+}

package/dist/src/utils/binary-extensions.d.ts

@@ -0,0 +1 @@
+export declare function isBinaryPath(path: string): boolean;

package/dist/src/utils/binary-extensions.js

@@ -0,0 +1,279 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isBinaryPath = isBinaryPath;
+const path_1 = require("path");
+const binaryExtensions = new Set([
+    // types originally from https://github.com/sindresorhus/binary-extensions/blob/40e44b510d87a63dcf42300bc8fbcb105f45a61c/binary-extensions.json
+    '.3dm',
+    '.3ds',
+    '.3g2',
+    '.3gp',
+    '.7z',
+    '.a',
+    '.aac',
+    '.adp',
+    '.ai',
+    '.aif',
+    '.aiff',
+    '.als',
+    '.alz',
+    '.ape',
+    '.apk',
+    '.appimage',
+    '.ar',
+    '.arj',
+    '.asf',
+    '.au',
+    '.avi',
+    '.bak',
+    '.baml',
+    '.bh',
+    '.bin',
+    '.bk',
+    '.bmp',
+    '.btif',
+    '.bz2',
+    '.bzip2',
+    '.cab',
+    '.caf',
+    '.cgm',
+    '.class',
+    '.cmx',
+    '.cpio',
+    '.cr2',
+    '.cur',
+    '.dat',
+    '.dcm',
+    '.deb',
+    '.dex',
+    '.djvu',
+    '.dll',
+    '.dmg',
+    '.dng',
+    '.doc',
+    '.docm',
+    '.docx',
+    '.dot',
+    '.dotm',
+    '.dra',
+    '.DS_Store',
+    '.dsk',
+    '.dts',
+    '.dtshd',
+    '.dvb',
+    '.dwg',
+    '.dxf',
+    '.ecelp4800',
+    '.ecelp7470',
+    '.ecelp9600',
+    '.egg',
+    '.eol',
+    '.eot',
+    '.epub',
+    '.exe',
+    '.f4v',
+    '.fbs',
+    '.fh',
+    '.fla',
+    '.flac',
+    '.flatpak',
+    '.fli',
+    '.flv',
+    '.fpx',
+    '.fst',
+    '.fvt',
+    '.g3',
+    '.gh',
+    '.gif',
+    '.glb',
+    '.graffle',
+    '.gz',
+    '.gzip',
+    '.h261',
+    '.h263',
+    '.h264',
+    '.icns',
+    '.ico',
+    '.ief',
+    '.img',
+    '.ipa',
+    '.iso',
+    '.jar',
+    '.jpeg',
+    '.jpg',
+    '.jpgv',
+    '.jpm',
+    '.jxr',
+    '.key',
+    '.keystore',
+    '.ktx',
+    '.lha',
+    '.lib',
+    '.lvp',
+    '.lz',
+    '.lzh',
+    '.lzma',
+    '.lzo',
+    '.m3u',
+    '.m4a',
+    '.m4v',
+    '.mar',
+    '.mdi',
+    '.mht',
+    '.mid',
+    '.midi',
+    '.mj2',
+    '.mka',
+    '.mkv',
+    '.mmr',
+    '.mng',
+    '.mobi',
+    '.mov',
+    '.movie',
+    '.mp3',
+    '.mp4',
+    '.mp4a',
+    '.mpeg',
+    '.mpg',
+    '.mpga',
+    '.msi',
+    '.mxu',
+    '.nef',
+    '.npx',
+    '.npy',
+    '.numbers',
+    '.nupkg',
+    '.o',
+    '.odp',
+    '.ods',
+    '.odt',
+    '.oga',
+    '.ogg',
+    '.ogv',
+    '.otf',
+    '.ott',
+    '.pages',
+    '.pbm',
+    '.pbf',
+    '.pcx',
+    '.pdb',
+    '.pdf',
+    '.pea',
+    '.pgm',
+    '.pic',
+    '.pkg',
+    '.plist',
+    '.png',
+    '.pnm',
+    '.pot',
+    '.potm',
+    '.potx',
+    '.ppa',
+    '.ppam',
+    '.ppm',
+    '.pps',
+    '.ppsm',
+    '.ppsx',
+    '.ppt',
+    '.pptm',
+    '.pptx',
+    '.psd',
+    '.pxd',
+    '.pxz',
+    '.pya',
+    '.pyc',
+    '.pyo',
+    '.pyv',
+    '.qt',
+    '.rar',
+    '.ras',
+    '.raw',
+    '.resources',
+    '.rgb',
+    '.rip',
+    '.riv',
+    '.rlc',
+    '.rmf',
+    '.rmvb',
+    '.rpm',
+    '.rtf',
+    '.rz',
+    '.s3m',
+    '.s7z',
+    '.scpt',
+    '.sgi',
+    '.shar',
+    '.snap',
+    '.sil',
+    '.sketch',
+    '.slk',
+    '.smv',
+    '.snk',
+    '.so',
+    '.stl',
+    '.suo',
+    '.sub',
+    '.swf',
+    '.tar',
+    '.tbz',
+    '.tbz2',
+    '.tga',
+    '.tgz',
+    '.thmx',
+    '.tif',
+    '.tiff',
+    '.tlz',
+    '.ttc',
+    '.ttf',
+    '.txz',
+    '.udf',
+    '.uvh',
+    '.uvi',
+    '.uvm',
+    '.uvp',
+    '.uvs',
+    '.uvu',
+    '.viv',
+    '.vob',
+    '.war',
+    '.wav',
+    '.wax',
+    '.wbmp',
+    '.wdp',
+    '.weba',
+    '.webm',
+    '.webp',
+    '.whl',
+    '.wim',
+    '.wm',
+    '.wma',
+    '.wmv',
+    '.wmx',
+    '.woff',
+    '.woff2',
+    '.wrm',
+    '.wvx',
+    '.xbm',
+    '.xif',
+    '.xla',
+    '.xlam',
+    '.xls',
+    '.xlsb',
+    '.xlsm',
+    '.xlsx',
+    '.xlt',
+    '.xltm',
+    '.xltx',
+    '.xm',
+    '.xmind',
+    '.xpi',
+    '.xpm',
+    '.xwd',
+    '.xz',
+    '.z',
+    '.zip',
+    '.zipx',
+]);
+function isBinaryPath(path) {
+    return binaryExtensions.has((0, path_1.extname)(path).toLowerCase());
+}

package/dist/src/utils/cache-directory.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Path to the directory where Nx stores its cache and daemon-related files.
+ * In a git worktree this resolves to the main repo's cache dir so all
+ * worktrees share the same cache.
+ */
+export declare const cacheDir: string;
+export declare function cacheDirectoryForWorkspace(root: string): string;
+export declare const workspaceDataDirectory: string;
+export declare function workspaceDataDirectoryForWorkspace(workspaceRoot: string): string;

package/dist/src/utils/cache-directory.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.workspaceDataDirectory = exports.cacheDir = void 0;
+exports.cacheDirectoryForWorkspace = cacheDirectoryForWorkspace;
+exports.workspaceDataDirectoryForWorkspace = workspaceDataDirectoryForWorkspace;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const native_1 = require("../native");
+const fileutils_1 = require("./fileutils");
+const workspace_root_1 = require("./workspace-root");
+function readCacheDirectoryProperty(root) {
+    try {
+        const nxJson = (0, fileutils_1.readJsonFile)((0, path_1.join)(root, 'nx.json'));
+        return (nxJson.cacheDirectory ??
+            nxJson.tasksRunnerOptions?.default.options.cacheDirectory);
+    }
+    catch {
+        return undefined;
+    }
+}
+function absolutePath(root, path) {
+    if ((0, path_1.isAbsolute)(path)) {
+        return path;
+    }
+    else {
+        return (0, path_1.join)(root, path);
+    }
+}
+function cacheDirectory(root, cacheDirectory) {
+    const cacheDirFromEnv = process.env.NX_CACHE_DIRECTORY;
+    if (cacheDirFromEnv) {
+        cacheDirectory = cacheDirFromEnv;
+    }
+    if (cacheDirectory) {
+        return absolutePath(root, cacheDirectory);
+    }
+    else {
+        return defaultCacheDirectory(root);
+    }
+}
+function pickCacheDirectory(root, nonNxCacheDirectory, nxCacheDirectory) {
+    // If nx.json doesn't exist the repo can't utilize
+    // caching, so .nx/cache is less relevant. Lerna users
+    // that don't want to fully opt in to Nx at this time
+    // may also be caught off guard by the appearance of
+    // a .nx directory, so we are going to special case
+    // this for the time being.
+    if ((0, fs_1.existsSync)((0, path_1.join)(root, 'lerna.json')) &&
+        !(0, fs_1.existsSync)((0, path_1.join)(root, 'nx.json'))) {
+        return (0, path_1.join)(root, 'node_modules', '.cache', nonNxCacheDirectory);
+    }
+    return (0, path_1.join)(root, '.nx', nxCacheDirectory);
+}
+function defaultCacheDirectory(root) {
+    return pickCacheDirectory(root, 'nx', 'cache');
+}
+function defaultWorkspaceDataDirectory(root) {
+    return pickCacheDirectory(root, 'nx-workspace-data', 'workspace-data');
+}
+/**
+ * Path to the directory where Nx stores its cache and daemon-related files.
+ * In a git worktree this resolves to the main repo's cache dir so all
+ * worktrees share the same cache.
+ */
+exports.cacheDir = sharedCacheDirectory(workspace_root_1.workspaceRoot);
+function cacheDirectoryForWorkspace(root) {
+    return cacheDirectory(root, readCacheDirectoryProperty(root));
+}
+function sharedCacheDirectory(root) {
+    try {
+        const mainRoot = (0, native_1.getMainWorktreeRoot)(root);
+        if (mainRoot) {
+            return cacheDirectoryForWorkspace(mainRoot);
+        }
+    }
+    catch {
+        // Fall back to local cache if worktree detection fails
+    }
+    return cacheDirectoryForWorkspace(root);
+}
+exports.workspaceDataDirectory = workspaceDataDirectoryForWorkspace(workspace_root_1.workspaceRoot);
+function workspaceDataDirectoryForWorkspace(workspaceRoot) {
+    return absolutePath(workspaceRoot, process.env.NX_WORKSPACE_DATA_DIRECTORY ??
+        process.env.NX_PROJECT_GRAPH_CACHE_DIRECTORY ??
+        defaultWorkspaceDataDirectory(workspaceRoot));
+}

package/dist/src/utils/call-sites.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Returns an array of CallSite objects representing the current call stack.
+ *
+ * NOTE: The returned CallSite[] does not include the frame for getCallSites itself,
+ * but will include the function that called getCallSites. If you are checking for
+ * things like recursion, you need to make sure to account for that.
+ *
+ * The behavior should match node:util.getCallSites, introduced in Node.js v22.0.0.
+ *
+ * @todo(@AgentEnder) Move this to node:util when we remove support for Node.js versions < 22, around Nx 24
+ *
+ * @returns {NodeJS.CallSite[]} An array of CallSite objects.
+ */
+export declare function getCallSites(): NodeJS.CallSite[];

package/dist/src/utils/call-sites.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCallSites = getCallSites;
+/**
+ * Returns an array of CallSite objects representing the current call stack.
+ *
+ * NOTE: The returned CallSite[] does not include the frame for getCallSites itself,
+ * but will include the function that called getCallSites. If you are checking for
+ * things like recursion, you need to make sure to account for that.
+ *
+ * The behavior should match node:util.getCallSites, introduced in Node.js v22.0.0.
+ *
+ * @todo(@AgentEnder) Move this to node:util when we remove support for Node.js versions < 22, around Nx 24
+ *
+ * @returns {NodeJS.CallSite[]} An array of CallSite objects.
+ */
+function getCallSites() {
+    const prepareStackTraceBackup = Error.prepareStackTrace;
+    Error.prepareStackTrace = (_, stackTraces) => {
+        return stackTraces;
+    };
+    const errorObject = {};
+    Error.captureStackTrace(errorObject);
+    const trace = errorObject.stack;
+    Error.prepareStackTrace = prepareStackTraceBackup;
+    trace.shift(); // remove getCallSites
+    return trace; // return stack up to what called getCallSites
+}

package/dist/src/utils/catalog/index.d.ts

@@ -0,0 +1,9 @@
+import type { Tree } from '../../generators/tree';
+import type { CatalogManager } from './manager';
+import { getCatalogManager } from './manager-factory';
+export { type CatalogManager, getCatalogManager };
+/**
+ * Detects which packages in a package.json use catalog references
+ * Returns Map of package name -> catalog name (undefined for default catalog)
+ */
+export declare function getCatalogDependenciesFromPackageJson(tree: Tree, packageJsonPath: string, manager: CatalogManager): Map<string, string | undefined>;

package/dist/src/utils/catalog/index.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCatalogManager = void 0;
+exports.getCatalogDependenciesFromPackageJson = getCatalogDependenciesFromPackageJson;
+const json_1 = require("../../generators/utils/json");
+const manager_factory_1 = require("./manager-factory");
+Object.defineProperty(exports, "getCatalogManager", { enumerable: true, get: function () { return manager_factory_1.getCatalogManager; } });
+/**
+ * Detects which packages in a package.json use catalog references
+ * Returns Map of package name -> catalog name (undefined for default catalog)
+ */
+function getCatalogDependenciesFromPackageJson(tree, packageJsonPath, manager) {
+    const catalogDeps = new Map();
+    if (!tree.exists(packageJsonPath)) {
+        return catalogDeps;
+    }
+    try {
+        const packageJson = (0, json_1.readJson)(tree, packageJsonPath);
+        const allDependencies = {
+            ...packageJson.dependencies,
+            ...packageJson.devDependencies,
+            ...packageJson.peerDependencies,
+            ...packageJson.optionalDependencies,
+        };
+        for (const [packageName, version] of Object.entries(allDependencies || {})) {
+            if (manager.isCatalogReference(version)) {
+                const catalogRef = manager.parseCatalogReference(version);
+                if (catalogRef) {
+                    catalogDeps.set(packageName, catalogRef.catalogName);
+                }
+            }
+        }
+    }
+    catch (error) {
+        // If we can't read the package.json, return empty map
+    }
+    return catalogDeps;
+}