feat(pluginConfigs): add docs property (#19)

Author: jcesarmobile

src/parse.ts

@@ -381,6 +381,8 @@ function getPluginsConfig(
         const typeLiteral = properytSignature.type as ts.TypeLiteralNode;
 
         const nm = properytSignature.name.getText();
+        const symbol = typeChecker.getSymbolAtLocation(properytSignature.name);
+        const docs = symbol ? serializeSymbol(typeChecker, symbol) : null;
         const i: DocsConfigInterface = {
           name: nm,
           slug: slugify(nm),
@@ -390,6 +392,7 @@ function getPluginsConfig(
               return getInterfaceProperty(typeChecker, propertySignature);
             })
             .filter(p => p != null) as DocsInterfaceProperty[],
+          docs: docs?.docs || '',
         };
 
         if (i.properties.length > 0) {

src/test/fixtures/definitions.ts

@@ -2,6 +2,9 @@
 
 declare module '@capacitor/cli' {
   export interface PluginsConfig {
+    /**
+     * Haptics can be configured with this options:
+     */
     Haptics?: {
       /**
        * Configure the style.

src/test/parse.spec.ts

@@ -147,6 +147,7 @@ describe('parse', () => {
     const p = pluginConfigs.find(i => i.name === `Haptics`);
 
     expect(p.slug).toBe(`haptics`);
+    expect(p.docs).toBe(`Haptics can be configured with this options:`);
     expect(p.properties).toHaveLength(2);
 
     const p0 = p.properties[0];

src/types.ts

@@ -10,6 +10,7 @@ export interface DocsConfigInterface {
   name: string;
   slug: string;
   properties: DocsInterfaceProperty[];
+  docs: string;
 }
 
 export interface DocsInterface {