nx 20.6.1 → 20.6.3

package/src/devkit-internals.d.ts

@@ -25,3 +25,4 @@ export * from './project-graph/error-types';
 export { registerTsProject } from './plugins/js/utils/register';
 export { interpolate } from './tasks-runner/utils';
 export { isCI } from './utils/is-ci';
+export { isUsingPrettierInTree } from './utils/is-using-prettier';

package/src/devkit-internals.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCI = exports.interpolate = exports.registerTsProject = exports.LoadedNxPlugin = exports.retrieveProjectConfigurations = exports.findProjectForPath = exports.createProjectRootMappingsFromProjectConfigurations = exports.hashMultiGlobWithWorkspaceContext = exports.hashWithWorkspaceContext = exports.hashObject = exports.splitByColons = exports.readModulePackageJson = exports.stripIndent = exports.sortObjectByKeys = exports.combineOptionsForExecutor = exports.splitTarget = exports.findMatchingConfigFiles = exports.readProjectConfigurationsFromRootMap = exports.mergeTargetConfigurations = exports.retrieveProjectConfigurationsWithAngularProjects = exports.calculateDefaultProjectName = exports.readNxJsonFromDisk = exports.getExecutorInformation = exports.createTempNpmDirectory = void 0;
+exports.isUsingPrettierInTree = exports.isCI = exports.interpolate = exports.registerTsProject = exports.LoadedNxPlugin = exports.retrieveProjectConfigurations = exports.findProjectForPath = exports.createProjectRootMappingsFromProjectConfigurations = exports.hashMultiGlobWithWorkspaceContext = exports.hashWithWorkspaceContext = exports.hashObject = exports.splitByColons = exports.readModulePackageJson = exports.stripIndent = exports.sortObjectByKeys = exports.combineOptionsForExecutor = exports.splitTarget = exports.findMatchingConfigFiles = exports.readProjectConfigurationsFromRootMap = exports.mergeTargetConfigurations = exports.retrieveProjectConfigurationsWithAngularProjects = exports.calculateDefaultProjectName = exports.readNxJsonFromDisk = exports.getExecutorInformation = exports.createTempNpmDirectory = void 0;
 const tslib_1 = require("tslib");
 /**
  * Note to developers: STOP! These exports are available via requireNx in @nx/devkit.
@@ -53,3 +53,5 @@ var utils_1 = require("./tasks-runner/utils");
 Object.defineProperty(exports, "interpolate", { enumerable: true, get: function () { return utils_1.interpolate; } });
 var is_ci_1 = require("./utils/is-ci");
 Object.defineProperty(exports, "isCI", { enumerable: true, get: function () { return is_ci_1.isCI; } });
+var is_using_prettier_1 = require("./utils/is-using-prettier");
+Object.defineProperty(exports, "isUsingPrettierInTree", { enumerable: true, get: function () { return is_using_prettier_1.isUsingPrettierInTree; } });

package/src/generators/internal-utils/format-changed-files-with-prettier-if-available.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatChangedFilesWithPrettierIfAvailable = formatChangedFilesWithPrettierIfAvailable;
 exports.formatFilesWithPrettierIfAvailable = formatFilesWithPrettierIfAvailable;
 const path = require("path");
+const is_using_prettier_1 = require("../../utils/is-using-prettier");
 /**
  * Formats all the created or updated files using Prettier
  * @param tree - the file system tree
@@ -19,6 +20,13 @@ async function formatFilesWithPrettierIfAvailable(files, root, options) {
     let prettier;
     try {
         prettier = await Promise.resolve().then(() => require('prettier'));
+        /**
+         * Even after we discovered prettier in node_modules, we need to be sure that the user is intentionally using prettier
+         * before proceeding to format with it.
+         */
+        if (!(0, is_using_prettier_1.isUsingPrettier)(root)) {
+            return results;
+        }
     }
     catch { }
     if (!prettier) {

package/src/generators/testing-utils/create-tree.js

@@ -6,5 +6,9 @@ const tree_1 = require("../tree");
  * Creates a host for testing.
  */
 function createTree() {
-    return new tree_1.FsTree('/virtual', false);
+    const tree = new tree_1.FsTree('/virtual', false);
+    // Allow prettier formatting to be applied to the tree for backwards compatibility within v20
+    // TODO: Decouple formatFiles and other formatting utilities from prettier to avoid this
+    tree.write('.prettierrc', '{}');
+    return tree;
 }

package/src/project-graph/utils/project-configuration-utils.js

@@ -265,7 +265,7 @@ plugins) {
                     e
                 : // This represents a single plugin erroring out with a hard error.
                     new error_types_1.AggregateCreateNodesError([[null, e]], []);
-            if (pluginIndex) {
+            if (pluginIndex !== undefined) {
                 error.pluginIndex = pluginIndex;
             }
             (0, error_types_1.formatAggregateCreateNodesError)(error, pluginName);

package/src/tasks-runner/batch/batch-messages.d.ts

@@ -1,5 +1,6 @@
 import type { TaskResult } from '../../config/misc-interfaces';
 import type { TaskGraph } from '../../config/task-graph';
+import type { ProjectGraph } from '../../config/project-graph';
 export declare enum BatchMessageType {
     RunTasks = 0,
     CompleteTask = 1,
@@ -18,6 +19,7 @@ export interface BatchTaskResult {
 export interface RunTasksMessage {
     type: BatchMessageType.RunTasks;
     executorName: string;
+    projectGraph: ProjectGraph;
     batchTaskGraph: TaskGraph;
     fullTaskGraph: TaskGraph;
 }

package/src/tasks-runner/batch/run-batch.js

@@ -11,9 +11,8 @@ function getBatchExecutor(executorName, projects) {
     const [nodeModule, exportName] = executorName.split(':');
     return (0, executor_utils_1.getExecutorInformation)(nodeModule, exportName, workspace_root_1.workspaceRoot, projects);
 }
-async function runTasks(executorName, batchTaskGraph, fullTaskGraph) {
+async function runTasks(executorName, projectGraph, batchTaskGraph, fullTaskGraph) {
     const input = {};
-    const projectGraph = await (0, project_graph_1.createProjectGraphAsync)();
     const projectsConfigurations = (0, project_graph_1.readProjectsConfigurationFromProjectGraph)(projectGraph);
     const nxJsonConfiguration = (0, configuration_1.readNxJson)();
     const batchExecutor = getBatchExecutor(executorName, projectsConfigurations.projects);
@@ -66,7 +65,7 @@ async function runTasks(executorName, batchTaskGraph, fullTaskGraph) {
 process.on('message', async (message) => {
     switch (message.type) {
         case batch_messages_1.BatchMessageType.RunTasks: {
-            const results = await runTasks(message.executorName, message.batchTaskGraph, message.fullTaskGraph);
+            const results = await runTasks(message.executorName, message.projectGraph, message.batchTaskGraph, message.fullTaskGraph);
             process.send({
                 type: batch_messages_1.BatchMessageType.CompleteBatchExecution,
                 results,

package/src/tasks-runner/forked-process-task-runner.d.ts

@@ -2,6 +2,7 @@ import { DefaultTasksRunnerOptions } from './default-tasks-runner';
 import { Batch } from './tasks-schedule';
 import { BatchResults } from './batch/batch-messages';
 import { Task, TaskGraph } from '../config/task-graph';
+import { ProjectGraph } from '../config/project-graph';
 export declare class ForkedProcessTaskRunner {
     private readonly options;
     cliPath: string;
@@ -10,7 +11,7 @@ export declare class ForkedProcessTaskRunner {
     private pseudoTerminal;
     constructor(options: DefaultTasksRunnerOptions);
     init(): Promise<void>;
-    forkProcessForBatch({ executorName, taskGraph: batchTaskGraph }: Batch, fullTaskGraph: TaskGraph, env: NodeJS.ProcessEnv): Promise<BatchResults>;
+    forkProcessForBatch({ executorName, taskGraph: batchTaskGraph }: Batch, projectGraph: ProjectGraph, fullTaskGraph: TaskGraph, env: NodeJS.ProcessEnv): Promise<BatchResults>;
     forkProcessLegacy(task: Task, { temporaryOutputPath, streamOutput, pipeOutput, taskGraph, env, }: {
         temporaryOutputPath: string;
         streamOutput: boolean;

package/src/tasks-runner/forked-process-task-runner.js

@@ -31,7 +31,7 @@ class ForkedProcessTaskRunner {
         this.setupProcessEventListeners();
     }
     // TODO: vsavkin delegate terminal output printing
-    forkProcessForBatch({ executorName, taskGraph: batchTaskGraph }, fullTaskGraph, env) {
+    forkProcessForBatch({ executorName, taskGraph: batchTaskGraph }, projectGraph, fullTaskGraph, env) {
         return new Promise((res, rej) => {
             try {
                 const count = Object.keys(batchTaskGraph.tasks).length;
@@ -83,6 +83,7 @@ class ForkedProcessTaskRunner {
                 p.send({
                     type: batch_messages_1.BatchMessageType.RunTasks,
                     executorName,
+                    projectGraph,
                     batchTaskGraph,
                     fullTaskGraph,
                 });

package/src/tasks-runner/task-orchestrator.js

@@ -134,8 +134,8 @@ class TaskOrchestrator {
         const shouldCopyOutputsFromCache = 
         // No output files to restore
         !!outputs.length &&
-            // Remote caches are restored to output dirs when applied
-            !cachedResult.remote &&
+            // Remote caches are restored to output dirs when applied and using db cache
+            (!cachedResult.remote || !(0, cache_1.dbCacheEnabled)(this.nxJson)) &&
             // Output files have not been touched since last run
             (await this.shouldCopyOutputsFromCache(outputs, task.hash));
         if (shouldCopyOutputsFromCache) {
@@ -182,7 +182,7 @@ class TaskOrchestrator {
     }
     async runBatch(batch, env) {
         try {
-            const results = await this.forkedProcessTaskRunner.forkProcessForBatch(batch, this.taskGraph, env);
+            const results = await this.forkedProcessTaskRunner.forkProcessForBatch(batch, this.projectGraph, this.taskGraph, env);
             const batchResultEntries = Object.entries(results);
             return batchResultEntries.map(([taskId, result]) => ({
                 ...result,

package/src/utils/is-using-prettier.d.ts

@@ -0,0 +1,3 @@
+import type { Tree } from '../generators/tree';
+export declare function isUsingPrettier(root: string): boolean;
+export declare function isUsingPrettierInTree(tree: Tree): boolean;

package/src/utils/is-using-prettier.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isUsingPrettier = isUsingPrettier;
+exports.isUsingPrettierInTree = isUsingPrettierInTree;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const json_1 = require("../generators/utils/json");
+const fileutils_1 = require("./fileutils");
+/**
+ * Possible configuration files are taken from https://prettier.io/docs/configuration
+ */
+const configFiles = [
+    '.prettierrc',
+    '.prettierrc.json',
+    '.prettierrc.yml',
+    '.prettierrc.yaml',
+    '.prettierrc.json5',
+    '.prettierrc.js',
+    'prettier.config.js',
+    '.prettierrc.ts',
+    'prettier.config.ts',
+    '.prettierrc.mjs',
+    'prettier.config.mjs',
+    '.prettierrc.mts',
+    'prettier.config.mts',
+    '.prettierrc.cjs',
+    'prettier.config.cjs',
+    '.prettierrc.cts',
+    'prettier.config.cts',
+    '.prettierrc.toml',
+];
+function isUsingPrettier(root) {
+    for (const file of configFiles) {
+        if ((0, node_fs_1.existsSync)(file)) {
+            return true;
+        }
+    }
+    // Even if no file is present, it is possible the user is configuring prettier via their package.json
+    const packageJsonPath = (0, node_path_1.join)(root, 'package.json');
+    if ((0, node_fs_1.existsSync)(packageJsonPath)) {
+        const packageJson = (0, fileutils_1.readJsonFile)(packageJsonPath);
+        if (packageJson.prettier) {
+            return true;
+        }
+    }
+    return false;
+}
+function isUsingPrettierInTree(tree) {
+    for (const file of configFiles) {
+        if (tree.exists(file)) {
+            return true;
+        }
+    }
+    // Even if no file is present, it is possible the user is configuring prettier via their package.json
+    if (tree.exists('package.json')) {
+        const packageJson = (0, json_1.readJson)(tree, 'package.json');
+        if (packageJson.prettier) {
+            return true;
+        }
+    }
+    return false;
+}