typedoc - npm Package Compare versions

Comparing version 0.5.10 to 0.6.0

dist/lib/application.js

@@ -158,3 +158,3 @@ "use strict";
 }(component_1.ChildableComponent));
-Application.VERSION = '0.5.10';
+Application.VERSION = '0.6.0';
 __decorate([
@@ -161,0 +161,0 @@ component_1.Option({

dist/lib/converter/plugins/GitHubPlugin.d.ts

 import { ConverterComponent } from '../components';
-declare module 'shelljs' {
-    interface ExecOutputReturnValue {
-        stdout: string;
-        stderr: string;
-    }
-}
 export declare class GitHubPlugin extends ConverterComponent {
     private repositories;
     private ignoredPaths;
+    gitRevision: string;
     initialize(): void;
@@ -12,0 +7,0 @@ private getRepository(fileName);

dist/lib/converter/plugins/GitHubPlugin.js

@@ -24,8 +24,10 @@ "use strict";
 var converter_1 = require("../converter");
+var component_1 = require("../../utils/component");
+var declaration_1 = require("../../utils/options/declaration");
 var Repository = (function () {
-    function Repository(path) {
+    function Repository(path, gitRevision) {
         var _this = this;
-        this.branch = 'master';
         this.files = [];
         this.path = path;
+        this.branch = gitRevision || 'master';
         ShellJS.pushd(path);
@@ -56,5 +58,7 @@ var out = ShellJS.exec('git ls-remote --get-url', { silent: true });
         }
-        out = ShellJS.exec('git rev-parse --short HEAD', { silent: true });
-        if (out.code === 0) {
-            this.branch = out.stdout.replace('\n', '');
+        if (!gitRevision) {
+            out = ShellJS.exec('git rev-parse --short HEAD', { silent: true });
+            if (out.code === 0) {
+                this.branch = out.stdout.replace('\n', '');
+            }
         }
@@ -79,3 +83,3 @@ ShellJS.popd();
     };
-    Repository.tryCreateRepository = function (path) {
+    Repository.tryCreateRepository = function (path, gitRevision) {
         ShellJS.pushd(path);
@@ -87,3 +91,3 @@ var out = ShellJS.exec('git rev-parse --show-toplevel', { silent: true });
         }
-        return new Repository(base_path_1.BasePath.normalize(out.stdout.replace('\n', '')));
+        return new Repository(base_path_1.BasePath.normalize(out.stdout.replace('\n', '')), gitRevision);
     };
@@ -121,3 +125,3 @@ return Repository;
         }
-        var repository = Repository.tryCreateRepository(dirName);
+        var repository = Repository.tryCreateRepository(dirName, this.gitRevision);
         if (repository) {
@@ -155,2 +159,9 @@ this.repositories[repository.path] = repository;
 }(components_1.ConverterComponent));
+__decorate([
+    component_1.Option({
+        name: 'gitRevision',
+        help: 'Use specified revision instead of the last revision for linking to GitHub source files.',
+        type: declaration_1.ParameterType.String
+    })
+], GitHubPlugin.prototype, "gitRevision", void 0);
 GitHubPlugin = __decorate([
@@ -157,0 +168,0 @@ components_1.Component({ name: 'git-hub' })

dist/lib/converter/plugins/TypePlugin.js

@@ -113,6 +113,6 @@ "use strict";
             }
-            else if (type instanceof index_2.UnionType) {
-                var unionType = type;
-                for (var index = 0, count = unionType.types.length; index < count; index++) {
-                    resolveType(reflection, unionType.types[index]);
+            else if (type instanceof index_2.UnionType || type instanceof index_2.IntersectionType) {
+                var unionOrIntersectionType = type;
+                for (var index = 0, count = unionOrIntersectionType.types.length; index < count; index++) {
+                    resolveType(reflection, unionOrIntersectionType.types[index]);
                 }
@@ -119,0 +119,0 @@ }

dist/lib/converter/types/index.d.ts

@@ -12,3 +12,3 @@ export { AliasConverter } from './alias';
 export { TypeParameterConverter } from './type-parameter';
-export { UnionConverter } from './union';
+export { UnionOrIntersectionConverter } from './union-or-intersection';
 export { UnknownConverter } from './unknown';

dist/lib/converter/types/index.js

@@ -25,6 +25,6 @@ "use strict";
 exports.TypeParameterConverter = type_parameter_1.TypeParameterConverter;
-var union_1 = require("./union");
-exports.UnionConverter = union_1.UnionConverter;
+var union_or_intersection_1 = require("./union-or-intersection");
+exports.UnionOrIntersectionConverter = union_or_intersection_1.UnionOrIntersectionConverter;
 var unknown_1 = require("./unknown");
 exports.UnknownConverter = unknown_1.UnknownConverter;
 //# sourceMappingURL=index.js.map

dist/lib/models/types/abstract.d.ts

 export declare abstract class Type {
     isArray: boolean;
+    readonly type: string;
     abstract clone(): Type;
@@ -4,0 +5,0 @@ equals(type: Type): boolean;

dist/lib/models/types/abstract.js

@@ -6,2 +6,3 @@ "use strict";
         this.isArray = false;
+        this.type = 'void';
     }
@@ -13,3 +14,3 @@ Type.prototype.equals = function (type) {
         var result = {};
-        result.type = 'void';
+        result.type = this.type;
         if (this.isArray) {
@@ -16,0 +17,0 @@ result.isArray = this.isArray;

dist/lib/models/types/index.d.ts

 export { Type } from './abstract';
 export { IntrinsicType } from './intrinsic';
+export { IntersectionType } from './intersection';
 export { ReferenceType } from './reference';
@@ -4,0 +5,0 @@ export { ReflectionType } from './reflection';

dist/lib/models/types/index.js

@@ -7,2 +7,4 @@ "use strict";
 exports.IntrinsicType = intrinsic_1.IntrinsicType;
+var intersection_1 = require("./intersection");
+exports.IntersectionType = intersection_1.IntersectionType;
 var reference_1 = require("./reference");
@@ -9,0 +11,0 @@ exports.ReferenceType = reference_1.ReferenceType;

dist/lib/models/types/intrinsic.d.ts

 import { Type } from './abstract';
 export declare class IntrinsicType extends Type {
     name: string;
+    readonly type: string;
     constructor(name: string);
@@ -5,0 +6,0 @@ clone(): Type;

dist/lib/models/types/intrinsic.js

@@ -18,2 +18,3 @@ "use strict";
         var _this = _super.call(this) || this;
+        _this.type = 'intrinsic';
         _this.name = name;
@@ -34,3 +35,2 @@ return _this;
         var result = _super.prototype.toObject.call(this);
-        result.type = 'instrinct';
         result.name = this.name;
@@ -37,0 +37,0 @@ return result;

dist/lib/models/types/reference.d.ts

 import { Reflection } from '../reflections/abstract';
 import { Type } from './abstract';
 export declare class ReferenceType extends Type {
+    readonly type: string;
     name: string;
@@ -5,0 +6,0 @@ typeArguments: Type[];

dist/lib/models/types/reference.js

@@ -18,2 +18,3 @@ "use strict";
         var _this = _super.call(this) || this;
+        _this.type = 'reference';
         _this.name = name;
@@ -37,3 +38,2 @@ _this.symbolID = symbolID;
         var result = _super.prototype.toObject.call(this);
-        result.type = 'reference';
         result.name = this.name;
@@ -40,0 +40,0 @@ if (this.reflection) {

dist/lib/models/types/reflection.d.ts

@@ -5,2 +5,3 @@ import { DeclarationReflection } from '../reflections/declaration';
     declaration: DeclarationReflection;
+    readonly type: string;
     constructor(declaration: DeclarationReflection);
@@ -7,0 +8,0 @@ clone(): Type;

dist/lib/models/types/reflection.js

@@ -18,2 +18,3 @@ "use strict";
         var _this = _super.call(this) || this;
+        _this.type = 'reflection';
         _this.declaration = declaration;
@@ -32,3 +33,2 @@ return _this;
         var result = _super.prototype.toObject.call(this);
-        result.type = 'reflection';
         if (this.declaration) {
@@ -35,0 +35,0 @@ result.declaration = this.declaration.toObject();

dist/lib/models/types/string-literal.d.ts

 import { Type } from './abstract';
 export declare class StringLiteralType extends Type {
     value: string;
+    readonly type: string;
     constructor(value: string);
@@ -5,0 +6,0 @@ clone(): Type;

dist/lib/models/types/string-literal.js

@@ -18,2 +18,3 @@ "use strict";
         var _this = _super.call(this) || this;
+        _this.type = 'stringLiteral';
         _this.value = value;
@@ -34,3 +35,2 @@ return _this;
         var result = _super.prototype.toObject.call(this);
-        result.type = 'stringLiteral';
         result.value = this.value;
@@ -37,0 +37,0 @@ return result;

dist/lib/models/types/tuple.d.ts

 import { Type } from './abstract';
 export declare class TupleType extends Type {
     elements: Type[];
+    readonly type: string;
     constructor(elements: Type[]);
@@ -5,0 +6,0 @@ clone(): Type;

dist/lib/models/types/tuple.js

@@ -18,2 +18,3 @@ "use strict";
         var _this = _super.call(this) || this;
+        _this.type = 'tuple';
         _this.elements = elements;
@@ -38,3 +39,2 @@ return _this;
         var result = _super.prototype.toObject.call(this);
-        result.type = 'tuple';
         if (this.elements && this.elements.length) {
@@ -41,0 +41,0 @@ result.elements = this.elements.map(function (e) { return e.toObject(); });

dist/lib/models/types/type-parameter.d.ts

@@ -5,2 +5,3 @@ import { Type } from './abstract';
     constraint: Type;
+    readonly type: string;
     clone(): Type;
@@ -7,0 +8,0 @@ equals(type: TypeParameterType): boolean;

dist/lib/models/types/type-parameter.js

@@ -17,3 +17,5 @@ "use strict";
     function TypeParameterType() {
-        return _super !== null && _super.apply(this, arguments) || this;
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.type = 'typeParameter';
+        return _this;
     }
@@ -46,3 +48,2 @@ TypeParameterType.prototype.clone = function () {
         var result = _super.prototype.toObject.call(this);
-        result.type = 'typeParameter';
         result.name = this.name;
@@ -49,0 +50,0 @@ if (this.constraint) {

dist/lib/models/types/union.d.ts

 import { Type } from './abstract';
 export declare class UnionType extends Type {
     types: Type[];
+    readonly type: string;
     constructor(types: Type[]);
@@ -5,0 +6,0 @@ clone(): Type;

dist/lib/models/types/union.js

@@ -18,2 +18,3 @@ "use strict";
         var _this = _super.call(this) || this;
+        _this.type = 'union';
         _this.types = types;
@@ -38,3 +39,2 @@ return _this;
         var result = _super.prototype.toObject.call(this);
-        result.type = 'union';
         if (this.types && this.types.length) {
@@ -41,0 +41,0 @@ result.types = this.types.map(function (e) { return e.toObject(); });

dist/lib/models/types/unknown.d.ts

 import { Type } from './abstract';
 export declare class UnknownType extends Type {
     name: string;
+    readonly type: string;
     constructor(name: string);
@@ -5,0 +6,0 @@ clone(): Type;

dist/lib/models/types/unknown.js

@@ -18,2 +18,3 @@ "use strict";
         var _this = _super.call(this) || this;
+        _this.type = 'unknown';
         _this.name = name;
@@ -34,3 +35,2 @@ return _this;
         var result = _super.prototype.toObject.call(this);
-        result.type = 'unknown';
         result.name = this.name;
@@ -37,0 +37,0 @@ return result;

package.json

 {
   "name": "typedoc",
   "description": "Create api documentations for typescript projects.",
-  "version": "0.5.10",
+  "version": "0.6.0",
   "homepage": "http://typedoc.org",
@@ -33,3 +33,3 @@ "main": "dist/index.js",
   "dependencies": {
-    "@types/fs-extra": "0.0.33",
+    "@types/fs-extra": "^2.0.0",
     "@types/handlebars": "^4.0.31",
@@ -40,5 +40,5 @@ "@types/highlight.js": "^9.1.8",
     "@types/minimatch": "^2.0.29",
-    "@types/shelljs": "^0.3.32",
+    "@types/shelljs": "^0.7.0",
     "fs-extra": "^2.0.0",
-    "handlebars": "4.0.5",
+    "handlebars": "^4.0.6",
     "highlight.js": "^9.0.0",
@@ -48,3 +48,3 @@ "lodash": "^4.13.1",
     "minimatch": "^3.0.0",
-    "progress": "^1.1.8",
+    "progress": "^2.0.0",
     "shelljs": "^0.7.0",
@@ -64,6 +64,6 @@ "typedoc-default-themes": "^0.4.2",
     "grunt-ts": "^5.5.1",
-    "grunt-tslint": "^4.0.1",
+    "grunt-tslint": "^5.0.1",
     "istanbul": "^0.4.1",
     "mocha": "^3.0.2",
-    "tslint": "^4.4.2"
+    "tslint": "^5.1.0"
   },
@@ -70,0 +70,0 @@ "files": [

README.md

@@ -5,3 +5,3 @@ # TypeDoc
 
-[![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)
@@ -66,3 +66,2 @@ [![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)
   Prevent private members from being included in the generated documentation.
-  
 
@@ -91,2 +90,4 @@ #### TypeScript compiler
   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.
 
@@ -128,2 +129,3 @@ #### Content
 * [External Module Name](https://github.com/christopherthielen/typedoc-plugin-external-module-name) - Set the name of TypeDoc external modules
+* [Sourcefile URL](https://github.com/gdelmas/typedoc-plugin-sourcefile-url) - Set custom source file URL links
 
@@ -146,2 +148,3 @@ ## Advanced guides and docs
 Copyright (c) 2015 [Sebastian Lenz](http://typedoc.org).<br>
+Copyright (c) 2016-2017 [TypeDoc Contributors](https://github.com/TypeStrong/typedoc/graphs/contributors).<br>
 Licensed under the Apache License 2.0.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1236654

increased by1.36%

Number of package files

395

increased by1.54%

Lines of code

11550

increased by1.33%

Number of lines in readme file

146

increased by2.1%

Dependency changes

• + Added@types/fs-extra@2.1.0(transitive)

• + Added@types/glob@8.1.0(transitive)

• + Added@types/minimatch@5.1.2(transitive)

• + Added@types/shelljs@0.7.9(transitive)

• + Addedhandlebars@4.7.8(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedneo-async@2.6.2(transitive)

• + Addedprogress@2.0.3(transitive)

• + Addedsource-map@0.6.1(transitive)

• + Addeduglify-js@3.19.3(transitive)

• + Addedwordwrap@1.0.0(transitive)

• - Removed@types/fs-extra@0.0.33(transitive)

• - Removed@types/shelljs@0.3.33(transitive)

• - Removedalign-text@0.1.4(transitive)

• - Removedamdefine@1.0.1(transitive)

• - Removedasync@1.5.2(transitive)

• - Removedcamelcase@1.2.1(transitive)

• - Removedcenter-align@0.1.3(transitive)

• - Removedcliui@2.1.0(transitive)

• - Removeddecamelize@1.2.0(transitive)

• - Removedhandlebars@4.0.5(transitive)

• - Removedis-buffer@1.1.6(transitive)

• - Removedkind-of@3.2.2(transitive)

• - Removedlazy-cache@1.0.4(transitive)

• - Removedlongest@1.0.1(transitive)

• - Removedminimist@0.0.10(transitive)

• - Removedoptimist@0.6.1(transitive)

• - Removedprogress@1.1.8(transitive)

• - Removedrepeat-string@1.6.1(transitive)

• - Removedright-align@0.1.3(transitive)

• - Removedsource-map@0.4.40.5.7(transitive)

• - Removeduglify-js@2.8.29(transitive)

• - Removeduglify-to-browserify@1.0.2(transitive)

• - Removedwindow-size@0.1.0(transitive)

• - Removedwordwrap@0.0.20.0.3(transitive)

• - Removedyargs@3.10.0(transitive)

• Updated@types/fs-extra@^2.0.0

• Updated@types/shelljs@^0.7.0

• Updatedhandlebars@^4.0.6

• Updatedprogress@^2.0.0