Enable --gitRevision option (TypeStrong#474)

Author: lenovouser

Diff for: README.md

@@ -2,7 +2,7 @@
 
 > Documentation generator for TypeScript projects.
 
-[![Build Status](https://travis-ci.org/TypeStrong/typedoc.svg?branch=master)](https://travis-ci.org/TypeStrong/typedoc) 
+[![Build Status](https://travis-ci.org/TypeStrong/typedoc.svg?branch=master)](https://travis-ci.org/TypeStrong/typedoc)
 [![NPM Version](https://badge.fury.io/js/typedoc.svg)](http://badge.fury.io/js/typedoc)
 [![Chat on Gitter](https://badges.gitter.im/TypeStrong/typedoc.svg)](https://gitter.im/TypeStrong/typedoc?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
@@ -62,7 +62,6 @@ in order to change the behaviour of TypeDoc.
   Prevent externally resolved TypeScript files from being documented.
 * `--excludePrivate`<br>
   Prevent private members from being included in the generated documentation.
-  
 
 #### TypeScript compiler
 * `--module <commonjs, amd, system or umd>`<br>
@@ -86,6 +85,8 @@ in order to change the behaviour of TypeDoc.
   Set the site name for Google Analytics. Defaults to `auto`
 * `--entryPoint <fully.qualified.name>`<br>
   Specifies the fully qualified name of the root symbol. Defaults to global namespace.
+* `--gitRevision <revision|branch>`<br>
+  Use specified revision or branch instead of the last revision for linking to GitHub source files.
 
 #### Content
 * `--includes <path/to/includes>`<br>

Diff for: src/lib/converter/plugins/GitHubPlugin.ts

@@ -6,6 +6,8 @@ import {Component, ConverterComponent} from '../components';
 import {BasePath} from '../utils/base-path';
 import {Converter} from '../converter';
 import {Context} from '../context';
+import {Option} from '../../utils/component';
+import {ParameterType} from '../../utils/options/declaration';
 
 // This should be removed when @typings/shelljs typings are updated to the shelljs version being used
 declare module 'shelljs' {
@@ -30,7 +32,7 @@ class Repository {
     /**
      * The name of the branch this repository is on right now.
      */
-    branch = 'master';
+    branch: string;
 
     /**
      * A list of all files tracked by the repository.
@@ -52,8 +54,9 @@ class Repository {
      *
      * @param path  The root path of the repository.
      */
-    constructor(path: string) {
+    constructor(path: string, gitRevision: string) {
         this.path = path;
+        this.branch = gitRevision || 'master';
         ShellJS.pushd(path);
 
         let out = <ShellJS.ExecOutputReturnValue> ShellJS.exec('git ls-remote --get-url', {silent: true});
@@ -82,9 +85,11 @@ class Repository {
             });
         }
 
-        out = <ShellJS.ExecOutputReturnValue> ShellJS.exec('git rev-parse --short HEAD', {silent: true});
-        if (out.code === 0) {
-            this.branch = out.stdout.replace('\n', '');
+        if (!gitRevision) {
+            out = <ShellJS.ExecOutputReturnValue> ShellJS.exec('git rev-parse --short HEAD', {silent: true});
+            if (out.code === 0) {
+                this.branch = out.stdout.replace('\n', '');
+            }
         }
 
         ShellJS.popd();
@@ -130,15 +135,15 @@ class Repository {
      * @param path  The potential repository root.
      * @returns A new instance of [[Repository]] or NULL.
      */
-    static tryCreateRepository(path: string): Repository {
+    static tryCreateRepository(path: string, gitRevision: string): Repository {
         ShellJS.pushd(path);
         const out = <ShellJS.ExecOutputReturnValue> ShellJS.exec('git rev-parse --show-toplevel', {silent: true});
         ShellJS.popd();
 
         if (out.code !== 0) {
             return null;
         }
-        return new Repository(BasePath.normalize(out.stdout.replace('\n', '')));
+        return new Repository(BasePath.normalize(out.stdout.replace('\n', '')), gitRevision);
     }
 }
 
@@ -158,6 +163,13 @@ export class GitHubPlugin extends ConverterComponent {
      */
     private ignoredPaths: string[] = [];
 
+    @Option({
+        name: 'gitRevision',
+        help: 'Use specified revision instead of the last revision for linking to GitHub source files.',
+        type: ParameterType.String
+    })
+    gitRevision: string;
+
     /**
      * Create a new GitHubHandler instance.
      *
@@ -196,7 +208,7 @@ export class GitHubPlugin extends ConverterComponent {
         }
 
         // Try to create a new repository
-        const repository = Repository.tryCreateRepository(dirName);
+        const repository = Repository.tryCreateRepository(dirName, this.gitRevision);
         if (repository) {
             this.repositories[repository.path] = repository;
             return repository;

Diff for: src/lib/converter/types/index.ts

@@ -3,7 +3,7 @@ export {ArrayConverter} from './array';
 export {BindingArrayConverter} from './binding-array';
 export {BindingObjectConverter} from './binding-object';
 export {EnumConverter} from './enum';
-export {IntrinsicConverter} from './intrinsic'
+export {IntrinsicConverter} from './intrinsic';
 export {StringLiteralConverter} from './string-literal';
 export {ReferenceConverter} from './reference';
 export {ThisConverter} from './this';

Diff for: src/test/renderer/specs/index.html

@@ -138,6 +138,8 @@ <h4 id="theming">Theming</h4>
 					Set the site name for Google Analytics. Defaults to <code>auto</code></li>
 					<li><code>--entryPoint &lt;fully.qualified.name&gt;</code><br>
 					Specifies the fully qualified name of the root symbol. Defaults to global namespace.</li>
+					<li><code>--gitRevision &lt;revision|branch&gt;</code><br>
+					Use specified revision or branch instead of the last revision for linking to GitHub source files.</li>
 				</ul>
 				<h4 id="content">Content</h4>
 				<ul>