nx 20.8.4 → 22.7.7

package/src/utils/ignore.d.ts

@@ -1,8 +0,0 @@
-import ignore from 'ignore';
-/**
- * An array of glob patterns that should always be ignored.
- */
-export declare const ALWAYS_IGNORE: string[];
-export declare function getIgnoredGlobs(root?: string, prependRoot?: boolean): string[];
-export declare function getAlwaysIgnore(root?: string): string[];
-export declare function getIgnoreObject(root?: string): ReturnType<typeof ignore>;

package/src/utils/ignore.js

@@ -1,75 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ALWAYS_IGNORE = void 0;
-exports.getIgnoredGlobs = getIgnoredGlobs;
-exports.getAlwaysIgnore = getAlwaysIgnore;
-exports.getIgnoreObject = getIgnoreObject;
-const node_fs_1 = require("node:fs");
-const ignore_1 = require("ignore");
-const fileutils_1 = require("./fileutils");
-const path_1 = require("./path");
-const workspace_root_1 = require("./workspace-root");
-/**
- * An array of glob patterns that should always be ignored.
- */
-exports.ALWAYS_IGNORE = getAlwaysIgnore();
-function getIgnoredGlobs(root = workspace_root_1.workspaceRoot, prependRoot = true) {
-    const files = ['.gitignore', '.nxignore'];
-    if (prependRoot) {
-        return [
-            ...getAlwaysIgnore(root),
-            ...files.flatMap((f) => getIgnoredGlobsFromFile((0, path_1.joinPathFragments)(root, f), root)),
-        ];
-    }
-    else {
-        return [
-            ...getAlwaysIgnore(),
-            ...files.flatMap((f) => getIgnoredGlobsFromFile((0, path_1.joinPathFragments)(root, f))),
-        ];
-    }
-}
-function getAlwaysIgnore(root) {
-    const paths = [
-        'node_modules',
-        '**/node_modules',
-        '.git',
-        '.nx',
-        '.vscode',
-        '.yarn/cache',
-    ];
-    return root ? paths.map((x) => (0, path_1.joinPathFragments)(root, x)) : paths;
-}
-function getIgnoreObject(root = workspace_root_1.workspaceRoot) {
-    const ig = (0, ignore_1.default)();
-    ig.add((0, fileutils_1.readFileIfExisting)(`${root}/.gitignore`));
-    ig.add((0, fileutils_1.readFileIfExisting)(`${root}/.nxignore`));
-    return ig;
-}
-function getIgnoredGlobsFromFile(file, root) {
-    try {
-        const results = [];
-        const contents = (0, node_fs_1.readFileSync)(file, 'utf-8');
-        const lines = contents.split('\n');
-        for (const line of lines) {
-            const trimmed = line.trim();
-            if (!trimmed || trimmed.startsWith('#')) {
-                continue;
-            }
-            else if (trimmed.startsWith('/')) {
-                if (root) {
-                    results.push((0, path_1.joinPathFragments)(root, trimmed));
-                }
-                else {
-                    results.push((0, path_1.joinPathFragments)('.', trimmed));
-                }
-            }
-            else {
-                results.push(trimmed);
-            }
-        }
-        return results;
-    }
-    catch (e) {
-        return [];
-    }
-}

package/src/utils/installation-directory.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNxInstallationPath = getNxInstallationPath;
-exports.getNxRequirePaths = getNxRequirePaths;
-const path_1 = require("path");
-const workspace_root_1 = require("./workspace-root");
-function getNxInstallationPath(root = workspace_root_1.workspaceRoot) {
-    return (0, path_1.join)(root, '.nx', 'installation');
-}
-function getNxRequirePaths(root = workspace_root_1.workspaceRoot) {
-    return [root, getNxInstallationPath(root)];
-}

package/src/utils/is-ci.d.ts

@@ -1 +0,0 @@
-export declare function isCI(): boolean;

package/src/utils/is-ci.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCI = isCI;
-function isCI() {
-    return ((process.env.CI && process.env.CI !== 'false') ||
-        process.env.TF_BUILD === 'true' ||
-        process.env.GITHUB_ACTIONS === 'true' ||
-        process.env.BUILDKITE === 'true' ||
-        process.env.CIRCLECI === 'true' ||
-        process.env.CIRRUS_CI === 'true' ||
-        process.env.TRAVIS === 'true' ||
-        !!process.env['bamboo.buildKey'] ||
-        !!process.env['bamboo_buildKey'] ||
-        !!process.env.CODEBUILD_BUILD_ID ||
-        !!process.env.GITLAB_CI ||
-        !!process.env.HEROKU_TEST_RUN_ID ||
-        !!process.env.BUILD_ID ||
-        !!process.env.BUILD_NUMBER ||
-        !!process.env.BUILD_BUILDID ||
-        !!process.env.TEAMCITY_VERSION ||
-        !!process.env.JENKINS_URL ||
-        !!process.env.HUDSON_URL);
-}

