Don't include line comments in prop type values

Fixes #1

Author: fkling

src/handlers/defaultPropsHandler.js

@@ -17,6 +17,7 @@ var Documentation = require('../Documentation');
 
 var getPropertyName = require('../utils/getPropertyName');
 var getPropertyValuePath = require('../utils/getPropertyValuePath');
+var printValue = require('../utils/printValue');
 var recast = require('recast');
 var resolveToValue = require('../utils/resolveToValue');
 var types = recast.types.namedTypes;
@@ -30,7 +31,7 @@ function getDefaultValue(path) {
   } else {
     path = resolveToValue(path);
     node = path.node;
-    defaultValue = recast.print(path).code;
+    defaultValue = printValue(path);
   }
   if (typeof defaultValue !== 'undefined') {
     return {

src/handlers/propTypeHandler.js

@@ -21,6 +21,7 @@ var getPropType = require('../utils/getPropType');
 var getPropertyName = require('../utils/getPropertyName');
 var getPropertyValuePath = require('../utils/getPropertyValuePath');
 var isReactModuleName = require('../utils/isReactModuleName');
+var printValue = require('../utils/printValue');
 var recast = require('recast');
 var resolveToModule = require('../utils/resolveToModule');
 var resolveToValue = require('../utils/resolveToValue');
@@ -76,7 +77,7 @@ function amendPropTypes(documentation, path) {
         var valuePath = propertyPath.get('value');
         var type = isPropTypesExpression(valuePath) ?
           getPropType(valuePath) :
-          {name: 'custom', raw: recast.print(valuePath).code};
+          {name: 'custom', raw: printValue(valuePath)};
 
         if (type) {
           propDescriptor.type = type;

src/utils/__tests__/getPropType-test.js

@@ -65,6 +65,15 @@ describe('getPropType', function() {
       ]
     });
 
+    // line comments are ignored
+    expect(getPropType(parse('oneOf(["foo", // baz\n"bar"])'))).toEqual({
+      name: 'enum',
+      value: [
+        {value: '"foo"', computed: false},
+        {value: '"bar"', computed: false}
+      ]
+    });
+
     expect(getPropType(parse('oneOfType([number, bool])'))).toEqual({
       name: 'union',
       value: [

src/utils/__tests__/printValue-test.js

@@ -0,0 +1,38 @@
+/*
+ *  Copyright (c) 2015, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the BSD-style license found in the
+ *  LICENSE file in the root directory of this source tree. An additional grant
+ *  of patent rights can be found in the PATENTS file in the same directory.
+ *
+ */
+
+"use strict";
+
+jest.autoMockOff();
+
+describe('printValue', function() {
+  var printValue;
+  var utils;
+
+  beforeEach(function() {
+    printValue = require('../printValue');
+    utils = require('../../../tests/utils');
+  });
+
+  function pathFromSource(source) {
+    return utils.parse(source).get('body', 0, 'expression');
+  }
+
+  it('does not print leading comments', function() {
+    expect(printValue(pathFromSource('//foo\nbar')))
+      .toEqual('bar');
+  });
+
+  it('does not print trailing comments', function() {
+    expect(printValue(pathFromSource('bar//foo')))
+      .toEqual('bar');
+  });
+
+});

src/utils/getPropType.js

@@ -15,6 +15,7 @@
 
 var getMembers = require('./getMembers');
 var getPropertyName = require('./getPropertyName');
+var printValue = require('./printValue');
 var recast = require('recast');
 var resolveToValue = require('./resolveToValue');
 
@@ -23,7 +24,7 @@ var types = recast.types.namedTypes;
 function getEnumValues(path) {
   return path.get('elements').map(function(elementPath) {
     return {
-      value: recast.print(elementPath).code,
+      value: printValue(elementPath),
       computed: !types.Literal.check(elementPath.node)
     };
   });
@@ -33,7 +34,7 @@ function getPropTypeOneOf(argumentPath) {
   var type = {name: 'enum'};
   if (!types.ArrayExpression.check(argumentPath.node)) {
     type.computed = true;
-    type.value = recast.print(argumentPath).code;
+    type.value = printValue(argumentPath);
   } else {
     type.value = getEnumValues(argumentPath);
   }
@@ -44,7 +45,7 @@ function getPropTypeOneOfType(argumentPath) {
   var type = {name: 'union'};
   if (!types.ArrayExpression.check(argumentPath.node)) {
     type.computed = true;
-    type.value = recast.print(argumentPath).code;
+    type.value = printValue(argumentPath);
   } else {
     type.value = argumentPath.get('elements').map(getPropType);
   }
@@ -56,7 +57,7 @@ function getPropTypeArrayOf(argumentPath) {
   var subType = getPropType(argumentPath);
 
   if (subType.name === 'unknown') {
-    type.value = recast.print(argumentPath).code;
+    type.value = printValue(argumentPath);
     type.computed = true;
   } else {
     type.value = subType;
@@ -84,7 +85,7 @@ function getPropTypeShape(argumentPath) {
 function getPropTypeInstanceOf(argumentPath) {
   return {
     name: 'instanceOf',
-    value: recast.print(argumentPath).code
+    value: printValue(argumentPath)
   };
 }
 
@@ -144,7 +145,7 @@ function getPropType(path: NodePath): PropTypeDescriptor {
         propTypes.hasOwnProperty(node.callee.name)) {
       descriptor = propTypes[node.callee.name](path.get('arguments', 0));
     } else {
-      descriptor = {name: 'custom', raw: recast.print(path).code};
+      descriptor = {name: 'custom', raw: printValue(path)};
     }
   }
   return descriptor;

src/utils/printValue.js

@@ -0,0 +1,28 @@
+/*
+ *  Copyright (c) 2015, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the BSD-style license found in the
+ *  LICENSE file in the root directory of this source tree. An additional grant
+ *  of patent rights can be found in the PATENTS file in the same directory.
+ *
+ */
+
+/**
+ * @flow
+ */
+"use strict";
+
+var recast = require('recast');
+
+/**
+ * Prints the given path without leading or trailing comments.
+ */
+function printValue(path: NodePath): string {
+  if (path.node.comments) {
+    path.node.comments.length = 0;
+  }
+  return recast.print(path).code;
+}
+
+module.exports = printValue;