@nx/js 16.5.0 → 16.5.2

package/generators.json

@@ -12,7 +12,6 @@
     "init": {
       "factory": "./src/generators/init/init#initSchematic",
       "schema": "./src/generators/init/schema.json",
-      "aliases": ["lib"],
       "x-type": "init",
       "description": "Initialize a TS/JS workspace.",
       "hidden": true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/js",
-  "version": "16.5.0",
+  "version": "16.5.2",
   "private": false,
   "description": "The JS plugin for Nx contains executors and generators that provide the best experience for developing JavaScript and TypeScript projects. ",
   "repository": {
@@ -39,9 +39,9 @@
     "@babel/preset-env": "^7.15.0",
     "@babel/preset-typescript": "^7.15.0",
     "@babel/runtime": "^7.14.8",
-    "@nrwl/js": "16.5.0",
-    "@nx/devkit": "16.5.0",
-    "@nx/workspace": "16.5.0",
+    "@nrwl/js": "16.5.2",
+    "@nx/devkit": "16.5.2",
+    "@nx/workspace": "16.5.2",
     "@phenomnomnominal/tsquery": "~5.0.1",
     "babel-plugin-const-enum": "^1.0.1",
     "babel-plugin-macros": "^2.8.0",
@@ -69,5 +69,5 @@
     "access": "public"
   },
   "types": "./src/index.d.ts",
-  "gitHead": "eaebcc34f92db2200dab0bde2e2e1dde107a47bf"
+  "gitHead": "928273940d11aa7dea87cb625a92f2c3ec62e726"
 }

package/src/executors/node/node.impl.js

