Support @include in readme file

Ref: #2814
TypeStrong · Dec 18, 2024 · 4f518a6 · 4f518a6
1 parent 8244925
commit 4f518a6
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ title: Changelog
 
 ## Unreleased
 
+### Bug Fixes
+
+-   `@include` and `@includeCode` now work in the readme file, #2814.
+
 ## v0.27.5 (2024-12-14)
 
 ### Bug Fixes

diff --git a/src/lib/converter/converter.ts b/src/lib/converter/converter.ts
@@ -248,6 +248,9 @@ export class Converter extends AbstractComponent<Application, ConverterEvents> {
      */
     static readonly EVENT_RESOLVE_END = ConverterEvents.RESOLVE_END;
 
+    /** @internal @hidden */
+    includePlugin: IncludePlugin;
+
     constructor(owner: Application) {
         super(owner);
 
@@ -304,7 +307,7 @@ export class Converter extends AbstractComponent<Application, ConverterEvents> {
         new PackagePlugin(this);
         new SourcePlugin(this);
         new TypePlugin(this);
-        new IncludePlugin(this);
+        this.includePlugin = new IncludePlugin(this);
         new MergeModuleWithPlugin(this);
     }
 

diff --git a/src/lib/converter/plugins/IncludePlugin.ts b/src/lib/converter/plugins/IncludePlugin.ts
@@ -46,7 +46,7 @@ export class IncludePlugin extends ConverterComponent {
         }
     }
 
-    private checkIncludeTagsParts(
+    checkIncludeTagsParts(
         refl: Reflection,
         relative: string,
         parts: CommentDisplayPart[],

diff --git a/src/lib/converter/plugins/PackagePlugin.ts b/src/lib/converter/plugins/PackagePlugin.ts
@@ -135,6 +135,14 @@ export class PackagePlugin extends ConverterComponent {
             );
 
             project.readme = content;
+
+            // This isn't ideal, but seems better than figuring out the readme
+            // path over in the include plugin...
+            this.owner.includePlugin.checkIncludeTagsParts(
+                project,
+                Path.dirname(this.readmeFile),
+                content,
+            );
         }
 
         if (this.packageJson) {