fix(core): expose comments to reflections with the accessor keyword (#…

…664)
typedoc2md · Aug 8, 2024 · 2e1ef74 · 2e1ef74
1 parent d22ab49
commit 2e1ef74
Show file tree

Hide file tree

Showing 9 changed files with 100 additions and 2 deletions.
diff --git a/.changeset/flat-grapes-cheer.md b/.changeset/flat-grapes-cheer.md
@@ -0,0 +1,5 @@
+---
+'typedoc-plugin-markdown': patch
+---
+
+- Expose comments to reflections with the accessor keyword (#664)
diff --git a/devtools/packages/fixtures/cli.ts b/devtools/packages/fixtures/cli.ts
@@ -118,7 +118,7 @@ export function writeHtml(key: string, entryPoints: string[]) {
         '-options',
         path.join(__dirname, 'typedoc.cjs'),
         '-logLevel',
-        'Warn',
+        'None',
         '-out',
         fullPath,
         '-readme',

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts
@@ -88,7 +88,11 @@ export function comment(
     const tags = blockTags
       .filter((tag) => !filteredBlockTags.includes(tag.tag))
       .filter((tag) => {
-        if (!opts.isTableColumn && blockTagsPreserveOrder.length) {
+        if (
+          !opts.isTableColumn &&
+          !(opts.showSummary && opts.showTags) &&
+          blockTagsPreserveOrder.length
+        ) {
           return opts.showSummary
             ? blockTagsPreserveOrder.includes(tag.tag)
             : !blockTagsPreserveOrder.includes(tag.tag);

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts
@@ -60,6 +60,14 @@ export function accessor(
     );
   }
 
+  if (model.comment?.blockTags?.length) {
+    md.push(
+      this.partials.comment(model.comment, {
+        headingLevel: options.headingLevel,
+      }),
+    );
+  }
+
   md.push(
     this.partials.inheritance(model, { headingLevel: options.headingLevel }),
   );

diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/classes.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/classes.ts
@@ -262,3 +262,23 @@ export class ClassWithoutPropCategories {
   method1(): void {}
   method2(): void {}
 }
+
+export class ClassWithAccessorKeywords {
+  /**
+   * Accessor comments
+   *
+   * @example
+   * ```ts
+   * const x = 1;
+   * ```
+   */
+
+  public accessor accessor1: string;
+
+  /**
+   * Accessor comments
+   *
+   * @remarks Remark comments
+   */
+  public accessor accessor2: string;
+}
diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap
@@ -4083,6 +4083,11 @@ exports[`Navigation should gets Navigation Json for single entry point: (Output
         "kind": 128,
         "path": "classes/ChildClassB.md"
       },
+      {
+        "title": "ClassWithAccessorKeywords",
+        "kind": 128,
+        "path": "classes/ClassWithAccessorKeywords.md"
+      },
       {
         "title": "ClassWithAccessors",
         "kind": 128,

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap
@@ -182,6 +182,51 @@ Comments for method
 "
 `;
 
+exports[`Class Reflection should compile class with accessor keywords: (Output File Strategy "members") (Option Group "1") 1`] = `
+"# Class: ClassWithAccessorKeywords
+
+## Constructors
+
+### new ClassWithAccessorKeywords()
+
+> **new ClassWithAccessorKeywords**(): [\`ClassWithAccessorKeywords\`](ClassWithAccessorKeywords.md)
+
+#### Returns
+
+[\`ClassWithAccessorKeywords\`](ClassWithAccessorKeywords.md)
+
+## Accessors
+
+### accessor1
+
+Accessor comments
+
+#### Example
+
+\`\`\`ts
+const x = 1;
+\`\`\`
+
+#### Source
+
+[classes.ts:1](http://source-url)
+
+***
+
+### accessor2
+
+Accessor comments
+
+#### Remarks
+
+Remark comments
+
+#### Source
+
+[classes.ts:1](http://source-url)
+"
+`;
+
 exports[`Class Reflection should compile class with accessors: (Output File Strategy "members") (Option Group "1") 1`] = `
 "# Class: ClassWithAccessors
 

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/urls.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/urls.spec.ts.snap
@@ -781,6 +781,7 @@ exports[`Urls should gets Urls for single entry points: outputFileStrategy: memb
   "classes/CallbacksOptions.md",
   "classes/ChildClassA.md",
   "classes/ChildClassB.md",
+  "classes/ClassWithAccessorKeywords.md",
   "classes/ClassWithAccessors.md",
   "classes/ClassWithComplexProps.md",
   "classes/ClassWithConstructorOverloads.md",
@@ -861,6 +862,7 @@ exports[`Urls should gets Urls for single entry points: outputFileStrategy: memb
   "classes/CallbacksOptions.md",
   "classes/ChildClassA.md",
   "classes/ChildClassB.md",
+  "classes/ClassWithAccessorKeywords.md",
   "classes/ClassWithAccessors.md",
   "classes/ClassWithComplexProps.md",
   "classes/ClassWithConstructorOverloads.md",

diff --git a/packages/typedoc-plugin-markdown/test/specs/reflection.class.spec.ts b/packages/typedoc-plugin-markdown/test/specs/reflection.class.spec.ts
@@ -117,4 +117,13 @@ describe(`Class Reflection`, () => {
       1,
     );
   });
+
+  test(`should compile class with accessor keywords`, () => {
+    expectFileToEqual(
+      'reflections',
+      'members',
+      'classes/ClassWithAccessorKeywords.md',
+      1,
+    );
+  });
 });