@@ -65,37 +65,60 @@ function nodeExecutor(options, context) {
                     childProcess: null,
                     promise: null,
                     start: () => tslib_1.__awaiter(this, void 0, void 0, function* () {
-                        let buildFailed = false;
-                        // Run the build
-                        task.promise = new Promise((resolve, reject) => tslib_1.__awaiter(this, void 0, void 0, function* () {
-                            task.childProcess = (0, child_process_1.exec)(`npx nx run ${context.projectName}:${buildTarget.target}${buildTarget.configuration ? `:${buildTarget.configuration}` : ''}`, {
-                                cwd: context.root,
-                            }, (error, stdout, stderr) => {
-                                if (
-                                // Build succeeded
-                                !error ||
-                                    // If task was killed then another build process has started, ignore errors.
-                                    task.killed) {
-                                    resolve();
-                                    return;
-                                }
-                                devkit_1.logger.info(stdout);
-                                buildFailed = true;
-                                if (options.watch) {
-                                    devkit_1.logger.error(`Build failed, waiting for changes to restart...`);
-                                    resolve(); // Don't reject because it'll error out and kill the Nx process.
-                                }
-                                else {
-                                    devkit_1.logger.error(`Build failed. See above for errors.`);
+                        if (options.runBuildTargetDependencies) {
+                            // If task dependencies are to be run, then we need to run through CLI since `runExecutor` doesn't support it.
+                            task.promise = new Promise((resolve, reject) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                                task.childProcess = (0, child_process_1.fork)(require.resolve('nx'), [
+                                    'run',
+                                    `${context.projectName}:${buildTarget.target}${buildTarget.configuration
+                                        ? `:${buildTarget.configuration}`
+                                        : ''}`,
+                                ], {
+                                    cwd: context.root,
+                                    stdio: 'inherit',
+                                });
+                                task.childProcess.once('exit', (code) => {
+                                    if (code === 0)
+                                        resolve();
+                                    else
+                                        reject();
+                                });
+                            }));
+                        }
+                        else {
+                            const output = yield (0, devkit_1.runExecutor)(buildTarget, Object.assign(Object.assign({}, options.buildTargetOptions), { watch: false }), context);
+                            task.promise = new Promise((resolve, reject) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                                var _g;
+                                let error = false;
+                                let event;
+                                do {
+                                    event = yield output.next();
+                                    if (((_g = event.value) === null || _g === void 0 ? void 0 : _g.success) === false) {
+                                        error = true;
+                                    }
+                                } while (!event.done);
+                                if (error)
                                     reject();
-                                }
-                            });
-                        }));
-                        // Wait for build to finish
-                        yield task.promise;
-                        // Task may have been stopped due to another running task.
-                        // OR build failed, so don't start the process.
-                        if (task.killed || buildFailed)
+                                else
+                                    resolve();
+                            }));
+                        }
+                        // Wait for build to finish.
+                        try {
+                            yield task.promise;
+                        }
+                        catch (_f) {
+                            // If in watch-mode, don't throw or else the process exits.
+                            if (options.watch) {
+                                devkit_1.logger.error(`Build failed, waiting for changes to restart...`);
+                                return;
+                            }
+                            else {
+                                throw new Error(`Build failed. See above for errors.`);
+                            }
+                        }
+                        // Before running the program, check if the task has been killed (by a new change during watch).
+                        if (task.killed)
                             return;
                         // Run the program
                         task.promise = new Promise((resolve, reject) => {
@@ -105,15 +128,17 @@ function nodeExecutor(options, context) {
                                 stdio: [0, 1, 'pipe', 'ipc'],
                                 env: Object.assign(Object.assign({}, process.env), { NX_FILE_TO_RUN: fileToRunCorrectPath(fileToRun), NX_MAPPINGS: JSON.stringify(mappings) }),
                             });
-                            task.childProcess.stderr.on('data', (data) => {
+                            const handleStdErr = (data) => {
                                 // Don't log out error if task is killed and new one has started.
                                 // This could happen if a new build is triggered while new process is starting, since the operation is not atomic.
                                 // Log the error in normal mode
                                 if (!options.watch || !task.killed) {
                                     devkit_1.logger.error(data.toString());
                                 }
-                            });
+                            };
+                            task.childProcess.stderr.on('data', handleStdErr);
                             task.childProcess.once('exit', (code) => {
+                                task.childProcess.off('data', handleStdErr);
                                 if (options.watch && !task.killed) {
                                     devkit_1.logger.info(`NX Process exited with code ${code}, waiting for changes to restart...`);
                                 }
@@ -132,7 +157,12 @@ function nodeExecutor(options, context) {
                         if (task.childProcess) {
                             yield (0, kill_tree_1.killTree)(task.childProcess.pid, signal);
                         }
-                        yield task.promise;
+                        try {
+                            yield task.promise;
+                        }
+                        catch (_h) {
+                            // Doesn't matter if task fails, we just need to wait until it finishes.
+                        }
                     }),
                 };
                 tasks.push(task);
@@ -142,13 +172,13 @@ function nodeExecutor(options, context) {
                     watchProjects: [context.projectName],
                     includeDependentProjects: true,
                 }, (err, data) => tslib_1.__awaiter(this, void 0, void 0, function* () {
-                    var _f;
+                    var _j;
                     if (err === 'closed') {
                         devkit_1.logger.error(`Watch error: Daemon closed the connection`);
                         process.exit(1);
                     }
                     else if (err) {
-                        devkit_1.logger.error(`Watch error: ${(_f = err === null || err === void 0 ? void 0 : err.message) !== null && _f !== void 0 ? _f : 'Unknown'}`);
+                        devkit_1.logger.error(`Watch error: ${(_j = err === null || err === void 0 ? void 0 : err.message) !== null && _j !== void 0 ? _j : 'Unknown'}`);
                     }
                     else {
                         devkit_1.logger.info(`NX File change detected. Restarting...`);

package/src/executors/node/schema.d.ts

@@ -14,4 +14,5 @@ export interface NodeExecutorOptions {
   port: number;
   watch?: boolean;
   debounce?: number;
+  runBuildTargetDependencies?: boolean;
 }

package/src/executors/node/schema.json

@@ -27,12 +27,14 @@
     "host": {
       "type": "string",
       "default": "localhost",
-      "description": "The host to inspect the process on."
+      "description": "The host to inspect the process on.",
+      "x-priority": "important"
     },
     "port": {
       "type": "number",
       "default": 9229,
-      "description": "The port to inspect the process on. Setting port to 0 will assign random free ports to all forked processes."
+      "description": "The port to inspect the process on. Setting port to 0 will assign random free ports to all forked processes.",
+      "x-priority": "important"
     },
     "inspect": {
       "oneOf": [
@@ -45,7 +47,8 @@
         }
       ],
       "description": "Ensures the app is starting with debugging.",
-      "default": "inspect"
+      "default": "inspect",
+      "x-priority": "important"
     },
     "runtimeArgs": {
       "type": "array",
@@ -53,7 +56,8 @@
       "default": [],
       "items": {
         "type": "string"
-      }
+      },
+      "x-priority": "important"
     },
     "args": {
       "type": "array",
@@ -61,19 +65,28 @@
       "default": [],
       "items": {
         "type": "string"
-      }
+      },
+      "x-priority": "important"
     },
     "watch": {
       "type": "boolean",
       "description": "Enable re-building when files change.",
-      "default": true
+      "default": true,
+      "x-priority": "important"
     },
     "debounce": {
       "type": "number",
       "description": "Delay in milliseconds to wait before restarting. Useful to batch multiple file changes events together. Set to zero (0) to disable.",
-      "default": 500
+      "default": 500,
+      "x-priority": "important"
+    },
+    "runBuildTargetDependencies": {
+      "type": "boolean",
+      "description": "Whether to run dependencies before running the build. Set this to true if the project does not build libraries from source (e.g. 'buildLibsFromSource: false').",
+      "default": false
     }
   },
   "additionalProperties": false,
