Exclude eslint comments in prop descriptions

uber-web · Aug 6, 2019 · 2198612 · 2198612
1 parent fdb9bec
commit 2198612
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/packages/extract-react-types/__snapshots__/test.js.snap b/packages/extract-react-types/__snapshots__/test.js.snap
@@ -2393,6 +2393,24 @@ Object {
             "kind": "string",
           },
         },
+        Object {
+          "key": Object {
+            "kind": "id",
+            "name": "b",
+          },
+          "kind": "property",
+          "leadingComments": Array [
+            Object {
+              "raw": " Type comment for b ",
+              "type": "commentBlock",
+              "value": "Type comment for b",
+            },
+          ],
+          "optional": false,
+          "value": Object {
+            "kind": "any",
+          },
+        },
       ],
       "referenceIdName": "Props",
     },

diff --git a/packages/extract-react-types/src/index.js b/packages/extract-react-types/src/index.js
@@ -1407,6 +1407,11 @@ function convertMethodCall(path, context): K.Func {
   };
 }
 
+function shouldIncludeComment(comment) {
+  const excludePatterns = [/\s*eslint/];
+  return !excludePatterns.find(pattern => comment.value.match(pattern));
+}
+
 function mapComment(comment) {
   return {
     type: comment.type === 'CommentLine' ? 'commentLine' : 'commentBlock',
@@ -1419,7 +1424,7 @@ function attachCommentProperty(source, dest, name) {
   if (!source || !source[name]) return;
   if (!dest[name]) dest[name] = [];
 
-  let comments = source[name].map(mapComment);
+  let comments = source[name].filter(shouldIncludeComment).map(mapComment);
   dest[name] = dest[name].concat(comments);
 }
 

diff --git a/packages/extract-react-types/test.js b/packages/extract-react-types/test.js
@@ -1048,6 +1048,9 @@ const TESTS = [
       type Props = {
         /* Type comment for a */
         a: string;
+        /* Type comment for b */
+        // eslint-disable-next-line flowtype/no-weak-types
+        b: any;
       }
 
       class Component extends React.Component<Props> {