gdharness 1.2.22 → 1.2.24

package/build/cli.js

@@ -651,18 +651,18 @@ function engineFlags(given) {
       const setBy = Object.hasOwn(SET_BY_ARGUMENT, flag) ? SET_BY_ARGUMENT[flag] : undefined;
       return {
         ok: false,
-        reason: setBy !== undefined ? `${flag} is set by this tool's own argument, ${setBy}, rather than through engineArgs.` : `${flag} is not one of the engine flags engineArgs takes, which are those that change what the engine logs, draws for debugging, checks on the GPU or how it times frames: ${offered}. A value goes as the next entry, as in ["--fixed-fps", "60"].`
+        reason: setBy !== undefined ? `${flag} is set by this tool's own argument, ${setBy}, rather than through engineArgs.` : `${flag} is not one of the engine flags engineArgs takes, which are those that change what the engine logs, draws for debugging, checks on the GPU or how it times frames, and Movie Maker's --write-movie: ${offered}. A value goes as the next entry, as in ["--fixed-fps", "60"].`
       };
     }
     if (takes === "none") {
       continue;
     }
     const value = given[at + 1];
-    const fits = value !== undefined && (takes === "number" ? /^\d+(?:\.\d+)?$/.test(value) : /^\d+x\d+$/.test(value));
-    if (!fits) {
+    const kind = VALUE_KIND[takes];
+    if (value === undefined || !kind.pattern.test(value)) {
       return {
         ok: false,
-        reason: `${flag} takes ${takes === "number" ? "a number" : "a size such as 1280x720"} as the next entry, and ${value === undefined ? "nothing followed it" : `${JSON.stringify(value)} is not one`}.`
+        reason: `${flag} takes ${kind.named} as the next entry, and ${value === undefined ? "nothing followed it" : `${JSON.stringify(value)} is not one`}.`
       };
     }
     at += 1;
@@ -725,7 +725,7 @@ function environmentFor(options, variables = process.env) {
   const base = options.savesIn === undefined ? { ...variables } : userDataIn(options.savesIn, variables);
   return { ...base, ...options.env, GDHARNESS_RUNTIME_DIR: options.runtimeDirectory };
 }
-var ENGINE_FLAGS, SET_BY_ARGUMENT, OPENED_BY_A_SERVER = "GDHARNESS_OPENED_BY_A_SERVER", EDITOR_PID_VARIABLE = "GDHARNESS_EDITOR_PID", RESERVED_VARIABLE_PREFIX = "GDHARNESS_", SAVES_NOT_MOVED_NOTE = "On macOS the engine reads user:// off HOME and ignores the variables that move it elsewhere, measured on Godot 4.7.2, so this run wrote its saves where the player keeps theirs. A suite that saves a game has written into the same folder as the copy being played, and one that tidies up after itself may have removed real saves.";
+var ENGINE_FLAGS, VALUE_KIND, SET_BY_ARGUMENT, OPENED_BY_A_SERVER = "GDHARNESS_OPENED_BY_A_SERVER", EDITOR_PID_VARIABLE = "GDHARNESS_EDITOR_PID", RESERVED_VARIABLE_PREFIX = "GDHARNESS_", SAVES_NOT_MOVED_NOTE = "On macOS the engine reads user:// off HOME and ignores the variables that move it elsewhere, measured on Godot 4.7.2, so this run wrote its saves where the player keeps theirs. A suite that saves a game has written into the same folder as the copy being played, and one that tidies up after itself may have removed real saves.";
 var init_launch = __esm(() => {
   ENGINE_FLAGS = Object.freeze({
     "--verbose": "none",
@@ -746,8 +746,14 @@ var init_launch = __esm(() => {
     "--time-scale": "number",
     "--fixed-fps": "number",
     "--max-fps": "number",
-    "--resolution": "size"
+    "--resolution": "size",
+    "--write-movie": "file"
   });
+  VALUE_KIND = {
+    number: { pattern: /^\d+(?:\.\d+)?$/, named: "a number" },
+    size: { pattern: /^\d+x\d+$/, named: "a size such as 1280x720" },
+    file: { pattern: /^[^-]/, named: "a file path" }
+  };
   SET_BY_ARGUMENT = Object.freeze({
     "--headless": "headless",
     "--audio-driver": "silent",
@@ -11372,7 +11378,12 @@ var init_tool_definitions = __esm(() => {
         ignore: {
           type: "array",
           items: { type: "string" },
-          description: 'Suites or cases to leave out, as "suite_name" or "suite_name:test_name".'
+          description: 'Suites or cases to leave out, as "suite_name" or "suite_name:test_name". A bare test name is read as a suite name and leaves out nothing; an entry that named a case which ran all the same comes back under ignoreNotApplied with the form that would have left it out.'
+        },
+        engineArgs: {
+          type: "array",
+          items: { type: "string" },
+          description: `The engine's own flags for the run, such as ["--verbose"], a value going as the next entry. Only those that change what the engine logs, draws for debugging, checks on the GPU or how it times frames: ${Object.keys(ENGINE_FLAGS).join(", ")}. Any other is refused. With --verbose, engineEntries holds the ordinary lines the run printed as well, which is where the engine names the instances leaked and the resources still in use at exit.`
         },
         failFast: {
           type: "boolean",
@@ -11422,7 +11433,7 @@ var init_tool_definitions = __esm(() => {
       name: "scene_tree",
       title: "Scene tree",
       effect: "read",
-      description: "The nodes of a scene file: names, classes and hierarchy, with properties when asked. Needs the editor connected.",
+      description: "The nodes of a scene file: names, classes and hierarchy, with properties when asked. Needs the editor connected. For the nodes of a game that is running, runtime_inspect tree, which needs no editor.",
       parameters: {
         projectPath: PROJECT_PATH,
         scenePath: SCENE_PATH,
@@ -11849,7 +11860,7 @@ var init_tool_definitions = __esm(() => {
           type: "array",
           items: { type: "string" },
           ops: ["start", "check"],
-          description: `The engine's own flags, before the separator, such as ["--verbose"] or ["--fixed-fps", "60"], a value going as the next entry. Only those that change what the engine logs, draws for debugging, checks on the GPU or how it times frames: ${Object.keys(ENGINE_FLAGS).join(", ")}. Any other is refused, since the engine's command line can also run scripts, open other projects and write files. A run with any is started by this server, as one with args is. A check given --verbose answers with everything printed rather than only errors and warnings, since what verbose adds, the instances leaked at exit among it, is printed as ordinary lines.`
+          description: `The engine's own flags, before the separator, such as ["--verbose"] or ["--fixed-fps", "60"], a value going as the next entry. Only those that change what the engine logs, draws for debugging, checks on the GPU or how it times frames, and Movie Maker's --write-movie: ${Object.keys(ENGINE_FLAGS).join(", ")}. Any other is refused, since the engine's command line can also run scripts, open other projects and write files. --write-movie takes an absolute path outside the project, in a directory that exists, ending in .avi (one file, video and sound) or .png (one numbered PNG per frame and a .wav beside them), where nothing it would write is there already; it needs a start with headless: false, since the engine crashes writing a movie headless, and it records at the project's editor/movie_writer/fps unless --fixed-fps says otherwise. A run with any is started by this server, as one with args is. A check given --verbose answers with everything printed rather than only errors and warnings, since what verbose adds, the instances leaked at exit among it, is printed as ordinary lines.`
         },
         headless: { type: "boolean", ops: ["start"], description: "start: force a window or no window." },
         visible: {
@@ -39747,6 +39758,23 @@ function count(attributes, name) {
   const value = Number(attributes[name] ?? "0");
   return Number.isFinite(value) ? value : 0;
 }
+function ignoredYetRan(report, ignored) {
+  const found = [];
+  for (const entry of ignored) {
+    const bare = entry.replace("res://", "");
+    const at = bare.lastIndexOf(":");
+    const suiteNamed = at === -1 ? null : bare.slice(0, at);
+    const testNamed = at === -1 ? bare : bare.slice(at + 1);
+    for (const suite of report.suites) {
+      const suiteMatches = suiteNamed === null || suite.name === suiteNamed || (suite.path ?? "").includes(suiteNamed);
+      const ran = suiteMatches ? suite.cases.find((one) => one.name === testNamed) : undefined;
+      if (ran !== undefined) {
+        found.push({ entry, ran: `${suite.name}:${ran.name}` });
+      }
+    }
+  }
+  return found;
+}
 function caseOf(suite, element) {
   const of = (kind) => element.children.filter((child) => child.name === kind).map((child) => {
     const detail = child.text.trim();
@@ -43244,29 +43272,62 @@ function restartUnderway(note, now = Date.now()) {
   return alive(note.byPid) && now - Date.parse(note.quitAt) < editorRestartTimeoutMs() + 30000;
 }
 function captureDestinationRefusal(outputPath, projects) {
-  if (/^(res|user):\/\//.test(outputPath)) {
-    return `outputPath ${outputPath} is a Godot path; a capture is saved outside the project, at an absolute path on this machine.`;
+  return writtenFileRefusal(outputPath, {
+    named: "outputPath",
+    what: "a capture",
+    extensions: [".png"],
+    projects,
+    writes: (where) => [where]
+  });
+}
+function writtenFileRefusal(path, rule) {
+  const { named, what } = rule;
+  if (/^(res|user):\/\//.test(path)) {
+    return `${named} ${path} is a Godot path; ${what} is saved outside the project, at an absolute path on this machine.`;
   }
-  if (!isAbsolute3(outputPath)) {
-    return `outputPath ${outputPath} is not absolute; name the whole path, so where it is written does not depend on this server's directory.`;
+  if (!isAbsolute3(path)) {
+    return `${named} ${path} is not absolute; name the whole path, so where it is written does not depend on this server's directory.`;
   }
-  if (extname3(outputPath).toLowerCase() !== ".png") {
-    return `outputPath ${outputPath} does not end in .png, which is what a capture is.`;
+  if (!rule.extensions.includes(extname3(path).toLowerCase())) {
+    return `${named} ${path} does not end in ${rule.extensions.join(" or ")}, which is what ${what} is.`;
   }
-  const directory = realPathOr(dirname19(outputPath));
+  const directory = realPathOr(dirname19(path));
   if (!existsSync20(directory)) {
-    return `outputPath's directory ${dirname19(outputPath)} does not exist; a capture creates no directories.`;
+    return `${named}'s directory ${dirname19(path)} does not exist; ${what} creates no directories.`;
   }
-  const where = join26(directory, basename7(outputPath));
-  const inside = projects.find((project) => project !== "" && isWithinRoot(realPathOr(project), where));
+  const where = join26(directory, basename7(path));
+  const inside = rule.projects.find((project) => project !== "" && isWithinRoot(realPathOr(project), where));
   if (inside !== undefined) {
-    return `outputPath ${outputPath} is inside the project at ${inside}; a capture is saved outside it, so it never becomes part of the game.`;
+    return `${named} ${path} is inside the project at ${inside}; ${what} is saved outside it, so it never becomes part of the game.`;
   }
-  if (existsSync20(where)) {
-    return `outputPath ${outputPath} already exists; a capture is not written over a file. Name a new one.`;
+  const taken = rule.writes(where).find((file) => existsSync20(file));
+  if (taken !== undefined) {
+    return taken === where ? `${named} ${path} already exists; ${what} is not written over a file. Name a new one.` : `${named} ${path} would write ${taken}, which already exists; ${what} is not written over a file. Name a new one.`;
   }
   return null;
 }
+function movieRefusal(engineArgs, projects, headless) {
+  const at = engineArgs.indexOf("--write-movie");
+  if (at === -1) {
+    return null;
+  }
+  if (headless) {
+    return "--write-movie needs a run that draws, and this one is headless: Movie Maker reads every frame back from the renderer, and the engine crashed on the first frame when asked headless. Start the run with headless: false; it is drawn on a desktop of its own and does not show.";
+  }
+  return writtenFileRefusal(engineArgs[at + 1] ?? "", {
+    named: "--write-movie",
+    what: "a movie",
+    extensions: [".avi", ".png"],
+    projects,
+    writes: (where) => {
+      if (extname3(where).toLowerCase() !== ".png") {
+        return [where];
+      }
+      const base = where.slice(0, -".png".length);
+      return [`${base}00000000.png`, `${base}.wav`];
+    }
+  });
+}
 function captureDetail(payload) {
   const parts = [];
   const region = payload["region"];
@@ -44893,7 +44954,7 @@ class GodotServer {
     const { op: _op, ...arguments_ } = args;
     const bridge = async (command, extra = {}) => {
       const contained = this.containProjectFiles({ ...arguments_, ...extra });
-      return contained.ok ? await this.handleViaBridge(command, contained.value) : contained.response;
+      return contained.ok ? await this.handleViaBridge(command, contained.value, tool) : contained.response;
     };
     switch (tool) {
       case "project_info":
@@ -45899,6 +45960,14 @@ class GodotServer {
     if (!paths.ok) {
       return this.createErrorResponse(paths.reason, PATH_SOLUTIONS);
     }
+    const flags = this.engineArguments(args);
+    if (!flags.ok) {
+      return flags.response;
+    }
+    const movie = movieRefusal(flags.value, [project.value.path], true);
+    if (movie !== null) {
+      return this.createErrorResponse(movie);
+    }
     const missing = paths.value.filter((path) => !existsSync20(join26(project.value.path, path.slice("res://".length))));
     const asked = paths.value.filter((path) => !missing.includes(path));
     const runner = "addons/gdUnit4/bin/GdUnitCmdTool.gd";
@@ -45946,6 +46015,7 @@ class GodotServer {
       "--headless",
       "--path",
       project.value.path,
+      ...flags.value,
       "-s",
       `res://${runner}`,
       "--ignoreHeadlessMode",
@@ -46009,7 +46079,11 @@ class GodotServer {
         rmdirSync2(dirname19(reportsDir));
       } catch {}
     }
-    const engineEntries = foldedRepeats(run.log.select({ severity: "warning", sinceLastCall: false, limit: Number.POSITIVE_INFINITY }).entries.map(aboveTheRunner));
+    const engineEntries = foldedRepeats(run.log.select({
+      severity: flags.value.includes("--verbose") ? "info" : "warning",
+      sinceLastCall: false,
+      limit: Number.POSITIVE_INFINITY
+    }).entries.map(aboveTheRunner));
     const engineEntriesShown = engineEntries.slice(-MOST_ENGINE_ENTRIES);
     const verdicts = {
       0: "passed",
@@ -46120,6 +46194,7 @@ class GodotServer {
     const notRun = report.suites.reduce((sum, suite) => sum + Math.max(0, suite.discovered - suite.tests), 0);
     const uncaughtFolded = foldedRepeats(uncaught.map(aboveTheRunner));
     const listedAsUncaught = new Set(uncaughtFolded.map((entry) => entry.index));
+    const notApplied = ignoredYetRan(report, ignored);
     return this.jsonTextResponse({
       passed: !timedOut && exitCode === 0 && nothingRan === null && report.tests > 0 && report.failures === 0 && report.errors === 0 && hookFailures.length === 0 && uncaught.length === 0 && missing.length === 0,
       verdict,
@@ -46138,11 +46213,13 @@ class GodotServer {
       warnings: warnings.length > 0 ? warnings : undefined,
       orphans: orphans.total > 0 ? orphans.total : undefined,
       notRun: notRun > 0 ? notRun : undefined,
+      ignoreNotApplied: notApplied.length > 0 ? notApplied : undefined,
       ...printedLines,
       savesNote,
       ...scanned,
       note: [
         missingNote,
+        notApplied.length > 0 ? "An ignore entry named a case that ran all the same: gdUnit4 leaves a case out only as suite_name:test_name, and reads an entry with no colon as a suite name or a piece of a suite path. ignoreNotApplied gives the form for each case that ran." : undefined,
         uncaughtNote(uncaught),
         ranAs.startsWith("warnings") && warnings.length === 0 ? "gdUnit4 exits 101 for orphan nodes when nothing failed, and this run printed no count of them: orphan reporting may be off in the project settings." : notRunNote(notRun, readBoolean(args, "failFast") === true)
       ].filter((part) => part !== undefined).join(" ") || undefined,
@@ -47002,6 +47079,10 @@ class GodotServer {
     if (!flags.ok) {
       return flags.response;
     }
+    const movie = movieRefusal(flags.value, [project.value.path], op === "check" || resolveHeadless(args["headless"], { platform: process.platform, variables: process.env }));
+    if (movie !== null) {
+      return this.createErrorResponse(movie);
+    }
     const asked = this.runEnvironment(args);
     if (!asked.ok) {
       return asked.response;
@@ -49101,9 +49182,11 @@ class GodotServer {
     const holds = held["classes"].map(String);
     return { unseen: unseenByEditor(projectPath, holds), stillHeld: heldButGone(projectPath, holds) };
   }
-  async handleViaBridge(toolName, args) {
+  async handleViaBridge(toolName, args, askedAs) {
     if (!this.godotBridge.isConnected()) {
+      const instead = askedAs !== undefined && Object.hasOwn(EDITOR_FREE_INSTEAD, askedAs) ? EDITOR_FREE_INSTEAD[askedAs] : undefined;
       return this.createErrorResponse("Editor not connected: no Godot editor with the gdharness editor addon has reached this server.", [
+        ...instead === undefined ? [] : [instead],
         "Open the project in the editor with editor_launch, or by hand",
         "Enable the addon under Project > Project Settings > Plugins",
         "editor_status says whether the bridge is up and what it is listening on"
@@ -49416,7 +49499,7 @@ async function runGodotServer() {
   const server = new GodotServer;
   await server.run();
 }
-var UPDATE_NOTICE_EVERY = 500, FEEDBACK_NOTICE_EVERY = 250, run4, __dirname2, EDITOR_SERVERS_START_MS = 20000, HOLD_PING_MS = 2000, SLOWEST_FRAME_RATE = 20, PLAY_STARTS_WITHIN_MS = 30000, KEEPER_ANSWER_MS = 15000, EXIT_REPORTED_WITHIN_MS = 2000, CONSOLE_WRAPPER, LONGEST_BOOT_NOTED_MS, PROFILE_SEND_MS = 5000, MOST_GROUPS = 20, RUNTIME_LISTENING_LINE = "[gdharness] runtime listening on ", VALUE_NAMES, BRIDGE_RETRY_MS = 2000, SUCCESSOR_CHECK_MS = 1e4, CONSOLE_WATCH_MS = 250, BOUNDARY_WAIT_MS = 2000, HANDOVER_MS, HANDOVER_POLL_MS = 250, CACHE_WRITE_MS = 2000, STREAMS_GRACE_MS = 2000, PLAYING_STATUS_MS = 1000, SCAN_START_MS = 2000, SCAN_SETTLED_MS = 500, REIMPORT_TIMEOUT_MS = 300000, OPS_ELSEWHERE, AUDIO_BUS_OPS, STALLED_AFTER_MS = 30000, TEST_HEARTBEAT_MS = 20000, DEPENDED_FAILED = "Failed to compile depended scripts", WAIT_FOR_RUN_MS = 600000, RUN_POLL_MS = 250, PATH_SOLUTIONS, PROJECT_FILE_ARGUMENTS, DEBUG_STATE_CALLS, PROJECT_INFO_SECTIONS2, RUNNER_DIRECTORY = "addons/gdUnit4/", PROFILE_FUNCTIONS = 30, PROFILER_ON_MS = 3000, PROPERTY_PLACES = "It is a property, so each place says whether it writes it (access write), which runs its set block, or reads it (access read), which runs its get block: withinCalls on a read says nothing of the set block, nor on a write of the get block unless the write is a compound one such as +=. Inside the property's own blocks its name is the value stored, which the engine reads and writes without running them, so those lines are not listed.", CALLERS_FOUND_BY_NAME = "Found by name in the project's scripts, since the engine's profiler counts calls and time per function and records nothing about who made them: a method of the same name on another class is listed too, unless one class was asked about and it is called through another class by name or through a variable declared as one. Each place carries the profile's numbers for the function it is written in.", MOST_ENGINE_ENTRIES = 200, ERROR_ASSERT = "GdUnitGodotErrorAssertImpl.gd", EXTERNAL_MEMBER = 'Could not resolve external class member "', STATIC_LIST_HINT;
+var UPDATE_NOTICE_EVERY = 500, FEEDBACK_NOTICE_EVERY = 250, run4, __dirname2, EDITOR_SERVERS_START_MS = 20000, HOLD_PING_MS = 2000, SLOWEST_FRAME_RATE = 20, PLAY_STARTS_WITHIN_MS = 30000, KEEPER_ANSWER_MS = 15000, EXIT_REPORTED_WITHIN_MS = 2000, CONSOLE_WRAPPER, LONGEST_BOOT_NOTED_MS, PROFILE_SEND_MS = 5000, MOST_GROUPS = 20, RUNTIME_LISTENING_LINE = "[gdharness] runtime listening on ", VALUE_NAMES, BRIDGE_RETRY_MS = 2000, SUCCESSOR_CHECK_MS = 1e4, CONSOLE_WATCH_MS = 250, BOUNDARY_WAIT_MS = 2000, HANDOVER_MS, HANDOVER_POLL_MS = 250, CACHE_WRITE_MS = 2000, STREAMS_GRACE_MS = 2000, PLAYING_STATUS_MS = 1000, SCAN_START_MS = 2000, SCAN_SETTLED_MS = 500, REIMPORT_TIMEOUT_MS = 300000, EDITOR_FREE_INSTEAD, OPS_ELSEWHERE, AUDIO_BUS_OPS, STALLED_AFTER_MS = 30000, TEST_HEARTBEAT_MS = 20000, DEPENDED_FAILED = "Failed to compile depended scripts", WAIT_FOR_RUN_MS = 600000, RUN_POLL_MS = 250, PATH_SOLUTIONS, PROJECT_FILE_ARGUMENTS, DEBUG_STATE_CALLS, PROJECT_INFO_SECTIONS2, RUNNER_DIRECTORY = "addons/gdUnit4/", PROFILE_FUNCTIONS = 30, PROFILER_ON_MS = 3000, PROPERTY_PLACES = "It is a property, so each place says whether it writes it (access write), which runs its set block, or reads it (access read), which runs its get block: withinCalls on a read says nothing of the set block, nor on a write of the get block unless the write is a compound one such as +=. Inside the property's own blocks its name is the value stored, which the engine reads and writes without running them, so those lines are not listed.", CALLERS_FOUND_BY_NAME = "Found by name in the project's scripts, since the engine's profiler counts calls and time per function and records nothing about who made them: a method of the same name on another class is listed too, unless one class was asked about and it is called through another class by name or through a variable declared as one. Each place carries the profile's numbers for the function it is written in.", MOST_ENGINE_ENTRIES = 200, ERROR_ASSERT = "GdUnitGodotErrorAssertImpl.gd", EXTERNAL_MEMBER = 'Could not resolve external class member "', STATIC_LIST_HINT;
 var init_server = __esm(() => {
   init_dist();
   init_stdio();
@@ -49480,6 +49563,9 @@ var init_server = __esm(() => {
     object: "an object"
   };
   HANDOVER_MS = SUCCESSOR_CHECK_MS + 5000;
+  EDITOR_FREE_INSTEAD = {
+    scene_tree: "runtime_inspect tree reads the nodes of a game that is running, and needs no editor; scene_tree reads a scene file through the editor"
+  };
   OPS_ELSEWHERE = {
     runtime_invoke: { get: "runtime_inspect property", property: "runtime_inspect property" }
   };

package/build/godot/operations/dependencies.gd

@@ -284,6 +284,15 @@ static func _code_of(line: String) -> String:
 	return bare if mark == -1 else bare.substr(0, mark)
 
 
+# [param content] with each line's comment taken off and its strings kept, which is where the paths
+# a script loads are written.
+static func _code_lines(content: String) -> String:
+	var kept: Array[String] = []
+	for line: String in content.split("\n"):
+		kept.append(Patterns.without_comment(line))
+	return "\n".join(kept)
+
+
 # The comment on [param line], strings emptied first so a # inside one does not start it.
 static func _comment_of(line: String) -> String:
 	var bare: String = Patterns.compiled(STRING_LITERAL).sub(line, '""', true)
@@ -361,6 +370,11 @@ func _analyze_resource(path: String, current_depth: int, walk: DependencyWalk) -
 	if file:
 		var content: String = file.get_as_text()
 		file.close()
+		# A script's comments name paths as examples, and read as references they were answered as
+		# dependencies, one of a file that does not exist: the shipped serialisation module's comment
+		# about `["res://addons/x/plugin.cfg"]` was a dependency of every project with the addon.
+		if path.get_extension() == "gd":
+			content = _code_lines(content)
 
 		for pattern: String in REFERENCE_PATTERNS:
 			var regex: RegEx = Patterns.compiled(pattern)

package/build/godot/operations/gdscript_analysis.gd

@@ -59,7 +59,7 @@ func get_gdscript_info(params: Dictionary) -> Dictionary:
 			if _triple_quotes(raw) % 2 == 1:
 				in_multiline_string = false
 			continue
-		var stripped: String = _without_comment(raw)
+		var stripped: String = Patterns.without_comment(raw)
 
 		if stripped.is_empty():
 			continue
@@ -101,7 +101,7 @@ func get_gdscript_info(params: Dictionary) -> Dictionary:
 		if _can_wrap(header):
 			while _bracket_depth(stripped) > 0 and i + 1 < lines.size():
 				i += 1
-				stripped = (stripped + " " + _without_comment(lines[i])).strip_edges()
+				stripped = (stripped + " " + Patterns.without_comment(lines[i])).strip_edges()
 			header = Patterns.without_annotations(stripped)
 		var declaration: RegExMatch = Patterns.declared_class(header)
 		if declaration != null:
@@ -508,28 +508,6 @@ func _up_to(text: String, needle: String) -> String:
 	return text
 
 
-# The line with any trailing comment taken off, quote-aware so a `#` inside a string stays.
-#
-# The only one of these scanners that does not count brackets, on purpose: a `#` starts a comment
-# wherever it is, and there is no depth at which it does not. Giving this one the depth its
-# neighbours have puts the comment into the value of `var table := {  # keyed by name`, because the
-# brace opens before the `#` and closes on a later line. Held by a case, since the argument for the
-# difference is not visible from the code and reads like an oversight beside its neighbours.
-func _without_comment(line: String) -> String:
-	var quote: String = ""
-	for i: int in range(line.length()):
-		var ch: String = line[i]
-		if not quote.is_empty():
-			if ch == quote and line[i - 1] != "\\":
-				quote = ""
-			continue
-		if ch == "#":
-			return line.substr(0, i).strip_edges()
-		if ch == '"' or ch == "'":
-			quote = ch
-	return line.strip_edges()
-
-
 # Where the bracket opened at [from] closes, or -1 if it does not.
 #
 # `rfind(")")` took the last one on the line, which is the right answer until something after the

package/build/godot/operations/patterns.gd

@@ -84,3 +84,25 @@ static func without_annotations(line: String) -> String:
 		rest = rest.substr(found.get_end()).strip_edges()
 		found = annotation.search(rest)
 	return rest
+
+
+# The line with any trailing comment taken off, quote-aware so a `#` inside a string stays.
+#
+# The only one of the scanners here that does not count brackets, on purpose: a `#` starts a comment
+# wherever it is, and there is no depth at which it does not. Giving this one the depth its
+# neighbours have puts the comment into the value of `var table := {  # keyed by name`, because the
+# brace opens before the `#` and closes on a later line. Held by a case, since the argument for the
+# difference is not visible from the code and reads like an oversight beside its neighbours.
+static func without_comment(line: String) -> String:
+	var quote: String = ""
+	for i: int in range(line.length()):
+		var ch: String = line[i]
+		if not quote.is_empty():
+			if ch == quote and line[i - 1] != "\\":
+				quote = ""
+			continue
+		if ch == "#":
+			return line.substr(0, i).strip_edges()
+		if ch == '"' or ch == "'":
+			quote = ch
+	return line.strip_edges()

package/build/index.js

@@ -24932,8 +24932,14 @@ var ENGINE_FLAGS = Object.freeze({
   "--time-scale": "number",
   "--fixed-fps": "number",
   "--max-fps": "number",
-  "--resolution": "size"
+  "--resolution": "size",
+  "--write-movie": "file"
 });
+var VALUE_KIND = {
+  number: { pattern: /^\d+(?:\.\d+)?$/, named: "a number" },
+  size: { pattern: /^\d+x\d+$/, named: "a size such as 1280x720" },
+  file: { pattern: /^[^-]/, named: "a file path" }
+};
 var SET_BY_ARGUMENT = Object.freeze({
   "--headless": "headless",
   "--audio-driver": "silent",
@@ -24948,18 +24954,18 @@ function engineFlags(given) {
       const setBy = Object.hasOwn(SET_BY_ARGUMENT, flag) ? SET_BY_ARGUMENT[flag] : undefined;
       return {
         ok: false,
-        reason: setBy !== undefined ? `${flag} is set by this tool's own argument, ${setBy}, rather than through engineArgs.` : `${flag} is not one of the engine flags engineArgs takes, which are those that change what the engine logs, draws for debugging, checks on the GPU or how it times frames: ${offered}. A value goes as the next entry, as in ["--fixed-fps", "60"].`
+        reason: setBy !== undefined ? `${flag} is set by this tool's own argument, ${setBy}, rather than through engineArgs.` : `${flag} is not one of the engine flags engineArgs takes, which are those that change what the engine logs, draws for debugging, checks on the GPU or how it times frames, and Movie Maker's --write-movie: ${offered}. A value goes as the next entry, as in ["--fixed-fps", "60"].`
       };
     }
     if (takes === "none") {
       continue;
     }
     const value = given[at + 1];
-    const fits = value !== undefined && (takes === "number" ? /^\d+(?:\.\d+)?$/.test(value) : /^\d+x\d+$/.test(value));
-    if (!fits) {
+    const kind = VALUE_KIND[takes];
+    if (value === undefined || !kind.pattern.test(value)) {
       return {
         ok: false,
-        reason: `${flag} takes ${takes === "number" ? "a number" : "a size such as 1280x720"} as the next entry, and ${value === undefined ? "nothing followed it" : `${JSON.stringify(value)} is not one`}.`
+        reason: `${flag} takes ${kind.named} as the next entry, and ${value === undefined ? "nothing followed it" : `${JSON.stringify(value)} is not one`}.`
       };
     }
     at += 1;
@@ -29963,6 +29969,23 @@ function count(attributes, name) {
   const value = Number(attributes[name] ?? "0");
   return Number.isFinite(value) ? value : 0;
 }
+function ignoredYetRan(report, ignored) {
+  const found = [];
+  for (const entry of ignored) {
+    const bare = entry.replace("res://", "");
+    const at = bare.lastIndexOf(":");
+    const suiteNamed = at === -1 ? null : bare.slice(0, at);
+    const testNamed = at === -1 ? bare : bare.slice(at + 1);
+    for (const suite of report.suites) {
+      const suiteMatches = suiteNamed === null || suite.name === suiteNamed || (suite.path ?? "").includes(suiteNamed);
+      const ran = suiteMatches ? suite.cases.find((one) => one.name === testNamed) : undefined;
+      if (ran !== undefined) {
+        found.push({ entry, ran: `${suite.name}:${ran.name}` });
+      }
+    }
+  }
+  return found;
+}
 function caseOf(suite, element) {
   const of = (kind) => element.children.filter((child) => child.name === kind).map((child) => {
     const detail = child.text.trim();
@@ -34404,7 +34427,12 @@ var TOOL_SPECS = [
       ignore: {
         type: "array",
         items: { type: "string" },
-        description: 'Suites or cases to leave out, as "suite_name" or "suite_name:test_name".'
+        description: 'Suites or cases to leave out, as "suite_name" or "suite_name:test_name". A bare test name is read as a suite name and leaves out nothing; an entry that named a case which ran all the same comes back under ignoreNotApplied with the form that would have left it out.'
+      },
+      engineArgs: {
+        type: "array",
+        items: { type: "string" },
+        description: `The engine's own flags for the run, such as ["--verbose"], a value going as the next entry. Only those that change what the engine logs, draws for debugging, checks on the GPU or how it times frames: ${Object.keys(ENGINE_FLAGS).join(", ")}. Any other is refused. With --verbose, engineEntries holds the ordinary lines the run printed as well, which is where the engine names the instances leaked and the resources still in use at exit.`
       },
       failFast: {
         type: "boolean",
@@ -34454,7 +34482,7 @@ var TOOL_SPECS = [
     name: "scene_tree",
     title: "Scene tree",
     effect: "read",
-    description: "The nodes of a scene file: names, classes and hierarchy, with properties when asked. Needs the editor connected.",
+    description: "The nodes of a scene file: names, classes and hierarchy, with properties when asked. Needs the editor connected. For the nodes of a game that is running, runtime_inspect tree, which needs no editor.",
     parameters: {
       projectPath: PROJECT_PATH2,
       scenePath: SCENE_PATH,
@@ -34881,7 +34909,7 @@ var TOOL_SPECS = [
         type: "array",
         items: { type: "string" },
         ops: ["start", "check"],
-        description: `The engine's own flags, before the separator, such as ["--verbose"] or ["--fixed-fps", "60"], a value going as the next entry. Only those that change what the engine logs, draws for debugging, checks on the GPU or how it times frames: ${Object.keys(ENGINE_FLAGS).join(", ")}. Any other is refused, since the engine's command line can also run scripts, open other projects and write files. A run with any is started by this server, as one with args is. A check given --verbose answers with everything printed rather than only errors and warnings, since what verbose adds, the instances leaked at exit among it, is printed as ordinary lines.`
+        description: `The engine's own flags, before the separator, such as ["--verbose"] or ["--fixed-fps", "60"], a value going as the next entry. Only those that change what the engine logs, draws for debugging, checks on the GPU or how it times frames, and Movie Maker's --write-movie: ${Object.keys(ENGINE_FLAGS).join(", ")}. Any other is refused, since the engine's command line can also run scripts, open other projects and write files. --write-movie takes an absolute path outside the project, in a directory that exists, ending in .avi (one file, video and sound) or .png (one numbered PNG per frame and a .wav beside them), where nothing it would write is there already; it needs a start with headless: false, since the engine crashes writing a movie headless, and it records at the project's editor/movie_writer/fps unless --fixed-fps says otherwise. A run with any is started by this server, as one with args is. A check given --verbose answers with everything printed rather than only errors and warnings, since what verbose adds, the instances leaked at exit among it, is printed as ordinary lines.`
       },
       headless: { type: "boolean", ops: ["start"], description: "start: force a window or no window." },
       visible: {
@@ -35911,29 +35939,62 @@ function restartUnderway(note, now = Date.now()) {
 var HOLD_PING_MS = 2000;
 var SLOWEST_FRAME_RATE = 20;
 function captureDestinationRefusal(outputPath, projects) {
-  if (/^(res|user):\/\//.test(outputPath)) {
-    return `outputPath ${outputPath} is a Godot path; a capture is saved outside the project, at an absolute path on this machine.`;
+  return writtenFileRefusal(outputPath, {
+    named: "outputPath",
+    what: "a capture",
+    extensions: [".png"],
+    projects,
+    writes: (where) => [where]
+  });
+}
+function writtenFileRefusal(path, rule) {
+  const { named, what } = rule;
+  if (/^(res|user):\/\//.test(path)) {
+    return `${named} ${path} is a Godot path; ${what} is saved outside the project, at an absolute path on this machine.`;
   }
-  if (!isAbsolute3(outputPath)) {
-    return `outputPath ${outputPath} is not absolute; name the whole path, so where it is written does not depend on this server's directory.`;
+  if (!isAbsolute3(path)) {
+    return `${named} ${path} is not absolute; name the whole path, so where it is written does not depend on this server's directory.`;
   }
-  if (extname3(outputPath).toLowerCase() !== ".png") {
-    return `outputPath ${outputPath} does not end in .png, which is what a capture is.`;
+  if (!rule.extensions.includes(extname3(path).toLowerCase())) {
+    return `${named} ${path} does not end in ${rule.extensions.join(" or ")}, which is what ${what} is.`;
   }
-  const directory = realPathOr(dirname15(outputPath));
+  const directory = realPathOr(dirname15(path));
   if (!existsSync17(directory)) {
-    return `outputPath's directory ${dirname15(outputPath)} does not exist; a capture creates no directories.`;
+    return `${named}'s directory ${dirname15(path)} does not exist; ${what} creates no directories.`;
   }
-  const where = join22(directory, basename5(outputPath));
-  const inside = projects.find((project) => project !== "" && isWithinRoot(realPathOr(project), where));
+  const where = join22(directory, basename5(path));
+  const inside = rule.projects.find((project) => project !== "" && isWithinRoot(realPathOr(project), where));
   if (inside !== undefined) {
-    return `outputPath ${outputPath} is inside the project at ${inside}; a capture is saved outside it, so it never becomes part of the game.`;
+    return `${named} ${path} is inside the project at ${inside}; ${what} is saved outside it, so it never becomes part of the game.`;
   }
-  if (existsSync17(where)) {
-    return `outputPath ${outputPath} already exists; a capture is not written over a file. Name a new one.`;
+  const taken = rule.writes(where).find((file) => existsSync17(file));
+  if (taken !== undefined) {
+    return taken === where ? `${named} ${path} already exists; ${what} is not written over a file. Name a new one.` : `${named} ${path} would write ${taken}, which already exists; ${what} is not written over a file. Name a new one.`;
   }
   return null;
 }
+function movieRefusal(engineArgs, projects, headless) {
+  const at = engineArgs.indexOf("--write-movie");
+  if (at === -1) {
+    return null;
+  }
+  if (headless) {
+    return "--write-movie needs a run that draws, and this one is headless: Movie Maker reads every frame back from the renderer, and the engine crashed on the first frame when asked headless. Start the run with headless: false; it is drawn on a desktop of its own and does not show.";
+  }
+  return writtenFileRefusal(engineArgs[at + 1] ?? "", {
+    named: "--write-movie",
+    what: "a movie",
+    extensions: [".avi", ".png"],
+    projects,
+    writes: (where) => {
+      if (extname3(where).toLowerCase() !== ".png") {
+        return [where];
+      }
+      const base = where.slice(0, -".png".length);
+      return [`${base}00000000.png`, `${base}.wav`];
+    }
+  });
+}
 function captureDetail(payload) {
   const parts = [];
   const region = payload["region"];
@@ -36448,6 +36509,9 @@ function engineFlagsNote(args) {
   const named = among.join(", ");
   return `${named} ${among.length === 1 ? "is a flag" : "are flags"} the engine reads, and args goes to the game after --, where the engine does not read ${among.length === 1 ? "it" : "them"}. engineArgs hands the engine its own flags; ${among.length === 1 ? "leave it" : "leave them"} in args only for a game that reads ${among.length === 1 ? "that flag" : "those flags"} itself.`;
 }
+var EDITOR_FREE_INSTEAD = {
+  scene_tree: "runtime_inspect tree reads the nodes of a game that is running, and needs no editor; scene_tree reads a scene file through the editor"
+};
 var OPS_ELSEWHERE = {
   runtime_invoke: { get: "runtime_inspect property", property: "runtime_inspect property" }
 };
@@ -37638,7 +37702,7 @@ class GodotServer {
     const { op: _op, ...arguments_ } = args;
     const bridge = async (command, extra = {}) => {
       const contained = this.containProjectFiles({ ...arguments_, ...extra });
-      return contained.ok ? await this.handleViaBridge(command, contained.value) : contained.response;
+      return contained.ok ? await this.handleViaBridge(command, contained.value, tool) : contained.response;
     };
     switch (tool) {
       case "project_info":
@@ -38644,6 +38708,14 @@ class GodotServer {
     if (!paths.ok) {
       return this.createErrorResponse(paths.reason, PATH_SOLUTIONS);
     }
+    const flags = this.engineArguments(args);
+    if (!flags.ok) {
+      return flags.response;
+    }
+    const movie = movieRefusal(flags.value, [project.value.path], true);
+    if (movie !== null) {
+      return this.createErrorResponse(movie);
+    }
     const missing = paths.value.filter((path) => !existsSync17(join22(project.value.path, path.slice("res://".length))));
     const asked = paths.value.filter((path) => !missing.includes(path));
     const runner = "addons/gdUnit4/bin/GdUnitCmdTool.gd";
@@ -38691,6 +38763,7 @@ class GodotServer {
       "--headless",
       "--path",
       project.value.path,
+      ...flags.value,
       "-s",
       `res://${runner}`,
       "--ignoreHeadlessMode",
@@ -38754,7 +38827,11 @@ class GodotServer {
         rmdirSync2(dirname15(reportsDir));
       } catch {}
     }
-    const engineEntries = foldedRepeats(run.log.select({ severity: "warning", sinceLastCall: false, limit: Number.POSITIVE_INFINITY }).entries.map(aboveTheRunner));
+    const engineEntries = foldedRepeats(run.log.select({
+      severity: flags.value.includes("--verbose") ? "info" : "warning",
+      sinceLastCall: false,
+      limit: Number.POSITIVE_INFINITY
+    }).entries.map(aboveTheRunner));
     const engineEntriesShown = engineEntries.slice(-MOST_ENGINE_ENTRIES);
     const verdicts = {
       0: "passed",
@@ -38865,6 +38942,7 @@ class GodotServer {
     const notRun = report.suites.reduce((sum, suite) => sum + Math.max(0, suite.discovered - suite.tests), 0);
     const uncaughtFolded = foldedRepeats(uncaught.map(aboveTheRunner));
     const listedAsUncaught = new Set(uncaughtFolded.map((entry) => entry.index));
+    const notApplied = ignoredYetRan(report, ignored);
     return this.jsonTextResponse({
       passed: !timedOut && exitCode === 0 && nothingRan === null && report.tests > 0 && report.failures === 0 && report.errors === 0 && hookFailures.length === 0 && uncaught.length === 0 && missing.length === 0,
       verdict,
@@ -38883,11 +38961,13 @@ class GodotServer {
       warnings: warnings.length > 0 ? warnings : undefined,
       orphans: orphans.total > 0 ? orphans.total : undefined,
       notRun: notRun > 0 ? notRun : undefined,
+      ignoreNotApplied: notApplied.length > 0 ? notApplied : undefined,
       ...printedLines,
       savesNote,
       ...scanned,
       note: [
         missingNote,
+        notApplied.length > 0 ? "An ignore entry named a case that ran all the same: gdUnit4 leaves a case out only as suite_name:test_name, and reads an entry with no colon as a suite name or a piece of a suite path. ignoreNotApplied gives the form for each case that ran." : undefined,
         uncaughtNote(uncaught),
         ranAs.startsWith("warnings") && warnings.length === 0 ? "gdUnit4 exits 101 for orphan nodes when nothing failed, and this run printed no count of them: orphan reporting may be off in the project settings." : notRunNote(notRun, readBoolean(args, "failFast") === true)
       ].filter((part) => part !== undefined).join(" ") || undefined,
@@ -39747,6 +39827,10 @@ class GodotServer {
     if (!flags.ok) {
       return flags.response;
     }
+    const movie = movieRefusal(flags.value, [project.value.path], op === "check" || resolveHeadless(args["headless"], { platform: process.platform, variables: process.env }));
+    if (movie !== null) {
+      return this.createErrorResponse(movie);
+    }
     const asked = this.runEnvironment(args);
     if (!asked.ok) {
       return asked.response;
@@ -41846,9 +41930,11 @@ class GodotServer {
     const holds = held["classes"].map(String);
     return { unseen: unseenByEditor(projectPath, holds), stillHeld: heldButGone(projectPath, holds) };
   }
-  async handleViaBridge(toolName, args) {
+  async handleViaBridge(toolName, args, askedAs) {
     if (!this.godotBridge.isConnected()) {
+      const instead = askedAs !== undefined && Object.hasOwn(EDITOR_FREE_INSTEAD, askedAs) ? EDITOR_FREE_INSTEAD[askedAs] : undefined;
       return this.createErrorResponse("Editor not connected: no Godot editor with the gdharness editor addon has reached this server.", [
+        ...instead === undefined ? [] : [instead],
         "Open the project in the editor with editor_launch, or by hand",
         "Enable the addon under Project > Project Settings > Plugins",
         "editor_status says whether the bridge is up and what it is listening on"

package/build/keeper.js

@@ -382,7 +382,8 @@ var ENGINE_FLAGS = Object.freeze({
   "--time-scale": "number",
   "--fixed-fps": "number",
   "--max-fps": "number",
-  "--resolution": "size"
+  "--resolution": "size",
+  "--write-movie": "file"
 });
 var SET_BY_ARGUMENT = Object.freeze({
   "--headless": "headless",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gdharness",
-  "version": "1.2.22",
+  "version": "1.2.24",
   "mcpName": "io.github.Aureliolo/gdharness",
   "description": "A harness for driving a Godot 4 project from an agent: editor addons, a runtime bridge into the running game, an MCP server in front of them, and a CLI that installs and diagnoses the Godot side.",
   "type": "module",