-  "required": ["buildTarget"]
+  "required": ["buildTarget"],
+  "examplesFile": "../../../docs/node-examples.md"
 }

package/src/executors/tsc/tsc.batch-impl.js

@@ -43,20 +43,21 @@ function tscBatchExecutor(taskGraph, inputs, overrides, context) {
                 }
             },
         };
+        const processTaskPostCompilation = (tsConfig) => {
+            if (tsConfigTaskInfoMap[tsConfig]) {
+                const taskInfo = tsConfigTaskInfoMap[tsConfig];
+                taskInfo.assetsHandler.processAllAssetsOnceSync();
+                (0, update_package_json_1.updatePackageJson)(taskInfo.options, taskInfo.context, taskInfo.projectGraphNode, taskInfo.buildableProjectNodeDependencies);
+                taskInfo.endTime = Date.now();
+            }
+        };
         const typescriptCompilation = (0, lib_1.compileTypescriptSolution)(tsCompilationContext, shouldWatch, logger, {
             beforeProjectCompilationCallback: (tsConfig) => {
                 if (tsConfigTaskInfoMap[tsConfig]) {
                     tsConfigTaskInfoMap[tsConfig].startTime = Date.now();
                 }
             },
-            afterProjectCompilationCallback: (tsConfig) => {
-                if (tsConfigTaskInfoMap[tsConfig]) {
-                    const taskInfo = tsConfigTaskInfoMap[tsConfig];
-                    taskInfo.assetsHandler.processAllAssetsOnceSync();
-                    (0, update_package_json_1.updatePackageJson)(taskInfo.options, taskInfo.context, taskInfo.projectGraphNode, taskInfo.buildableProjectNodeDependencies);
-                    taskInfo.endTime = Date.now();
-                }
-            },
+            afterProjectCompilationCallback: processTaskPostCompilation,
         });
         if (shouldWatch) {
             const taskInfos = Object.values(tsConfigTaskInfoMap);
@@ -79,21 +80,54 @@ function tscBatchExecutor(taskGraph, inputs, overrides, context) {
                 return { value: undefined, done: true };
             }))))));
         }
