Update changelog

Also fix a bug where --watch would sometimes exit unexpectedly

Author: Gerrit0

CHANGELOG.md

@@ -8,6 +8,8 @@ title: Changelog
 
 -   `@includeCode` and `@inline` can now inject parts of files using region
     names or line numbers, #2816.
+-   Improved TypeDoc's `--watch` option to support watching files not caught by
+    TypeScript's watch mode, #2675.
 -   The `@inline` tag now works in more places for generic types.
 
 ### Bug Fixes
@@ -19,7 +21,9 @@ title: Changelog
 
 ### Thanks!
 
+-   @pjeby
 -   @shawninder
+-   @tats-u
 
 ## v0.27.6 (2024-12-26)
 

bin/typedoc

@@ -8,8 +8,16 @@ function main() {
         stdio: "inherit",
     }).on("exit", (code) => {
         // Watch restart required? Fork a new child
-        if (code === 7) main();
-        else process.exit(code || 0);
+        if (code === 7) {
+            // Set an environment variable to ensure we continue watching
+            // Otherwise, the watch might stop unexpectedly if the watch
+            // option was set in a config file originally, and change to false
+            // later, causing a restart
+            process.env["TYPEDOC_FORCE_WATCH"] = "1";
+            main();
+        } else {
+            process.exit(code || 0);
+        }
     });
 }
 

site/options/other.md

@@ -18,6 +18,8 @@ configuration files, files imported by `@include`/`@includeCode`, and any
 files explicitly registered by plugins as needing to be watched, as well
 as all your TypeScript source files.
 
+Watch mode is not supported with `entryPointStrategy` set to `packages` or `merge`.
+
 ## preserveWatchOutput
 
 ```bash

src/lib/cli.ts

@@ -72,13 +72,13 @@ async function run(app: td.Application) {
         return ExitCodes.OptionError;
     }
 
-    if (app.options.getValue("watch")) {
-        return (await app.convertAndWatch(async (project) => {
+    if (app.options.getValue("watch") || process.env["TYPEDOC_FORCE_WATCH"]) {
+        const continueWatching = await app.convertAndWatch(async (project) => {
             app.validate(project);
             await app.generateOutputs(project);
-        }))
-            ? ExitCodes.Watching
-            : ExitCodes.OptionError;
+        });
+
+        return continueWatching ? ExitCodes.Watching : ExitCodes.OptionError;
     }
 
     const project = await app.convert();