nx 23.3.0 → 24.0.0-beta.1

package/schemas/project-schema.json

@@ -102,6 +102,17 @@
                       "description": "Configuration for params handling.",
                       "enum": ["ignore", "forward"],
                       "default": "ignore"
+                    },
+                    "inputs": {
+                      "type": "boolean",
+                      "description": "Set to false to keep a continuous dependency's inputs out of this target's hash and affected calculation. Has no effect on dependencies that are not continuous.",
+                      "default": true
+                    },
+                    "waitFor": {
+                      "type": "string",
+                      "description": "For a continuous dependency, whether to wait until it has started or until it is ready per its readyWhen. Ignored when the dependency is not continuous or has no readyWhen.",
+                      "enum": ["started", "ready"],
+                      "default": "started"
                     }
                   },
                   "oneOf": [
@@ -174,6 +185,9 @@
             "default": false,
             "description": "Whether this target runs continuously until stopped"
           },
+          "readyWhen": {
+            "$ref": "#/definitions/readyWhen"
+          },
           "parallelism": {
             "type": "boolean",
             "default": true,
@@ -234,6 +248,59 @@
     }
   },
   "definitions": {
+    "readyWhen": {
+      "description": "How Nx detects that this continuous target is ready. Dependents opt in with \"waitFor\": \"ready\" on their dependsOn entry. Strings may use the {workspaceRoot}, {projectRoot}, {projectName} and {options.*} placeholders, resolved against the options the task runs with.",
+      "type": "object",
+      "properties": {
+        "url": {
+          "type": "string",
+          "description": "Ready when an HTTP or HTTPS GET gets a status from 200 to 403. A redirect counts as ready and is not followed"
+        },
+        "port": {
+          "type": ["integer", "string"],
+          "minimum": 1,
+          "maximum": 65535,
+          "description": "Ready when a TCP connection to this port succeeds. A string must resolve to a port number through a placeholder such as {options.port}"
+        },
+        "host": {
+          "type": "string",
+          "description": "Host to connect to with port. By default 127.0.0.1 and ::1 are both tried"
+        },
+        "command": {
+          "type": "string",
+          "description": "Ready when this command, run through the shell at the workspace root, exits with code 0"
+        },
+        "logMatches": {
+          "description": "Ready when every one of these substrings has appeared in the task's output",
+          "oneOf": [
+            { "type": "string" },
+            {
+              "type": "array",
+              "items": { "type": "string" },
+              "minItems": 1
+            }
+          ]
+        },
+        "timeout": {
+          "type": "integer",
+          "minimum": 1,
+          "default": 60000,
+          "description": "Milliseconds to wait for readiness before failing dependents that wait for it"
+        },
+        "interval": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Milliseconds between probe attempts. By default attempts back off from 100 to 1000 milliseconds. Unused by logMatches"
+        }
+      },
+      "oneOf": [
+        { "required": ["url"] },
+        { "required": ["port"] },
+        { "required": ["command"] },
+        { "required": ["logMatches"] }
+      ],
+      "additionalProperties": false
+    },
     "inputs": {
       "type": "array",
       "items": {

package/dist/src/tasks-runner/legacy-depends-on-warning.d.ts

@@ -1,18 +0,0 @@
-import { TargetDependencyConfig } from '../config/workspace-json-project-json';
-type LegacyValue = 'self' | 'dependencies';
-type LegacyEntry = TargetDependencyConfig & {
-    projects: LegacyValue;
-};
-export interface LegacyDependsOnViolation {
-    index: number;
-    originalEntry: LegacyEntry;
-}
-export interface LegacyDependsOnLocation {
-    ownerTarget?: string;
-    index?: number;
-    legacyViolations?: LegacyDependsOnViolation[];
-}
-export declare function warnLegacyDependsOnMagicString(currentProject: string | undefined, dependencyConfig: TargetDependencyConfig, location: LegacyDependsOnLocation | undefined): void;
-export declare function flushLegacyDependsOnViolations(project: string, ownerTarget: string, violations: LegacyDependsOnViolation[], projectRoot: string | undefined): void;
-export declare function __resetForTests(): void;
-export {};

package/dist/src/tasks-runner/legacy-depends-on-warning.js

@@ -1,109 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.warnLegacyDependsOnMagicString = warnLegacyDependsOnMagicString;
-exports.flushLegacyDependsOnViolations = flushLegacyDependsOnViolations;
-exports.__resetForTests = __resetForTests;
-const nx_deps_cache_1 = require("../project-graph/nx-deps-cache");
-const source_maps_1 = require("../project-graph/utils/project-configuration/source-maps");
-const output_1 = require("../utils/output");
-const warned = new Set();
-const isInternal = (p) => !p || p.startsWith('nx/');
-// Callers gate this on `dependencyConfig.projects` already being a legacy value;
-// the inner cast snapshots that runtime guarantee into the type system.
-function warnLegacyDependsOnMagicString(currentProject, dependencyConfig, location) {
-    const violation = {
-        index: location?.index ?? -1,
-        originalEntry: { ...dependencyConfig },
-    };
-    // Collector-aware caller (`getDependencyConfigs`) batches violations so the
-    // warning can group all offending entries for a single target. External
-    // callers fall through to an immediate per-entry warning.
-    if (location?.legacyViolations)
-        return void location.legacyViolations.push(violation);
-    flushLegacyDependsOnViolations(currentProject ?? '<unknown>', location?.ownerTarget ?? '<unknown>', [violation], undefined);
-}
-function flushLegacyDependsOnViolations(project, ownerTarget, violations, projectRoot) {
-    if (violations.length === 0)
-        return;
-    // Read source maps fresh each flush so daemon-cached maps don't go stale;
-    // only runs when violations exist, which is rare.
-    let sourceMaps = null;
-    try {
-        sourceMaps = (0, nx_deps_cache_1.readSourceMapsCache)();
-    }
-    catch { } // best-effort context
-    const map = projectRoot && sourceMaps ? sourceMaps[projectRoot] : undefined;
-    const arrayKey = `targets.${ownerTarget}.dependsOn`;
-    const items = violations.map((v) => {
-        const info = map
-            ? (0, source_maps_1.readArrayItemSourceInfo)(map, arrayKey, v.index)
-            : undefined;
-        return {
-            ...v,
-            value: v.originalEntry.projects,
-            plugin: info?.[1],
-            file: info?.[0] ?? undefined,
-        };
-    });
-    const shared = (key) => items.every((i) => i[key] === items[0][key]) ? items[0][key] : null;
-    const value = shared('value');
-    const plugin = shared('plugin');
-    const file = shared('file');
-    // External-plugin warnings are workspace-wide (the plugin's behavior, not a
-    // specific config): dedupe per (plugin, value) so the user sees one warning
-    // per offending plugin, not one per affected target.
-    const dedupeKey = plugin && !isInternal(plugin) && value
-        ? `plugin::${plugin}::${value}`
-        : `target::${project}::${ownerTarget}`;
-    if (warned.has(dedupeKey))
-        return;
-    warned.add(dedupeKey);
-    const n = items.length;
-    const word = n === 1 ? 'entry' : 'entries';
-    const deprecation = 'This is deprecated and will be removed in Nx v24 —';
-    let phrase;
-    if (value) {
-        phrase = `projects: '${value}'`;
-    }
-    else {
-        const self = items.filter((i) => i.value === 'self').length;
-        phrase = `legacy projects values (${self} 'self', ${n - self} 'dependencies')`;
-    }
-    let title;
-    let suppressBody = false;
-    if (plugin && !isInternal(plugin)) {
-        // Single external plugin: same plugin emits the same value across projects.
-        title = `The ${plugin} plugin infers dependsOn entries using ${phrase}. ${deprecation} please upgrade ${plugin} to a version that doesn't emit this.`;
-        suppressBody = true;
-    }
-    else if (plugin && isInternal(plugin) && file) {
-        // Single hand-authored config file — lead with the file path.
-        title = `${file} defines ${project}:${ownerTarget} with ${n} dependsOn ${word} using ${phrase}. ${deprecation} run 'nx repair' to fix this.`;
-    }
-    else {
-        // Mixed sources or no source-map info — tailor advice to what's offending.
-        const offending = Array.from(new Set(items
-            .filter((i) => i.plugin && !isInternal(i.plugin))
-            .map((i) => i.plugin)));
-        const origin = plugin
-            ? ` (set by ${plugin}${file ? ` in ${file}` : ''})`
-            : '';
-        const advice = offending.length
-            ? `run 'nx repair' for hand-authored entries and upgrade ${offending.join(', ')} for plugin-inferred entries`
-            : `run 'nx repair' to fix`;
-        title = `${project}:${ownerTarget} has ${n} dependsOn ${word} using ${phrase}${origin}. ${deprecation} ${advice}.`;
-    }
-    const bodyLines = suppressBody
-        ? []
-        : items.map((i) => {
-            const src = i.plugin && !plugin
-                ? ` from ${i.plugin}${i.file ? ` in ${i.file}` : ''}`
-                : '';
-            return `  - ${JSON.stringify(i.originalEntry)} (${i.index}${src})`;
-        });
-    output_1.output.warn({ title, bodyLines });
-}
-// Test-only: clears the process-wide dedupe set.
-function __resetForTests() {
-    warned.clear();
-}