package/src/utils/logger.d.ts

@@ -1,12 +0,0 @@
-export declare const NX_PREFIX: string;
-export declare const NX_ERROR: string;
-export declare const logger: {
-    warn: (s: any) => void;
-    error: (s: any) => void;
-    info: (s: any) => void;
-    log: (...s: any[]) => void;
-    debug: (...s: any[]) => void;
-    fatal: (...s: any[]) => void;
-    verbose: (...s: any[]) => void;
-};
-export declare function stripIndent(str: string): string;

package/src/utils/logger.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.logger = exports.NX_ERROR = exports.NX_PREFIX = void 0;
-exports.stripIndent = stripIndent;
-const chalk = require("chalk");
-exports.NX_PREFIX = chalk.inverse(chalk.bold(chalk.cyan(' NX ')));
-exports.NX_ERROR = chalk.inverse(chalk.bold(chalk.red(' ERROR ')));
-exports.logger = {
-    warn: (s) => console.warn(chalk.bold(chalk.yellow(s))),
-    error: (s) => {
-        if (typeof s === 'string' && s.startsWith('NX ')) {
-            console.error(`\n${exports.NX_ERROR} ${chalk.bold(chalk.red(s.slice(3)))}\n`);
-        }
-        else if (s instanceof Error && s.stack) {
-            console.error(chalk.bold(chalk.red(s.stack)));
-        }
-        else {
-            console.error(chalk.bold(chalk.red(s)));
-        }
-    },
-    info: (s) => {
-        if (typeof s === 'string' && s.startsWith('NX ')) {
-            console.info(`\n${exports.NX_PREFIX} ${chalk.bold(s.slice(3))}\n`);
-        }
-        else {
-            console.info(s);
-        }
-    },
-    log: (...s) => {
-        console.log(...s);
-    },
-    debug: (...s) => {
-        console.debug(...s);
-    },
-    fatal: (...s) => {
-        console.error(...s);
-    },
-    verbose: (...s) => {
-        if (process.env.NX_VERBOSE_LOGGING === 'true') {
-            console.log(...s);
-        }
-    },
-};
-function stripIndent(str) {
-    const match = str.match(/^[ \t]*(?=\S)/gm);
-    if (!match) {
-        return str;
-    }
-    const indent = match.reduce((r, a) => Math.min(r, a.length), Infinity);
-    const regex = new RegExp(`^[ \\t]{${indent}}`, 'gm');
-    return str.replace(regex, '');
-}

package/src/utils/nx-cloud-utils.d.ts

@@ -1,3 +0,0 @@
-import { NxJsonConfiguration } from '../config/nx-json';
-export declare function isNxCloudUsed(nxJson: NxJsonConfiguration): boolean;
-export declare function getNxCloudUrl(nxJson: NxJsonConfiguration): string;

package/src/utils/nx-cloud-utils.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNxCloudUsed = isNxCloudUsed;
-exports.getNxCloudUrl = getNxCloudUrl;
-function isNxCloudUsed(nxJson) {
-    if (process.env.NX_NO_CLOUD === 'true' || nxJson.neverConnectToCloud) {
-        return false;
-    }
-    return (!!process.env.NX_CLOUD_ACCESS_TOKEN ||
-        !!nxJson.nxCloudAccessToken ||
-        !!nxJson.nxCloudId ||
-        !!Object.values(nxJson.tasksRunnerOptions ?? {}).find((r) => r.runner == '@nrwl/nx-cloud' || r.runner == 'nx-cloud'));
-}
-function getNxCloudUrl(nxJson) {
-    const cloudRunner = Object.values(nxJson.tasksRunnerOptions ?? {}).find((r) => r.runner == '@nrwl/nx-cloud' || r.runner == 'nx-cloud');
-    if (!cloudRunner &&
-        !(nxJson.nxCloudAccessToken || process.env.NX_CLOUD_ACCESS_TOKEN) &&
-        !nxJson.nxCloudId)
-        throw new Error('nx-cloud runner not found in nx.json');
-    return cloudRunner?.options?.url ?? nxJson.nxCloudUrl ?? 'https://nx.app';
-}

package/src/utils/nx-key.d.ts

