feat(generator): add comment to proptype blocks

src/generator.ts

@@ -25,6 +25,15 @@ export interface GenerateOptions {
    * @param proptype The current PropType about to be converted to text
    */
   shouldInclude?(proptype: t.PropTypeNode): boolean | undefined;
+
+  /**
+   * A comment that will be added to the start of the PropTypes code block
+   * @example
+   * foo.propTypes = {
+   *  // Comment goes here
+   * }
+   */
+  comment?: string;
 }
 
 /**
@@ -73,7 +82,14 @@ export function generate(node: t.Node | t.PropTypeNode[], options: GenerateOptio
   }
 
   if (t.isComponentNode(node)) {
-    return `${node.name}.propTypes = {\n${generate(node.types, options)}\n}`;
+    const comment =
+      options.comment &&
+      `// ${options.comment.split(/\r?\n/gm).reduce((prev, curr) => `${prev}\n// ${curr}`)}\n`;
+
+    return `${node.name}.propTypes = {\n${comment ? comment : ''}${generate(
+      node.types,
+      options,
+    )}\n}`;
   }
 
   if (t.isPropTypeNode(node)) {

src/injector.ts

@@ -22,7 +22,7 @@ export type InjectOptions = {
    * @default includeUnusedProps ? true : data.usedProps.includes(`${data.prop.name}`)
    */
   shouldInclude?(data: { prop: t.PropTypeNode; usedProps: string[] }): boolean | undefined;
-} & Pick<GenerateOptions, 'sortProptypes' | 'includeJSDoc'>;
+} & Pick<GenerateOptions, 'sortProptypes' | 'includeJSDoc' | 'comment'>;
 
 /**
  * Injects the PropTypes from `parse` into the provided JavaScript code