nx 19.4.0-canary.20240627-c2c6a13 → 19.4.0-canary.20240628-336d371

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nx",
-  "version": "19.4.0-canary.20240627-c2c6a13",
+  "version": "19.4.0-canary.20240628-336d371",
   "private": false,
   "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
   "repository": {
@@ -70,7 +70,7 @@
     "yargs-parser": "21.1.1",
     "node-machine-id": "1.1.12",
     "ora": "5.3.0",
-    "@nrwl/tao": "19.4.0-canary.20240627-c2c6a13"
+    "@nrwl/tao": "19.4.0-canary.20240628-336d371"
   },
   "peerDependencies": {
     "@swc-node/register": "^1.8.0",
@@ -85,16 +85,16 @@
     }
   },
   "optionalDependencies": {
-    "@nx/nx-darwin-x64": "19.4.0-canary.20240627-c2c6a13",
-    "@nx/nx-darwin-arm64": "19.4.0-canary.20240627-c2c6a13",
-    "@nx/nx-linux-x64-gnu": "19.4.0-canary.20240627-c2c6a13",
-    "@nx/nx-linux-x64-musl": "19.4.0-canary.20240627-c2c6a13",
-    "@nx/nx-win32-x64-msvc": "19.4.0-canary.20240627-c2c6a13",
-    "@nx/nx-linux-arm64-gnu": "19.4.0-canary.20240627-c2c6a13",
-    "@nx/nx-linux-arm64-musl": "19.4.0-canary.20240627-c2c6a13",
-    "@nx/nx-linux-arm-gnueabihf": "19.4.0-canary.20240627-c2c6a13",
-    "@nx/nx-win32-arm64-msvc": "19.4.0-canary.20240627-c2c6a13",
-    "@nx/nx-freebsd-x64": "19.4.0-canary.20240627-c2c6a13"
+    "@nx/nx-darwin-x64": "19.4.0-canary.20240628-336d371",
+    "@nx/nx-darwin-arm64": "19.4.0-canary.20240628-336d371",
+    "@nx/nx-linux-x64-gnu": "19.4.0-canary.20240628-336d371",
+    "@nx/nx-linux-x64-musl": "19.4.0-canary.20240628-336d371",
+    "@nx/nx-win32-x64-msvc": "19.4.0-canary.20240628-336d371",
+    "@nx/nx-linux-arm64-gnu": "19.4.0-canary.20240628-336d371",
+    "@nx/nx-linux-arm64-musl": "19.4.0-canary.20240628-336d371",
+    "@nx/nx-linux-arm-gnueabihf": "19.4.0-canary.20240628-336d371",
+    "@nx/nx-win32-arm64-msvc": "19.4.0-canary.20240628-336d371",
+    "@nx/nx-freebsd-x64": "19.4.0-canary.20240628-336d371"
   },
   "nx-migrations": {
     "migrations": "./migrations.json",

package/src/command-line/graph/graph.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateGraph = void 0;
 const crypto_1 = require("crypto");
+const node_child_process_1 = require("node:child_process");
 const fs_1 = require("fs");
 const fs_extra_1 = require("fs-extra");
 const http = require("http");
@@ -25,8 +26,8 @@ const native_1 = require("../../native");
 const transform_objects_1 = require("../../native/transform-objects");
 const affected_1 = require("../affected/affected");
 const nx_deps_cache_1 = require("../../project-graph/nx-deps-cache");
-const create_task_hasher_1 = require("../../hasher/create-task-hasher");
 const task_hasher_1 = require("../../hasher/task-hasher");
+const create_task_hasher_1 = require("../../hasher/create-task-hasher");
 const error_types_1 = require("../../project-graph/error-types");
 const nx_cloud_utils_1 = require("../../utils/nx-cloud-utils");
 // maps file extention to MIME types
@@ -373,6 +374,20 @@ async function startServer(html, environmentJs, host, port = 4211, watchForchang
             res.end(environmentJs);
             return;
         }
+        if (sanitizePath === 'help') {
+            const project = parsedUrl.searchParams.get('project');
+            const target = parsedUrl.searchParams.get('target');
+            try {
+                const text = getHelpTextFromTarget(project, target);
+                res.writeHead(200, { 'Content-Type': 'application/javascript' });
+                res.end(JSON.stringify({ text, success: true }));
+            }
+            catch (err) {
+                res.writeHead(200, { 'Content-Type': 'application/javascript' });
+                res.end(JSON.stringify({ text: err.message, success: false }));
+            }
+            return;
+        }
         let pathname = (0, path_1.join)(__dirname, '../../core/graph/', sanitizePath);
         // if the file is not found or is a directory, return index.html
         if (!(0, fs_1.existsSync)(pathname) || (0, fs_1.statSync)(pathname).isDirectory()) {
@@ -744,3 +759,21 @@ async function createJsonOutput(prunedGraph, rawGraph, projects, targets) {
     }
     return response;
 }
+function getHelpTextFromTarget(projectName, targetName) {
+    if (!projectName)
+        throw new Error(`Missing project`);
+    if (!targetName)
+        throw new Error(`Missing target`);
+    const project = currentProjectGraphClientResponse.projects?.find((p) => p.name === projectName);
+    if (!project)
+        throw new Error(`Cannot find project ${projectName}`);
+    const target = project.data.targets[targetName];
+    if (!target)
+        throw new Error(`Cannot find target ${targetName}`);
+    const command = target.metadata?.help?.command;
+    if (!command)
+        throw new Error(`No help command found for ${projectName}:${targetName}`);
+    return (0, node_child_process_1.execSync)(command, {
+        cwd: (0, path_1.join)(workspace_root_1.workspaceRoot, project.data.root),
+    }).toString();
+}

package/src/config/workspace-json-project-json.d.ts

@@ -114,6 +114,13 @@ export interface TargetMetadata {
     description?: string;
     technologies?: string[];
     nonAtomizedTarget?: string;
+    help?: {
+        command: string;
+        example: {
+            options?: Record<string, unknown>;
+            args?: string[];
+        };
+    };
 }
 export interface TargetDependencyConfig {
     /**