fix: Ensure componentMethodsHandler ignores private properties (#440)

Co-authored-by: Daniel Tschinder <[email protected]> # Conflicts: # src/handlers/componentMethodsHandler.js
reactjs · May 8, 2021 · 41c666c · 41c666c
1 parent c931a39
commit 41c666c
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 1 deletion.
diff --git a/src/handlers/__tests__/componentMethodsHandler-test.js b/src/handlers/__tests__/componentMethodsHandler-test.js
@@ -156,6 +156,25 @@ describe('componentMethodsHandler', () => {
     expect(documentation.methods).toMatchSnapshot();
   });
 
+  it('should handle and ignore private properties', () => {
+    const src = `
+      class Test extends React.Component {
+        #privateProperty = () => {
+          console.log('Do something');
+        }
+
+        componentDidMount() {}
+
+        render() {
+          return null;
+        }
+      }
+    `;
+
+    componentMethodsHandler(documentation, parse(src).get('body', 0));
+    expect(documentation.methods.length).toBe(0);
+  });
+
   describe('function components', () => {
     it('no methods', () => {
       const src = `

diff --git a/src/handlers/componentMethodsHandler.js b/src/handlers/componentMethodsHandler.js
@@ -17,6 +17,11 @@ import match from '../utils/match';
 import { traverseShallow } from '../utils/traverse';
 import resolveToValue from '../utils/resolveToValue';
 
+function isPublicClassProperty(path) {
+  return (
+    t.ClassProperty.check(path.node) && !t.ClassPrivateProperty.check(path.node)
+  );
+}
 /**
  * The following values/constructs are considered methods:
  *
@@ -28,7 +33,7 @@ import resolveToValue from '../utils/resolveToValue';
 function isMethod(path) {
   const isProbablyMethod =
     (t.MethodDefinition.check(path.node) && path.node.kind !== 'constructor') ||
-    ((t.ClassProperty.check(path.node) || t.Property.check(path.node)) &&
+    ((isPublicClassProperty(path) || t.Property.check(path.node)) &&
       t.Function.check(path.get('value').node));
 
   return isProbablyMethod && !isReactComponentMethod(path);