refactor: 💡 type section is redundant and not formatted

andrewdelprete · tmcw · commit 71ceea2e19f0 · 2020-06-03T20:19:43.000-07:00
When an object is flow typed, a `type` AND `properties` section is rendered. The type section seems redundant and isn't formatted, whereas the properties section is. This PR removes the `type` section when dealing with an object type. ✅ Closes: #1326
diff --git a/src/infer/type.js b/src/infer/type.js
@@ -64,7 +64,9 @@ function inferType(comment) {
         type = ast.node.value;
       }
   }
-  if (type) {
+  // Don't provide a `type` section when it's an ObjectTypeAnnotation,
+  // `properties` already exists and renders better.
+  if (type && type.type !== 'ObjectTypeAnnotation') {
     comment.type = typeAnnotation(type);
   }
   return comment;

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,9 @@ function inferType(comment) {`
`64`	`64`	`type = ast.node.value;`
`65`	`65`	`}`
`66`	`66`	`}`
`67`		`- if (type) {`
	`67`	+ // Don't provide a `type` section when it's an ObjectTypeAnnotation,
	`68`	+ // `properties` already exists and renders better.
	`69`	`+ if (type && type.type !== 'ObjectTypeAnnotation') {`
`68`	`70`	`comment.type = typeAnnotation(type);`
`69`	`71`	`}`
`70`	`72`	`return comment;`