fix: Improve membership inference for flow types

documentationjs · Feb 21, 2018 · 22469f3 · 22469f3
1 parent eb2cc4c
commit 22469f3
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 0 deletions.
diff --git a/__tests__/lib/infer/membership.js b/__tests__/lib/infer/membership.js
@@ -633,3 +633,37 @@ test('inferMembership - export', function() {
     scope: 'instance'
   });
 });
+
+test('inferMembership - flow interface', function() {
+  expect(
+    pick(
+      evaluate(`
+        interface Foo {
+          /** Test */
+          bar: number
+        }
+      `)[0],
+      ['memberof', 'scope']
+    )
+  ).toEqual({
+    memberof: 'Foo',
+    scope: 'instance'
+  });
+});
+
+test('inferMembership - flow object type alias', function() {
+  expect(
+    pick(
+      evaluate(`
+        type Foo = {
+          /** Test */
+          bar: number
+        }
+      `)[0],
+      ['memberof', 'scope']
+    )
+  ).toEqual({
+    memberof: 'Foo',
+    scope: 'instance'
+  });
+});
diff --git a/src/infer/membership.js b/src/infer/membership.js
@@ -397,6 +397,21 @@ module.exports = function() {
       }
     }
 
+    // type Foo = { bar: T }
+    // interface Foo { bar: T }
+    if (
+      path.isObjectTypeProperty() &&
+      path.parentPath.isObjectTypeAnnotation() &&
+      (path.parentPath.parentPath.isTypeAlias() ||
+        path.parentPath.parentPath.isInterfaceDeclaration())
+    ) {
+      return inferMembershipFromIdentifiers(
+        comment,
+        [path.parentPath.parentPath.get('id').node.name],
+        'instance'
+      );
+    }
+
     return comment;
   };
 };