feat(typescript): skip private methods (#409)

Co-authored-by: Daniel Tschinder <[email protected]>

Author: satya164

src/__tests__/__snapshots__/main-test.js.snap

@@ -1398,7 +1398,26 @@ Object {
       "description": "This is a method",
       "docblock": "This is a method",
       "modifiers": Array [],
-      "name": "method",
+      "name": "foo",
+      "params": Array [
+        Object {
+          "name": "a",
+          "type": Object {
+            "name": "string",
+          },
+        },
+      ],
+      "returns": Object {
+        "type": Object {
+          "name": "string",
+        },
+      },
+    },
+    Object {
+      "description": "This is a public method",
+      "docblock": "This is a public method",
+      "modifiers": Array [],
+      "name": "bar",
       "params": Array [
         Object {
           "name": "a",

src/__tests__/fixtures/component_27.tsx

@@ -23,7 +23,21 @@ export default class TSComponent extends Component<Props> {
   /**
    * This is a method
    */
-  method(a: string): string {
+  foo(a: string): string {
+    return a;
+  }
+
+  /**
+   * This is a public method
+   */
+  public bar(a: string): string {
+    return a;
+  }
+
+  /**
+   * This is a private method
+   */
+  private baz(a: string): string {
     return a;
   }
 }

src/utils/__tests__/__snapshots__/getMethodDocumentation-test.js.snap

@@ -11,3 +11,5 @@ Object {
 `;
 
 exports[`getMethodDocumentation name ignores complex computed method name 1`] = `null`;
+
+exports[`getMethodDocumentation parameters private ignores private typescript methods 1`] = `null`;

src/utils/__tests__/getMethodDocumentation-test.js

@@ -202,5 +202,33 @@ describe('getMethodDocumentation', () => {
         );
       });
     });
+
+    describe('private', () => {
+      it('ignores private typescript methods', () => {
+        const def = statement(
+          `
+          class Foo {
+            private foo() {}
+          }
+        `,
+          { parserOptions: { plugins: ['typescript'] } },
+        );
+        const method = def.get('body', 'body', 0);
+        expect(getMethodDocumentation(method)).toMatchSnapshot();
+      });
+
+      it.skip('ignores private methods', () => {
+        const def = statement(
+          `
+          class Foo {
+            #foo() {}
+          }
+        `,
+          { parserOptions: { plugins: ['classPrivateMethods'] } },
+        );
+        const method = def.get('body', 'body', 0);
+        expect(getMethodDocumentation(method)).toMatchSnapshot();
+      });
+    });
   });
 });

src/utils/getMethodDocumentation.js

@@ -107,6 +107,10 @@ function getMethodModifiers(methodPath) {
 export default function getMethodDocumentation(
   methodPath: NodePath,
 ): ?MethodDocumentation {
+  if (methodPath.node.accessibility === 'private') {
+    return null;
+  }
+
   const name = getPropertyName(methodPath);
   if (!name) return null;