@ohos-ports/nx 23.2.1-beta.0 → 23.3.0-beta.0

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

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureAnalyticsPreferenceSet = ensureAnalyticsPreferenceSet;
+exports.promptForAnalyticsPreference = promptForAnalyticsPreference;
+const fs_1 = require("fs");
+const prompt_helpers_1 = require("./prompt-helpers");
+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 for analytics preference if not already set in nx.json, persists the
+ * answer so later commands don't re-ask, and returns it for telemetry. Returns
+ * 'unset' when not prompted (CI / non-interactive / no nx.json). `nx init`
+ * passes its own root + interactive flag; the default call (bin/nx.ts) derives
+ * interactive from the TTY.
+ */
+async function ensureAnalyticsPreferenceSet(root = workspace_root_1.workspaceRoot, interactive = !!(process.stdin.isTTY && process.stdout.isTTY)) {
+    if (!interactive || (0, is_ci_1.isCI)()) {
+        return 'unset';
+    }
+    // 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).
+    if (!(0, fs_1.existsSync)((0, path_1.join)(root, 'nx.json'))) {
+        return 'unset';
+    }
+    const nxJson = (0, nx_json_1.readNxJson)(root);
+    // Already chosen (true = enabled, false = disabled) — report it.
+    if (typeof nxJson?.analytics === 'boolean') {
+        return nxJson.analytics ? 'yes' : 'no';
+    }
+    const enabled = await promptForAnalyticsPreference();
+    await saveAnalyticsPreference(root, enabled);
+    return enabled ? 'yes' : 'no';
+}
+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',
+            ],
+        });
+        return await (0, prompt_helpers_1.confirmationPrompt)({
+            message: 'Share usage data with the Nx team?',
+            // Cancelling is a decline, not a failure.
+            onCancel: () => false,
+        });
+    }
+    catch {
+        return false;
+    }
+}
+async function saveAnalyticsPreference(root, enabled) {
+    try {
+        const nxJsonPath = (0, path_1.join)(root, '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
+    }
+}

package/dist/src/utils/assert-workspace-validity.d.ts

@@ -0,0 +1,3 @@
+import { ProjectConfiguration } from '../config/workspace-json-project-json';
+import { NxJsonConfiguration } from '../config/nx-json';
+export declare function assertWorkspaceValidity(projects: Record<string, ProjectConfiguration>, nxJson: NxJsonConfiguration): void;

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

@@ -0,0 +1,90 @@
+"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");
+// Import from the defining module, not the devkit-internals barrel: this file
+// is on the project-graph construction path, and the barrel now eagerly
+// re-exports the project-graph modules, which would create a require cycle back
+// through build-project-graph. (Release modules cross the barrel as erased
+// types only — see the note in packages/devkit/internal.ts.)
+const error_types_1 = require("../project-graph/error-types");
+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 error_types_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/async-iterator.d.ts

@@ -0,0 +1,2 @@
+export declare function isAsyncIterator<T>(v: any): v is AsyncIterableIterator<T>;
+export declare function getLastValueFromAsyncIterableIterator<T>(i: AsyncIterable<T> | AsyncIterableIterator<T>): Promise<T>;

package/dist/src/utils/async-iterator.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAsyncIterator = isAsyncIterator;
+exports.getLastValueFromAsyncIterableIterator = getLastValueFromAsyncIterableIterator;
+function isAsyncIterator(v) {
+    return typeof v?.[Symbol.asyncIterator] === 'function';
+}
+async function getLastValueFromAsyncIterableIterator(i) {
+    let prev;
+    let current;
+    const generator = i[Symbol.asyncIterator] || i[Symbol.iterator];
+    const iterator = generator.call(i);
+    do {
+        prev = current;
+        current = await iterator.next();
+    } while (!current.done);
+    return current.value !== undefined || !prev ? current.value : prev.value;
+}

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,68 @@
+/**
+ * `readNxJson` rather than a raw read, so a `cacheDirectory` reached through
+ * `extends` counts. It throws on malformed JSON, which must not take the
+ * process down here: this runs at module scope, and a broken `nx.json` has a
+ * better error waiting for it further in.
+ */
+export declare function readCacheDirectoryProperty(root: string): string | undefined;
+/** The data a repository's checkouts share, each in its own directory. */
+export type SharedDataKind = 'cache' | 'workspace-data';
+/** The establish verdict is cached per process; tests need it cleared. */
+export declare function resetSharedRootCacheForTesting(): void;
+/**
+ * Where this checkout's shared data lives.
+ *
+ * `none` keeps its own copy, `user` uses the per-user shared root.
+ */
+export type SharedDataLocation = {
+    share: 'none';
+} | {
+    share: 'user';
+    dirName: string;
+};
+/**
+ * The one decision the cache and the workspace-data DB both follow.
+ *
+ * They have to move together. The DB's `cache_outputs` rows index the cache
+ * directory's contents, so a checkout reading a shared DB while writing a
+ * private cache takes a hit on a row whose artifacts it does not have -- and
+ * `finalizeCacheHits` still calls that `local-cache`, with nothing restored.
+ * Two predicates is how that happens, so there is only one.
+ *
+ * The per-user root is preferred for every checkout, not only for linked
+ * worktrees, and an agent sandbox can be granted `~/.nx` by a committed
+ * settings file where an absolute checkout path cannot (NXC-4625).
+ */
+export declare function resolveSharedDataLocation(root: string): SharedDataLocation;
+/**
+ * The per-user directory a workspace's checkouts share for `kind`.
+ *
+ * It lives outside every checkout because an agent sandbox grants paths, and a
+ * checkout's absolute path is different on each machine so it cannot be
+ * committed to a shared settings file. This root can (NXC-4625).
+ */
+export declare function sharedUserDataDir(dirName: string, kind: SharedDataKind): string;
+/**
+ * The directory `kind` resolves to, following the one sharing decision.
+ *
+ * The shared answer is the same shape for both kinds. The unshared one is not:
+ * the cache honours a configured `cacheDirectory` and the lerna special case,
+ * the DB honours `NX_WORKSPACE_DATA_DIRECTORY`.
+ */
+export declare function sharedDataDirectory(root: string, kind: SharedDataKind): string;
+/**
+ * Path to the directory where Nx stores its cache.
+ *
+ * Normally the shared per-user directory, so every checkout of the workspace
+ * uses one cache. A configured `cacheDirectory` is honored instead, resolved
+ * against the root that asks -- so two checkouts share a configured location
+ * only when the value is absolute. See `resolveSharedDataLocation`.
+ */
+export declare const cacheDir: string;
+export declare function cacheDirectoryForWorkspace(root: string): string;
+/**
+ * This checkout's own workspace-data directory, never the shared one. Daemon
+ * logs and the `disabled` marker live here, and both describe this checkout.
+ */
+export declare const workspaceDataDirectory: string;
+export declare function workspaceDataDirectoryForWorkspace(workspaceRoot: string): string;