@@ -1,7 +0,0 @@
-import type { NxKey } from '@nx/key';
-export declare function createNxKeyLicenseeInformation(nxKey: NxKey): string;
-export declare function printNxKey(): Promise<void>;
-export declare function getNxKeyInformation(): Promise<NxKey | null>;
-export declare class NxKeyNotInstalledError extends Error {
-    constructor(e: Error);
-}

package/src/utils/nx-key.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NxKeyNotInstalledError = void 0;
-exports.createNxKeyLicenseeInformation = createNxKeyLicenseeInformation;
-exports.printNxKey = printNxKey;
-exports.getNxKeyInformation = getNxKeyInformation;
-const logger_1 = require("./logger");
-const package_manager_1 = require("./package-manager");
-const workspace_root_1 = require("./workspace-root");
-function createNxKeyLicenseeInformation(nxKey) {
-    if ('isPowerpack' in nxKey && nxKey.isPowerpack) {
-        return `Licensed to ${nxKey.organizationName} for ${nxKey.seatCount} user${nxKey.seatCount > 1 ? 's' : ''} in ${nxKey.workspaceCount === 9999
-            ? 'an unlimited number of'
-            : nxKey.workspaceCount} workspace${nxKey.workspaceCount > 1 ? 's' : ''}.`;
-    }
-    else {
-        return `Licensed to ${nxKey.organizationName}.`;
-    }
-}
-async function printNxKey() {
-    try {
-        const key = await getNxKeyInformation();
-        if (key) {
-            logger_1.logger.log(createNxKeyLicenseeInformation(key));
-        }
-    }
-    catch { }
-}
-async function getNxKeyInformation() {
-    try {
-        const { getPowerpackLicenseInformation, getPowerpackLicenseInformationAsync, } = (await Promise.resolve().then(() => require('@nx/powerpack-license')));
-        return (getPowerpackLicenseInformationAsync ?? getPowerpackLicenseInformation)(workspace_root_1.workspaceRoot);
-    }
-    catch (e) {
-        try {
-            const { getNxKeyInformationAsync } = (await Promise.resolve().then(() => require('@nx/key')));
-            return getNxKeyInformationAsync(workspace_root_1.workspaceRoot);
-        }
-        catch (e) {
-            if ('code' in e && e.code === 'MODULE_NOT_FOUND') {
-                throw new NxKeyNotInstalledError(e);
-            }
-            throw e;
-        }
-    }
-}
-class NxKeyNotInstalledError extends Error {
-    constructor(e) {
-        super(`The "@nx/key" package is needed to use Nx key enabled features. Please install it with ${(0, package_manager_1.getPackageManagerCommand)().addDev} @nx/key`, { cause: e });
-    }
-}
-exports.NxKeyNotInstalledError = NxKeyNotInstalledError;

package/src/utils/output.d.ts

@@ -1,71 +0,0 @@
-import * as chalk from 'chalk';
-import type { TaskStatus } from '../tasks-runner/tasks-runner';
-export interface CLIErrorMessageConfig {
-    title: string;
-    bodyLines?: string[];
-    slug?: string;
-}
-export interface CLIWarnMessageConfig {
-    title: string;
-    bodyLines?: string[];
-    slug?: string;
-}
-export interface CLINoteMessageConfig {
-    title: string;
-    bodyLines?: string[];
-}
-export interface CLISuccessMessageConfig {
-    title: string;
-    bodyLines?: string[];
-}
-declare class CLIOutput {
-    cliName: string;
-    formatCommand: (taskId: string) => string;
-    /**
-     * Longer dash character which forms more of a continuous line when place side to side
-     * with itself, unlike the standard dash character
-     */
-    private get VERTICAL_SEPARATOR();
-    /**
-     * Expose some color and other utility functions so that other parts of the codebase that need
-     * more fine-grained control of message bodies are still using a centralized
-     * implementation.
-     */
-    colors: {
-        gray: chalk.Chalk;
-        green: chalk.Chalk;
-        red: chalk.Chalk;
-        cyan: chalk.Chalk;
-        white: chalk.Chalk;
-    };
-    bold: chalk.Chalk;
-    underline: chalk.Chalk;
-    dim: chalk.Chalk;
-    private writeToStdOut;
-    overwriteLine(lineText?: string): void;
-    private writeOutputTitle;
-    private writeOptionalOutputBody;
-    applyNxPrefix(color: string, text: string): string;
-    addNewline(): void;
-    addVerticalSeparator(color?: string): void;
-    addVerticalSeparatorWithoutNewLines(color?: string): void;
-    getVerticalSeparatorLines(color?: string): string[];
-    private getVerticalSeparator;
-    error({ title, slug, bodyLines }: CLIErrorMessageConfig): void;
-    warn({ title, slug, bodyLines }: CLIWarnMessageConfig): void;
-    note({ title, bodyLines }: CLINoteMessageConfig): void;
-    success({ title, bodyLines }: CLISuccessMessageConfig): void;
-    logSingleLine(message: string): void;
-    logCommand(message: string, taskStatus?: TaskStatus): void;
-    logCommandOutput(message: string, taskStatus: TaskStatus, output: string): void;
-    private getCommandWithStatus;
-    private getStatusIcon;
-    private normalizeMessage;
-    private addTaskStatus;
-    log({ title, bodyLines, color }: CLIWarnMessageConfig & {
-        color?: string;
-    }): void;
-    drain(): Promise<void>;
-}
-export declare const output: CLIOutput;
-export {};

