fix(app): add support for inheritanceand extends

fix #116
compodoc · Mar 8, 2017 · 97cff59 · 97cff59
1 parent 9578f56
commit 97cff59
Show file tree

Hide file tree

Showing 4 changed files with 88 additions and 13 deletions.
diff --git a/src/app/compiler/dependencies.ts b/src/app/compiler/dependencies.ts
@@ -62,6 +62,9 @@ interface Deps {
     templateUrl?: string[];
     viewProviders?: string[];
 
+    implements?;
+    extends?;
+
     inputsClass?: Object[];
 
     //common
@@ -244,6 +247,12 @@ export class Dependencies {
                         if(IO.constructor) {
                             deps.constructorObj = IO.constructor;
                         }
+                        if (IO.extends) {
+                            deps.extends = IO.extends;
+                        }
+                        if (IO.implements && IO.implements.length > 0) {
+                            deps.implements = IO.implements;
+                        }
                         $componentsTreeEngine.addComponent(deps);
                         outputSymbols['components'].push(deps);
                     }
@@ -339,6 +348,12 @@ export class Dependencies {
                     if(IO.methods) {
                         deps.methods = IO.methods;
                     }
+                    if (IO.extends) {
+                        deps.extends = IO.extends;
+                    }
+                    if (IO.implements && IO.implements.length > 0) {
+                        deps.implements = IO.implements;
+                    }
                     this.debug(deps);
                     outputSymbols['classes'].push(deps);
                 } else if(node.symbol.flags === ts.SymbolFlags.Interface) {
@@ -429,6 +444,12 @@ export class Dependencies {
                     if(IO.methods) {
                         deps.methods = IO.methods;
                     }
+                    if (IO.extends) {
+                        deps.extends = IO.extends;
+                    }
+                    if (IO.implements && IO.implements.length > 0) {
+                        deps.implements = IO.implements;
+                    }
                     this.debug(deps);
                     outputSymbols['classes'].push(deps);
                 }
@@ -1133,28 +1154,31 @@ export class Dependencies {
         var className = classDeclaration.name.text;
         var directiveInfo;
         var members;
+        var implementsElements = [];
+        var extendsElement;
         var jsdoctags = [];
 
         if (typeof ts.getClassImplementsHeritageClauseElements !== 'undefined') {
             var implementedTypes = ts.getClassImplementsHeritageClauseElements(classDeclaration);
             if (implementedTypes) {
-                console.log('implementedTypes: ', implementedTypes);
+                let i = 0,
+                    len = implementedTypes.length;
+                for(i; i<len; i++) {
+                    if (implementedTypes[i].expression) {
+                        implementsElements.push(implementedTypes[i].expression.text);
+                    }
+                }
             }
         }
 
         if (typeof ts.getClassExtendsHeritageClauseElement !== 'undefined') {
             var extendsTypes = ts.getClassExtendsHeritageClauseElement(classDeclaration);
             if (extendsTypes) {
-                console.log('extendsTypes: ', extendsTypes);
+                if (extendsTypes.expression) {
+                    extendsElement = extendsTypes.expression.text
+                }
             }
         }
-        /*
-        if (classDeclaration.heritageClauses && classDeclaration.heritageClauses.length > 0) {
-            for (let i = 0; i < classDeclaration.heritageClauses.length; i++) {
-                console.log(classDeclaration.heritageClauses[i].kind, ts.SyntaxKind[200], ts.SyntaxKind[classDeclaration.heritageClauses[i].kind]);
-                console.log(util.inspect(classDeclaration.heritageClauses[i].types, { showHidden: false, depth: 8 }));
-            }
-        }*/
 
         if (symbol.valueDeclaration) {
             jsdoctags = JSDocTagsParser.getJSDocs(symbol.valueDeclaration);
@@ -1174,7 +1198,9 @@ export class Dependencies {
                         indexSignatures: members.indexSignatures,
                         kind: members.kind,
                         constructor: members.constructor,
-                        jsdoctags: jsdoctags
+                        jsdoctags: jsdoctags,
+                        extends: extendsElement,
+                        implements: implementsElements
                     };
                 } else if (this.isServiceDecorator(classDeclaration.decorators[i])) {
                   members = this.visitMembers(classDeclaration.members, sourceFile);
@@ -1186,7 +1212,9 @@ export class Dependencies {
                     indexSignatures: members.indexSignatures,
                     properties: members.properties,
                     kind: members.kind,
-                    constructor: members.constructor
+                    constructor: members.constructor,
+                    extends: extendsElement,
+                    implements: implementsElements
                   }];
               } else if (this.isPipeDecorator(classDeclaration.decorators[i]) || this.isModuleDecorator(classDeclaration.decorators[i])) {
                   return [{
@@ -1206,7 +1234,9 @@ export class Dependencies {
                 indexSignatures: members.indexSignatures,
                 properties: members.properties,
                 kind: members.kind,
-                constructor: members.constructor
+                constructor: members.constructor,
+                extends: extendsElement,
+                implements: implementsElements
             }];
         } else {
             members = this.visitMembers(classDeclaration.members, sourceFile);
@@ -1216,7 +1246,9 @@ export class Dependencies {
                 indexSignatures: members.indexSignatures,
                 properties: members.properties,
                 kind: members.kind,
-                constructor: members.constructor
+                constructor: members.constructor,
+                extends: extendsElement,
+                implements: implementsElements
             }];
         }
 

diff --git a/src/app/engines/dependencies.engine.ts b/src/app/engines/dependencies.engine.ts
@@ -83,12 +83,15 @@ class DependenciesEngine {
         },
             resultInCompodocInjectables = finderInCompodocDependencies(this.injectables),
             resultInCompodocClasses = finderInCompodocDependencies(this.classes),
+            resultInCompodocComponents = finderInCompodocDependencies(this.components),
             resultInAngularAPIs = finderInAngularAPIs(type)
 
         if (resultInCompodocInjectables.data !== null) {
             return resultInCompodocInjectables
         } else if (resultInCompodocClasses.data !== null) {
             return resultInCompodocClasses
+        } else if (resultInCompodocComponents.data !== null) {
+            return resultInCompodocComponents
         } else if (resultInAngularAPIs.data !== null) {
             return resultInAngularAPIs
         }

diff --git a/src/templates/partials/class.hbs b/src/templates/partials/class.hbs
@@ -32,6 +32,26 @@
             </p>
         {{/if}}
 
+        {{#if class.extends}}
+            <p class="comment">
+                <h3>Extends</h3>
+            </p>
+            <p class="comment">
+                {{> link-type type=class.extends }}
+            </p>
+        {{/if}}
+
+        {{#if class.implements}}
+            <p class="comment">
+                <h3>Implements</h3>
+            </p>
+            <p class="comment">
+                {{#each class.implements}}
+                    {{> link-type type=this}}
+                {{/each}}
+            </p>
+        {{/if}}
+
         {{#if class.constructorObj}}
             {{> block-constructor constructor=class.constructorObj file=class.file }}
         {{/if}}

diff --git a/src/templates/partials/component-detail.hbs b/src/templates/partials/component-detail.hbs
@@ -14,6 +14,26 @@
     </p>
 {{/if}}
 
+{{#if component.extends}}
+    <p class="comment">
+        <h3>Extends</h3>
+    </p>
+    <p class="comment">
+        {{> link-type type=component.extends }}
+    </p>
+{{/if}}
+
+{{#if component.implements}}
+    <p class="comment">
+        <h3>Implements</h3>
+    </p>
+    <p class="comment">
+        {{#each component.implements}}
+            {{> link-type type=this}}
+        {{/each}}
+    </p>
+{{/if}}
+
 {{#if component.jsdoctags}}
     <p class="comment">
         <h3>Example</h3>