feat(api): Add enum template

Author: BrunnerLivio

compiler/api/index.ts

@@ -23,6 +23,7 @@ const nestjs = new Package('nestjs', [
   .processor(require('./processors/processClassLikeMembers'))
   .processor(require('./processors/filterContainedDocs'))
   .processor(require('./processors/markPrivateDocs'))
+  .processor(require('./processors/shortDescription'))
   .processor(require('./processors/test'))
 
   .config(function(readTypeScriptModules, tsParser) {
@@ -67,10 +68,7 @@ const nestjs = new Package('nestjs', [
         templateEngine.filters.concat(getInjectables(requireFolder(__dirname, './rendering')));
 
     // helpers are made available to the nunjucks templates
-    renderDocsProcessor.helpers.relativePath = function(from, to) {
-      return relative(from, to);
-    };
-
+    renderDocsProcessor.helpers.relativePath = (from: string, to: string) => relative(from, to);
   });
 
 new Dgeni([nestjs]).generate();

compiler/api/processors/shortDescription.ts

@@ -0,0 +1,28 @@
+/**
+ * Split the description (of selected docs) into:
+ *`shortDescription`: the first paragraph
+ *`description`: the rest of the paragraphs
+ */
+module.exports = function splitDescription() {
+  return {
+    $runAfter: ['tags-extracted'],
+    $runBefore: ['processing-docs'],
+    $process(docs) {
+      docs.forEach(doc => {
+        if (
+          doc.description !== undefined
+        ) {
+          const description = doc.description.trim();
+          const endOfParagraph = description.search(/\n\s*\n/);
+          if (endOfParagraph === -1) {
+            doc.shortDescription = description;
+            doc.description = '';
+          } else {
+            doc.shortDescription = description.substr(0, endOfParagraph).trim();
+            doc.description = description.substr(endOfParagraph).trim();
+          }
+        }
+      });
+    }
+  };
+};

compiler/api/processors/test.ts

@@ -4,7 +4,7 @@ module.exports = function test() {
     $runAfter: ['processClassLikeMembers'],
     $runBefore: ['renderDocsProcessor'],
     $process(docs: any[]) {
-      console.log(docs.find(doc => doc.docType === 'class').methods[0]);
+      // console.log(docs.find(doc => doc.docType === 'class').methods[0]);
     }
   };
 };

compiler/api/templates/base.template.html

@@ -0,0 +1,3 @@
+<h1>{$ doc.name $}</h1>
+<label class="api-type-label {$ doc.docType $}">{$ doc.docType $}</label>
+{% block body %}{% endblock %}

compiler/api/templates/class.template.html

@@ -1,15 +1,9 @@
-{% import "lib/memberHelpers.html" as memberHelper -%}
-
-<h1>{$ doc.name $}</h1>
-<p>{$ doc.tags.description $} </p>
-
-<pre class="language-typescript">
-  <code class="language-typescript">
-{% if doc.isAbstract %}abstract {% endif%}class {$ doc.name $}{$ doc.typeParams | escape $}{$ memberHelper.renderHeritage(doc) $} {{$ memberHelper.renderMembers(doc) $}    
-}
-  </code>
-</pre>
-
-{$ memberHelper.renderProperties(doc.properties, 'instance-properties', 'instance-property', 'Properties') $}
-
-{$ memberHelper.renderMethodDetails(versionInfo, doc.methods, 'instance-methods', 'instance-method', 'Methods') $}
+{% extends 'export-base.template.html' -%}
+
+{% block overview %}
+  {% include "includes/class-overview.html" %}
+{% endblock %}
+{% block details %}
+  {% include "includes/description.html" %}
+  {% include "includes/class-members.html" %}
+{% endblock %}

compiler/api/templates/enum.template.html

@@ -0,0 +1,14 @@
+{% import "lib/memberHelpers.html" as memberHelpers -%}
+{% extends 'export-base.template.html' -%}
+
+{% block details %}
+<pre class="language-typescript">
+  <code class="language-typescript">
+enum {$ doc.name $} {{$ memberHelpers.renderMembers(doc) $}
+}
+  </code>
+</pre>
+
+{% include "includes/description.html" %}
+{$ memberHelpers.renderProperties(doc.properties, 'members', 'member', 'Members', ['Member']) $}
+{% endblock %}

compiler/api/templates/export-base.template.html

@@ -0,0 +1,11 @@
+{% extends 'base.template.html' -%}
+
+{% block body %}
+  <section class="short-description">
+    {$ doc.shortDescription | marked $}
+    {% if doc.description %}<p><a href="#description">See more...</a></p>{% endif %}
+  </section>
+  {% block overview %}{% endblock %}
+  {% block details %}{% endblock %}
+  {% block endNotes %}{% include "includes/usageNotes.html" %}{% endblock %}
+{% endblock %}

compiler/api/templates/includes/class-overview.html

@@ -0,0 +1,12 @@
+{% import "lib/memberHelpers.html" as memberHelper -%}
+{% import "lib/descendants.html" as descendants -%}
+
+
+<pre class="language-typescript">
+  <code class="language-typescript">
+{% if doc.isAbstract %}abstract {% endif%}class {$ doc.name $}{$ doc.typeParams | escape $}{$ memberHelper.renderHeritage(doc) $} {{$ memberHelper.renderMembers(doc) $}
+}
+  </code>
+</pre>
+
+{$ descendants.renderDescendants(doc, 'class', 'Subclasses', true, r/class|directive|pipe|decorator/) $}

compiler/api/templates/includes/description.html

@@ -0,0 +1,6 @@
+{% if doc.description %}
+<section class="description">
+  <h2>Description</h2>
+  {$ doc.description | trimBlankLines | marked $}
+</section>
+{% endif %}

compiler/api/templates/includes/see-also.html

@@ -0,0 +1,9 @@
+{%- if doc.see AND doc.see.length %}
+<section class="see-also">
+  <h2>See also</h2>
+  <ul>
+  {% for see in doc.see %}
+    <li>{$ see | marked $}</li>{% endfor %}
+  </ul>
+</section>
+{% endif %}