feat: Include package version in documentation

Closes #544
TypeStrong · Dec 26, 2019 · fb2aaca · fb2aaca
1 parent 78d8e2f
commit fb2aaca
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 7 deletions.
diff --git a/scripts/rebuild_specs.js b/scripts/rebuild_specs.js
@@ -17,6 +17,7 @@ const app = new TypeDoc.Application({
         "lib.es2015.iterable.d.ts",
         "lib.es2015.collection.d.ts"
     ],
+    name: 'typedoc'
 });
 
 // Note that this uses the test files in dist, not in src, this is important since

diff --git a/src/lib/converter/plugins/PackagePlugin.ts b/src/lib/converter/plugins/PackagePlugin.ts
@@ -124,7 +124,7 @@ export class PackagePlugin extends ConverterComponent {
         if (this.packageFile) {
             project.packageInfo = JSON.parse(FS.readFileSync(this.packageFile, 'utf-8'));
             if (!project.name) {
-                project.name = project.packageInfo.name;
+                project.name = `${project.packageInfo.name} - v${project.packageInfo.version}`;
             }
         }
     }

diff --git a/src/test/converter.test.ts b/src/test/converter.test.ts
@@ -68,7 +68,8 @@ describe('Converter', function() {
             target: 'ES5',
             module: 'CommonJS',
             experimentalDecorators: true,
-            jsx: 'react'
+            jsx: 'react',
+            name: 'typedoc'
         });
     });
 
@@ -106,13 +107,14 @@ describe('Converter with categorizeByGroup=false', function() {
 
     before('constructs', function() {
         app = new Application({
-            mode:   'Modules',
+            mode: 'Modules',
             logger: 'none',
             target: 'ES5',
             module: 'CommonJS',
             experimentalDecorators: true,
             categorizeByGroup: false,
-            jsx: 'react'
+            jsx: 'react',
+            name: 'typedoc'
         });
     });
 
@@ -160,13 +162,14 @@ describe('Converter with excludeNotExported=true', function() {
 
     before('constructs', function() {
         app = new Application({
-            mode:   'Modules',
+            mode: 'Modules',
             logger: 'none',
             target: 'ES5',
             module: 'CommonJS',
             experimentalDecorators: true,
             excludeNotExported: true,
-            jsx: 'react'
+            jsx: 'react',
+            name: 'typedoc'
         });
     });
 

diff --git a/src/test/renderer.test.ts b/src/test/renderer.test.ts
@@ -61,7 +61,8 @@ describe('Renderer', function() {
             target: 'ES5',
             readme: Path.join(src, '..', 'README.md'),
             module: 'CommonJS',
-            gaSite: 'foo.com' // verify theme option without modifying output
+            gaSite: 'foo.com', // verify theme option without modifying output
+            name: 'typedoc'
         });
     });