Merge branch 'develop'

Author: oct-cr

.eslintrc.js

@@ -3,8 +3,9 @@
 module.exports = {
   "extends": "eslint:recommended",
   "env": {
-    "node": true,
-    "es6": true
+    "es6": true,
+    "jest": true,
+    "node": true
   },
   "parserOptions": {
     "ecmaVersion": 6,

README.md

@@ -1,6 +1,6 @@
-Create documentation for your React projects in a easy way using regular PropTypes declarations.
+Create documentation for your React projects in an easy way using standard PropTypes declarations.
 
-Share the documentation in the project repository.
+Share the documentation in your project's repository.
 
 ## Demo
 
@@ -49,7 +49,7 @@ react-doc-creator [path] ...[options]
 
 ## Use Examples
 
-The options should be added to the `package.json` script.
+The options should be added to the corresponding `react-doc-creator` script in `package.json`.
 
 ### Exclude specific file
 `react-doc-creator src --exclude demo\.jsx`

examples/REACT-PROPTYPES.md

@@ -19,8 +19,8 @@ Property | Type | Default value | Description
 `optionalEnum`|'News' \| 'Photos'||You can ensure that your prop is limited to specific values by treating it as an enum.
 `optionalUnion`|string \| number \| Promise||An object that could be one of many types
 `optionalArrayOf`|<number>[]||An array of a certain type
-`optionalObjectOf`|objectOf||An object with property values of a certain type
-`optionalObjectWithShape`|shape||An object taking on a particular shape
+`optionalObjectOf`|{ [key]: <number> }||An object with property values of a certain type
+`optionalObjectWithShape`|{ color: string, fontSize: number }||An object taking on a particular shape
 `requiredFunc`|func|_required_|You can chain any of the above with `isRequired` to make sure a warning is shown if the prop isn't provided.
 `requiredAny`|any|_required_|A value of any data type
 `customProp`|custom||
@@ -30,4 +30,4 @@ Property | Type | Default value | Description
 
 -----
 
-<sub>Documentation generated using **React Doc Creator v0.0.7**</sub>
+<sub>Documentation generated using **React Doc Creator v0.0.9**</sub>

lib/utils/parse-component.js

@@ -1,3 +1,6 @@
+const propParsers = require('./prop-parsers')
+
+
 exports.parseComponent = originalComponent => {
 
   const component = {
@@ -52,26 +55,16 @@ function getParsedProp(prop) {
     case 'arrayOf':
       return `<${prop.type.value.name}>[]`
     case 'enum':
-      return parseEnumProp(prop.type.value)
+      return propParsers.enum(prop.type.value)
     case 'instanceOf':
       return `<${prop.type.value}>`
+    case 'objectOf':
+      return propParsers.objectOf(prop.type.value)
     case 'union':
-      return parseUnionProp(prop.type.value)
+      return propParsers.union(prop.type.value)
+    case 'shape':
+      return propParsers.shape(prop.type.value)
     default:
       return prop.type.name
   }
 }
-
-
-function parseEnumProp(values) {
-  return values
-    .map(value => value.value)
-    .join(' \\| ')
-}
-
-
-function parseUnionProp(values) {
-  return values
-    .map(value => value.name === 'instanceOf' ? value.value : value.name)
-    .join(' \\| ')
-}

lib/utils/prop-parsers.js

@@ -0,0 +1,24 @@
+exports.enum = values =>
+  values
+    .map(value => value.value)
+    .join(' \\| ')
+
+
+exports.objectOf = value => `{ [key]: <${value.name}> }`
+
+
+exports.union = values =>
+  values
+    .map(value => value.name === 'instanceOf' ? value.value : value.name)
+    .join(' \\| ')
+
+
+exports.shape = values => {
+
+  const props = Object.keys(values)
+    .map(key => `${key}: ${values[key].name}`)
+    .join(', ')
+
+  return `{ ${props} }`
+
+}