+        const toBatchExecutorTaskResult = (tsConfig, success) => ({
+            task: tsConfigTaskInfoMap[tsConfig].task,
+            result: {
+                success: success,
+                terminalOutput: tsConfigTaskInfoMap[tsConfig].terminalOutput,
+                startTime: tsConfigTaskInfoMap[tsConfig].startTime,
+                endTime: tsConfigTaskInfoMap[tsConfig].endTime,
+            },
+        });
+        let isCompilationDone = false;
+        const taskTsConfigsToReport = new Set(Object.keys(taskGraph.tasks).map((t) => taskInMemoryTsConfigMap[t].path));
+        let tasksToReportIterator;
+        const processSkippedTasks = () => {
+            const { value: tsConfig, done } = tasksToReportIterator.next();
+            if (done) {
+                return { value: undefined, done: true };
+            }
+            tsConfigTaskInfoMap[tsConfig].startTime = Date.now();
+            processTaskPostCompilation(tsConfig);
+            return { value: toBatchExecutorTaskResult(tsConfig, true), done: false };
+        };
         return yield tslib_1.__await(yield tslib_1.__await(yield* tslib_1.__asyncDelegator(tslib_1.__asyncValues(mapAsyncIterable(typescriptCompilation, (iterator) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            if (isCompilationDone) {
+                return processSkippedTasks();
+            }
             const { value, done } = yield iterator.next();
             if (done) {
-                return { value, done: true };
+                if (taskTsConfigsToReport.size > 0) {
+                    /**
+                     * TS compilation is done but we still have tasks to report. This can
+                     * happen if, for example, a project is identified as affected, but
+                     * no file in the TS project is actually changed or if running a
+                     * task with `--skip-nx-cache` and the outputs are already there. There
+                     * can still be changes to assets or other files we need to process.
+                     *
+                     * Switch to handle the iterator for the tasks we still need to report.
+                     */
+                    isCompilationDone = true;
+                    tasksToReportIterator = taskTsConfigsToReport.values();
+                    return processSkippedTasks();
+                }
+                return { value: undefined, done: true };
             }
-            const taskResult = {
-                task: tsConfigTaskInfoMap[value.tsConfig].task,
-                result: {
-                    success: value.success,
-                    terminalOutput: tsConfigTaskInfoMap[value.tsConfig].terminalOutput,
-                    startTime: tsConfigTaskInfoMap[value.tsConfig].startTime,
-                    endTime: tsConfigTaskInfoMap[value.tsConfig].endTime,
-                },
+            taskTsConfigsToReport.delete(value.tsConfig);
+            return {
+                value: toBatchExecutorTaskResult(value.tsConfig, value.success),
+                done: false,
             };
-            return { value: taskResult, done: false };
         }))))));
     });
 }

package/src/executors/verdaccio/verdaccio.impl.js