package/src/utils/output.js

@@ -1,240 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.output = void 0;
-const chalk = require("chalk");
-const os_1 = require("os");
-const readline = require("readline");
-const is_ci_1 = require("./is-ci");
-const GH_GROUP_PREFIX = '::group::';
-const GH_GROUP_SUFFIX = '::endgroup::';
-/**
- * Automatically disable styling applied by chalk if CI=true
- */
-const forceColor = process.env.FORCE_COLOR === '' || process.env.FORCE_COLOR === 'true';
-if ((0, is_ci_1.isCI)() && !forceColor) {
-    chalk.level = 0;
-}
-class CLIOutput {
-    constructor() {
-        this.cliName = 'NX';
-        this.formatCommand = (taskId) => `${chalk.dim('nx run')} ${taskId}`;
-        /**
-         * Expose some color and other utility functions so that other parts of the codebase that need
-         * more fine-grained control of message bodies are still using a centralized
-         * implementation.
-         */
-        this.colors = {
-            gray: chalk.gray,
-            green: chalk.green,
-            red: chalk.red,
-            cyan: chalk.cyan,
-            white: chalk.white,
-        };
-        this.bold = chalk.bold;
-        this.underline = chalk.underline;
-        this.dim = chalk.dim;
-    }
-    /**
-     * Longer dash character which forms more of a continuous line when place side to side
-     * with itself, unlike the standard dash character
-     */
-    get VERTICAL_SEPARATOR() {
-        let divider = '';
-        for (let i = 0; i < process.stdout.columns - 1; i++) {
-            divider += '\u2014';
-        }
-        return divider;
-    }
-    writeToStdOut(str) {
-        process.stdout.write(str);
-    }
-    overwriteLine(lineText = '') {
-        // this replaces the existing text up to the new line length
-        process.stdout.write(lineText);
-        // clear whatever text might be left to the right of the cursor (happens
-        // when existing text was longer than new one)
-        readline.clearLine(process.stdout, 1);
-        process.stdout.write(os_1.EOL);
-    }
-    writeOutputTitle({ color, title, }) {
-        this.writeToStdOut(`${this.applyNxPrefix(color, title)}${os_1.EOL}`);
-    }
-    writeOptionalOutputBody(bodyLines) {
-        if (!bodyLines) {
-            return;
-        }
-        this.addNewline();
-        bodyLines.forEach((bodyLine) => this.writeToStdOut(`${bodyLine}${os_1.EOL}`));
-    }
-    applyNxPrefix(color = 'cyan', text) {
-        let nxPrefix = '';
-        if (chalk[color]) {
-            nxPrefix = chalk.reset.inverse.bold[color](` ${this.cliName} `);
-        }
-        else {
-            nxPrefix = chalk.reset.inverse.bold.keyword(color)(` ${this.cliName} `);
-        }
-        return `${nxPrefix}  ${text}`;
-    }
-    addNewline() {
-        this.writeToStdOut(os_1.EOL);
-    }
-    addVerticalSeparator(color = 'gray') {
-        this.addNewline();
-        this.addVerticalSeparatorWithoutNewLines(color);
-        this.addNewline();
-    }
-    addVerticalSeparatorWithoutNewLines(color = 'gray') {
-        this.writeToStdOut(`${this.getVerticalSeparator(color)}${os_1.EOL}`);
-    }
-    getVerticalSeparatorLines(color = 'gray') {
-        return ['', this.getVerticalSeparator(color), ''];
-    }
-    getVerticalSeparator(color) {
-        return chalk.dim[color](this.VERTICAL_SEPARATOR);
-    }
-    error({ title, slug, bodyLines }) {
-        this.addNewline();
-        this.writeOutputTitle({
-            color: 'red',
-            title: chalk.red(title),
-        });
-        this.writeOptionalOutputBody(bodyLines);
-        /**
-         * Optional slug to be used in an Nx error message redirect URL
-         */
-        if (slug && typeof slug === 'string') {
-            this.addNewline();
-            this.writeToStdOut(`${chalk.grey('  Learn more about this error: ')}https://errors.nx.dev/${slug}${os_1.EOL}`);
-        }
-        this.addNewline();
-    }
-    warn({ title, slug, bodyLines }) {
-        this.addNewline();
-        this.writeOutputTitle({
-            color: 'yellow',
-            title: chalk.yellow(title),
-        });
-        this.writeOptionalOutputBody(bodyLines);
-        /**
-         * Optional slug to be used in an Nx warning message redirect URL
-         */
-        if (slug && typeof slug === 'string') {
-            this.addNewline();
-            this.writeToStdOut(`${chalk.grey('  Learn more about this warning: ')}https://errors.nx.dev/${slug}${os_1.EOL}`);
-        }
-        this.addNewline();
-    }
-    note({ title, bodyLines }) {
-        this.addNewline();
-        this.writeOutputTitle({
-            color: 'orange',
-            title: chalk.keyword('orange')(title),
-        });
-        this.writeOptionalOutputBody(bodyLines);
-        this.addNewline();
-    }
-    success({ title, bodyLines }) {
-        this.addNewline();
-        this.writeOutputTitle({
-            color: 'green',
-            title: chalk.green(title),
-        });
-        this.writeOptionalOutputBody(bodyLines);
-        this.addNewline();
-    }
-    logSingleLine(message) {
-        this.addNewline();
-        this.writeOutputTitle({
-            color: 'gray',
-            title: message,
-        });
-        this.addNewline();
-    }
-    logCommand(message, taskStatus) {
-        this.addNewline();
-        this.writeToStdOut(this.getCommandWithStatus(message, taskStatus));
-        this.addNewline();
-        this.addNewline();
-    }
-    logCommandOutput(message, taskStatus, output) {
-        let commandOutputWithStatus = this.getCommandWithStatus(message, taskStatus);
-        if (process.env.NX_SKIP_LOG_GROUPING !== 'true' &&
-            process.env.GITHUB_ACTIONS) {
-            const icon = this.getStatusIcon(taskStatus);
-            commandOutputWithStatus = `${GH_GROUP_PREFIX}${icon} ${commandOutputWithStatus}`;
-        }
-        this.addNewline();
-        this.writeToStdOut(commandOutputWithStatus);
-        this.addNewline();
-        this.addNewline();
-        this.writeToStdOut(output);
-        if (process.env.NX_SKIP_LOG_GROUPING !== 'true' &&
-            process.env.GITHUB_ACTIONS) {
-            this.writeToStdOut(GH_GROUP_SUFFIX);
-        }
-    }
-    getCommandWithStatus(message, taskStatus) {
-        const commandOutput = chalk.dim('> ') + this.formatCommand(this.normalizeMessage(message));
-        return this.addTaskStatus(taskStatus, commandOutput);
-    }
-    getStatusIcon(taskStatus) {
-        switch (taskStatus) {
-            case 'success':
-                return '✅';
-            case 'failure':
-                return '❌';
-            case 'skipped':
-            case 'local-cache-kept-existing':
-                return '⏩';
-            case 'local-cache':
-            case 'remote-cache':
-                return '🔁';
-        }
-    }
-    normalizeMessage(message) {
-        if (message.startsWith('nx run ')) {
-            return message.substring('nx run '.length);
-        }
-        else if (message.startsWith('run ')) {
-            return message.substring('run '.length);
-        }
-        else {
-            return message;
-        }
-    }
-    addTaskStatus(taskStatus, commandOutput) {
-        if (taskStatus === 'local-cache') {
-            return `${commandOutput}  ${chalk.dim('[local cache]')}`;
-        }
-        else if (taskStatus === 'remote-cache') {
-            return `${commandOutput}  ${chalk.dim('[remote cache]')}`;
-        }
-        else if (taskStatus === 'local-cache-kept-existing') {
-            return `${commandOutput}  ${chalk.dim('[existing outputs match the cache, left as is]')}`;
-        }
-        else {
-            return commandOutput;
-        }
-    }
-    log({ title, bodyLines, color }) {
-        this.addNewline();
-        this.writeOutputTitle({
-            color: 'cyan',
-            title: color ? chalk[color](title) : title,
-        });
-        this.writeOptionalOutputBody(bodyLines);
-        this.addNewline();
-    }
-    drain() {
-        return new Promise((resolve) => {
-            if (process.stdout.writableNeedDrain) {
-                process.stdout.once('drain', resolve);
-            }
-            else {
-                resolve();
-            }
-        });
-    }
-}
-exports.output = new CLIOutput();