Make it easier to add data to Documentation

This changes the API of the Documentation object. `getDescription` and
`setDescription` are gone. It was replaced by `get(key)` and `set(key,
value)`. This allows custom handlers to add arbitrary data.

This also removes `props` from the result object if there aren't any.
This makes it easier to test for their existence (e.g. `if (doc.props) {...}`).

Author: fkling

flow/react-docgen.js

@@ -23,8 +23,8 @@ type PropDescriptor = {
 
 declare class Documentation {
   addComposes(moduleName: string): void;
-  getDescription(): string;
-  setDescription(description: string): void;
+  get(key: string): any;
+  set(key: string, value: any): void;
   getPropDescriptor(propName: string): PropDescriptor;
   toObject(): Object;
 }

src/Documentation.js

@@ -12,45 +12,51 @@
 
 class Documentation {
   _props: Object;
-  _description: string;
   _composes: Array<string>;
+  _data: Object;
 
   constructor() {
-    this._props = {};
-    this._description = '';
-    this._composes = [];
+    this._props = new Map();
+    this._composes = new Set();
+    this._data = new Map();
   }
 
   addComposes(moduleName: string) {
-    if (this._composes.indexOf(moduleName) === -1) {
-      this._composes.push(moduleName);
-    }
+    this._composes.add(moduleName);
   }
 
-  getDescription(): string {
-    return this._description;
+  set(key: string, value: any) {
+    this._data.set(key, value);
   }
 
-  setDescription(description: string): void {
-    this._description = description;
+  get(key: string) {
+    return this._data.get(key);
   }
 
   getPropDescriptor(propName: string): PropDescriptor {
-    var propDescriptor = this._props[propName];
+    var propDescriptor = this._props.get(propName);
     if (!propDescriptor) {
-      propDescriptor = this._props[propName] = {};
+      this._props.set(propName, propDescriptor = {});
     }
     return propDescriptor;
   }
 
   toObject(): Object {
-    var obj = {
-      description: this._description,
-      props: this._props,
-    };
+    var obj = {};
+
+    for (var [key, value] of this._data) {
+      obj[key] = value;
+    }
+
+    if (this._props.size > 0) {
+      obj.props = {};
+      for (var [name, descriptor] of this._props) {
+        obj.props[name] = descriptor;
+      }
+    }
 
-    if (this._composes.length) {
-      obj.composes = this._composes;
+    if (this._composes.size > 0) {
+      obj.composes = Array.from(this._composes);
     }
     return obj;
   }

src/__mocks__/Documentation.js

@@ -10,7 +10,6 @@
 
 function Documentation() {
   return {
-    description: '',
     composes: [],
     descriptors: {},
     getPropDescriptor(name) {
@@ -19,8 +18,8 @@ function Documentation() {
     addComposes(name) {
       this.composes.push(name);
     },
-    setDescription(descr) {
-      this.description = descr;
+    set(key, value) {
+      this[key] = value;
     },
   };
 }

src/__tests__/main-test.js

@@ -46,7 +46,6 @@ describe('main', () => {
       ]);
       expect(docs).toEqual({
         description: 'Example component description',
-        props: {},
       });
     });
   }

src/handlers/componentDocblockHandler.js

@@ -53,5 +53,5 @@ export default function componentDocblockHandler(
       description = getDocblock(programPath);
     }
   }
-  documentation.setDescription(description || '');
+  documentation.set('description', description || '');
 }