Expose Converter.parseRawComment

Closes #2004
TypeStrong · Jul 17, 2022 · 70ab81a · 70ab81a
1 parent e13a8f7
commit 70ab81a
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ### Features
 
 -   Added support for `*.ghe.com` and `*.github.us` GitHub enterprise domains for source links, #2001.
+-   Expose `Converter.parseRawComment` for plugins to parse additional markdown files, #2004.
 
 ### Thanks!
 

diff --git a/src/lib/converter/converter.ts b/src/lib/converter/converter.ts
@@ -183,6 +183,18 @@ export class Converter extends ChildableComponent<
         return convertType(context, node);
     }
 
+    /**
+     * Parse the given file into a comment. Intended to be used with markdown files.
+     */
+    parseRawComment(file: MinimalSourceFile) {
+        return parseComment(
+            lexCommentString(file.text),
+            this.config,
+            file,
+            this.application.logger
+        );
+    }
+
     /**
      * Compile the files within the given context and convert the compiler symbols to reflections.
      *
@@ -264,11 +276,8 @@ export class Converter extends ChildableComponent<
 
             if (entryPoint.readmeFile) {
                 const readme = readFile(entryPoint.readmeFile);
-                const comment = parseComment(
-                    lexCommentString(readme),
-                    context.converter.config,
-                    new MinimalSourceFile(readme, entryPoint.readmeFile),
-                    context.logger
+                const comment = this.parseRawComment(
+                    new MinimalSourceFile(readme, entryPoint.readmeFile)
                 );
 
                 if (comment.blockTags.length || comment.modifierTags.size) {

diff --git a/src/lib/converter/plugins/PackagePlugin.ts b/src/lib/converter/plugins/PackagePlugin.ts
@@ -7,8 +7,6 @@ import type { Context } from "../context";
 import { BindOption, EntryPointStrategy, readFile } from "../../utils";
 import { getCommonDirectory } from "../../utils/fs";
 import { nicePath } from "../../utils/paths";
-import { lexCommentString } from "../comments/rawLexer";
-import { parseComment } from "../comments/parser";
 import { MinimalSourceFile } from "../../utils/minimalSourceFile";
 
 /**
@@ -105,11 +103,8 @@ export class PackagePlugin extends ConverterComponent {
         const project = context.project;
         if (this.readmeFile) {
             const readme = readFile(this.readmeFile);
-            const comment = parseComment(
-                lexCommentString(readme),
-                context.converter.config,
-                new MinimalSourceFile(readme, this.readmeFile),
-                context.logger
+            const comment = context.converter.parseRawComment(
+                new MinimalSourceFile(readme, this.readmeFile)
             );
 
             if (comment.blockTags.length || comment.modifierTags.size) {