@@ -120,8 +120,10 @@ function setupNpm(options) {
         throw new Error(`Failed to set npm registry to http://localhost:${options.port}/: ${e.message}`);
     }
     return () => {
+        var _a, _b, _c;
         try {
-            if (npmRegistryPath) {
+            const currentNpmRegistryPath = (_c = (_b = (_a = (0, child_process_1.execSync)(`npm config get registry --location ${options.location}`)) === null || _a === void 0 ? void 0 : _a.toString()) === null || _b === void 0 ? void 0 : _b.trim()) === null || _c === void 0 ? void 0 : _c.replace('\u001b[2K\u001b[1G', ''); // strip out ansi codes
+            if (npmRegistryPath && currentNpmRegistryPath.includes('localhost')) {
                 (0, child_process_1.execSync)(`npm config set registry ${npmRegistryPath} --location ${options.location}`);
                 devkit_1.logger.info(`Reset npm registry to ${npmRegistryPath}`);
             }
@@ -174,8 +176,10 @@ function setupYarn(options) {
             devkit_1.logger.info(`Whitelisted http://localhost:${options.port}/ as an unsafe http server`);
         }
         return () => {
+            var _a, _b, _c;
             try {
-                if (yarnRegistryPath) {
+                const currentYarnRegistryPath = (_c = (_b = (_a = (0, child_process_1.execSync)(`yarn config get ${registryConfigName}`)) === null || _a === void 0 ? void 0 : _a.toString()) === null || _b === void 0 ? void 0 : _b.trim()) === null || _c === void 0 ? void 0 : _c.replace('\u001b[2K\u001b[1G', ''); // strip out ansi codes
+                if (yarnRegistryPath && currentYarnRegistryPath.includes('localhost')) {
                     (0, child_process_1.execSync)(`yarn config set ${registryConfigName} ${yarnRegistryPath}` +
                         (options.location === 'user' ? ' --home' : ''));
                     devkit_1.logger.info(`Reset yarn ${registryConfigName} to ${yarnRegistryPath}`);

package/src/utils/find-npm-dependencies.d.ts

@@ -0,0 +1,7 @@
+import { type ProjectGraph, type ProjectGraphProjectNode, type ProjectFileMap } from '@nx/devkit';
+/**
+ * Finds all npm dependencies and their expected versions for a given project.
+ */
+export declare function findNpmDependencies(workspaceRoot: string, sourceProject: ProjectGraphProjectNode, projectGraph: ProjectGraph, projectFileMap: ProjectFileMap, buildTarget: string, options?: {
+    includeTransitiveDependencies?: boolean;
+}): Record<string, string>;

package/src/utils/find-npm-dependencies.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findNpmDependencies = void 0;
+const path_1 = require("path");
+const file_utils_1 = require("nx/src/project-graph/file-utils");
+const task_hasher_1 = require("nx/src/hasher/task-hasher");
+const devkit_1 = require("@nx/devkit");
+const fileutils_1 = require("nx/src/utils/fileutils");
+const project_graph_1 = require("nx/src/config/project-graph");
+const ts_config_1 = require("./typescript/ts-config");
+/**
+ * Finds all npm dependencies and their expected versions for a given project.
+ */
+function findNpmDependencies(workspaceRoot, sourceProject, projectGraph, projectFileMap, buildTarget, options = {}) {
+    let seen = null;
+    if (options.includeTransitiveDependencies) {
+        seen = new Set();
+    }
+    const results = {};
+    function collectAll(currentProject, collectedDeps) {
+        if (seen === null || seen === void 0 ? void 0 : seen.has(currentProject.name))
+            return;
+        collectDependenciesFromFileMap(workspaceRoot, currentProject, projectGraph, projectFileMap, buildTarget, collectedDeps);
+        collectHelperDependencies(workspaceRoot, currentProject, projectGraph, buildTarget, collectedDeps);
+        if (options.includeTransitiveDependencies) {
+            const projectDeps = projectGraph.dependencies[currentProject.name];
+            for (const dep of projectDeps) {
+                const projectDep = projectGraph.nodes[dep.target];
+                if (projectDep)
+                    collectAll(projectDep, collectedDeps);
+            }
+        }
+    }
+    collectAll(sourceProject, results);
+    return results;
+}
+exports.findNpmDependencies = findNpmDependencies;
+// Keep track of workspace libs we already read package.json for so we don't read from disk again.
+const seenWorkspaceDeps = {};
+function collectDependenciesFromFileMap(workspaceRoot, sourceProject, projectGraph, projectFileMap, buildTarget, npmDeps) {
+    const rawFiles = projectFileMap[sourceProject.name];
+    if (!rawFiles)
+        return;
+    // Cannot read inputs if the target does not exist on the project.
+    if (!sourceProject.data.targets[buildTarget])
+        return;
+    const inputs = (0, task_hasher_1.getTargetInputs)((0, file_utils_1.readNxJson)(), sourceProject, buildTarget).selfInputs;
+    const files = (0, task_hasher_1.filterUsingGlobPatterns)(sourceProject.data.root, projectFileMap[sourceProject.name] || [], inputs);
+    for (const fileData of files) {
+        if (!fileData.deps ||
+            fileData.file ===
+                (0, devkit_1.joinPathFragments)(sourceProject.data.root, 'package.json')) {
+            continue;
+        }
+        for (const dep of fileData.deps) {
+            const target = (0, project_graph_1.fileDataDepTarget)(dep);
+            // If the node is external, then read package info from `data`.
+            const externalDep = projectGraph.externalNodes[target];
+            if ((externalDep === null || externalDep === void 0 ? void 0 : externalDep.type) === 'npm') {
+                npmDeps[externalDep.data.packageName] = externalDep.data.version;
+                continue;
+            }
+            // If node is internal, then try reading package info from `package.json` (which must exist for this to work).
+            const workspaceDep = projectGraph.nodes[target];
+            if (!workspaceDep)
+                continue;
+            const cached = seenWorkspaceDeps[workspaceDep.name];
+            if (cached) {
+                npmDeps[cached.name] = cached.version;
+            }
+            else {
+                const packageJson = readPackageJson(workspaceDep, workspaceRoot);
+                if (packageJson) {
+                    // This is a workspace lib so we can't reliably read in a specific version since it depends on how the workspace is set up.
+                    // ASSUMPTION: Most users will use '*' for workspace lib versions. Otherwise, they can manually update it.
+                    npmDeps[packageJson.name] = '*';
+                    seenWorkspaceDeps[workspaceDep.name] = {
+                        name: packageJson.name,
+                        version: '*',
+                    };
+                }
+            }
+        }
+    }
+}
+function readPackageJson(project, workspaceRoot) {
+    const packageJsonPath = (0, path_1.join)(workspaceRoot, project.data.root, 'package.json');
+    if ((0, fileutils_1.fileExists)(packageJsonPath))
+        return (0, devkit_1.readJsonFile)(packageJsonPath);
+    return null;
+}
+function collectHelperDependencies(workspaceRoot, sourceProject, projectGraph, buildTarget, npmDeps) {
+    var _a, _b, _c, _d;
+    const target = sourceProject.data.targets[buildTarget];
+    if (!target)
+        return;
+    if (target.executor === '@nx/js:tsc' && ((_a = target.options) === null || _a === void 0 ? void 0 : _a.tsConfig)) {
+        const tsConfig = (0, ts_config_1.readTsConfig)((0, path_1.join)(workspaceRoot, target.options.tsConfig));
+        if (tsConfig === null || tsConfig === void 0 ? void 0 : tsConfig.options['importHelpers']) {
+            npmDeps['tslib'] = (_b = projectGraph.externalNodes['npm:tslib']) === null || _b === void 0 ? void 0 : _b.data.version;
+        }
+    }
+    if (target.executor === '@nx/js:swc') {
+        const swcConfigPath = target.options.swcrc
+            ? (0, path_1.join)(workspaceRoot, target.options.swcrc)
+            : (0, path_1.join)(workspaceRoot, sourceProject.data.root, '.swcrc');
+        const swcConfig = (0, fileutils_1.fileExists)(swcConfigPath)
+            ? (0, devkit_1.readJsonFile)(swcConfigPath)
+            : {};
+        if ((_c = swcConfig === null || swcConfig === void 0 ? void 0 : swcConfig.jsc) === null || _c === void 0 ? void 0 : _c.externalHelpers) {
+            npmDeps['@swc/helpers'] =
+                (_d = projectGraph.externalNodes['npm:@swc/helpers']) === null || _d === void 0 ? void 0 : _d.data.version;
+        }
+    }
+}