typedoc 0.22.2 → 0.22.6

package/bin/typedoc

@@ -105,27 +105,30 @@ async function run(app) {
         return ExitCodes.ValidationError;
     }
 
-    const out = app.options.getValue("out");
-    if (out) {
-        await app.generateDocs(project, out);
-    }
-    const json = app.options.getValue("json");
-    if (json) {
-        await app.generateJson(project, json);
-    }
-
-    if (!out && !json) {
-        await app.generateDocs(project, "./docs");
+    if (app.options.getValue("emit") !== "none") {
+        const out = app.options.getValue("out");
+        if (out) {
+            await app.generateDocs(project, out);
+        }
+        const json = app.options.getValue("json");
+        if (json) {
+            await app.generateJson(project, json);
+        }
+
+        if (!out && !json) {
+            await app.generateDocs(project, "./docs");
+        }
+
+        if (app.logger.hasErrors()) {
+            return ExitCodes.OutputError;
+        }
+        if (
+            app.options.getValue("treatWarningsAsErrors") &&
+            app.logger.hasWarnings()
+        ) {
+            return ExitCodes.OutputError;
+        }
     }
 
-    if (app.logger.hasErrors()) {
-        return ExitCodes.OutputError;
-    }
-    if (
-        app.options.getValue("treatWarningsAsErrors") &&
-        app.logger.hasWarnings()
-    ) {
-        return ExitCodes.OutputError;
-    }
     return ExitCodes.Ok;
 }

package/dist/index.d.ts

@@ -4,10 +4,10 @@ export { resetReflectionID } from "./lib/models/reflections/abstract";
 export { normalizePath } from "./lib/utils/fs";
 export * from "./lib/models";
 export { Converter, Context } from "./lib/converter";
-export { Renderer, DefaultTheme, DefaultThemeRenderContext, UrlMapping, Theme, PageEvent, RendererEvent, } from "./lib/output";
+export { Renderer, DefaultTheme, DefaultThemeRenderContext, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, } from "./lib/output";
 export type { RenderTemplate } from "./lib/output";
 export { ArgumentsReader, BindOption, JSX, LogLevel, Logger, Options, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, } from "./lib/utils";
-export type { OptionsReader, TypeDocOptions, TypeDocOptionMap, TypeDocOptionValues, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, MapDeclarationOption, DeclarationOptionToOptionType, SortStrategy, ParameterTypeToOptionTypeMap, DocumentationEntryPoint, } from "./lib/utils";
+export type { OptionsReader, TypeDocOptions, TypeDocOptionMap, ValidationOptions, TypeDocOptionValues, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, SortStrategy, ParameterTypeToOptionTypeMap, DocumentationEntryPoint, } from "./lib/utils";
 export type { EventMap, EventCallback } from "./lib/utils/events";
 export { JSONOutput, Serializer, SerializerComponent, SerializeEvent, } from "./lib/serialization";
 export type { SerializeEventData } from "./lib/serialization";

package/dist/index.js

@@ -10,7 +10,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeScript = exports.SerializeEvent = exports.SerializerComponent = exports.Serializer = exports.JSONOutput = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.BindOption = exports.ArgumentsReader = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.normalizePath = exports.resetReflectionID = exports.Event = exports.EventDispatcher = exports.Application = void 0;
+exports.TypeScript = exports.SerializeEvent = exports.SerializerComponent = exports.Serializer = exports.JSONOutput = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.BindOption = exports.ArgumentsReader = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.normalizePath = exports.resetReflectionID = exports.Event = exports.EventDispatcher = exports.Application = void 0;
 var application_1 = require("./lib/application");
 Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return application_1.Application; } });
 var events_1 = require("./lib/utils/events");
@@ -32,6 +32,7 @@ Object.defineProperty(exports, "UrlMapping", { enumerable: true, get: function (
 Object.defineProperty(exports, "Theme", { enumerable: true, get: function () { return output_1.Theme; } });
 Object.defineProperty(exports, "PageEvent", { enumerable: true, get: function () { return output_1.PageEvent; } });
 Object.defineProperty(exports, "RendererEvent", { enumerable: true, get: function () { return output_1.RendererEvent; } });
+Object.defineProperty(exports, "MarkdownEvent", { enumerable: true, get: function () { return output_1.MarkdownEvent; } });
 var utils_1 = require("./lib/utils");
 Object.defineProperty(exports, "ArgumentsReader", { enumerable: true, get: function () { return utils_1.ArgumentsReader; } });
 Object.defineProperty(exports, "BindOption", { enumerable: true, get: function () { return utils_1.BindOption; } });

package/dist/lib/application.js

@@ -17,7 +17,6 @@ const index_2 = require("./utils/index");
 const component_1 = require("./utils/component");
 const utils_1 = require("./utils");
 const array_1 = require("./utils/array");
-const path_1 = require("path");
 const exports_1 = require("./validation/exports");
 const assert_1 = require("assert");
 const entry_point_1 = require("./utils/entry-point");
@@ -145,7 +144,8 @@ let Application = Application_1 = class Application extends component_1.Childabl
             this.logger.diagnostics(errors);
             return;
         }
-        if (this.options.getValue("emit")) {
+        if (this.options.getValue("emit") === "both" ||
+            this.options.getValue("emit") === true) {
             for (const program of programs) {
                 program.emit();
             }
@@ -182,16 +182,11 @@ let Application = Application_1 = class Application extends component_1.Childabl
             this.logger.error("The packages option of entryPointStrategy is not supported in watch mode.");
             return;
         }
-        // Matches the behavior of the tsconfig option reader.
-        let tsconfigFile = this.options.getValue("tsconfig");
-        tsconfigFile =
-            (_c = ts.findConfigFile(tsconfigFile, ts.sys.fileExists, tsconfigFile.toLowerCase().endsWith(".json")
-                ? (0, path_1.basename)(tsconfigFile)
-                : undefined)) !== null && _c !== void 0 ? _c : "tsconfig.json";
+        const tsconfigFile = (_c = index_2.TSConfigReader.findConfigFile(this.options.getValue("tsconfig"))) !== null && _c !== void 0 ? _c : "tsconfig.json";
         // We don't want to do it the first time to preserve initial debug status messages. They'll be lost
         // after the user saves a file, but better than nothing...
         let firstStatusReport = true;
-        const host = ts.createWatchCompilerHost(tsconfigFile, this.options.fixCompilerOptions({}), ts.sys, ts.createEmitAndSemanticDiagnosticsBuilderProgram, (diagnostic) => this.logger.diagnostic(diagnostic), (status, newLine, _options, errorCount) => {
+        const host = ts.createWatchCompilerHost(tsconfigFile, {}, ts.sys, ts.createEmitAndSemanticDiagnosticsBuilderProgram, (diagnostic) => this.logger.diagnostic(diagnostic), (status, newLine, _options, errorCount) => {
             var _a, _b;
             if (!firstStatusReport &&
                 errorCount === void 0 &&
@@ -209,8 +204,13 @@ let Application = Application_1 = class Application extends component_1.Childabl
                 return;
             }
             if (successFinished) {
+                if (this.options.getValue("emit") === "both" ||
+                    this.options.getValue("emit") === true) {
+                    currentProgram.emit();
+                }
                 this.logger.resetErrors();
-                const entryPoints = this.getEntryPoints();
+                this.logger.resetWarnings();
+                const entryPoints = (0, entry_point_1.getWatchEntryPoints)(this.logger, this.options, currentProgram);
                 if (!entryPoints) {
                     return;
                 }
@@ -223,6 +223,14 @@ let Application = Application_1 = class Application extends component_1.Childabl
                 });
             }
         };
+        const origCreateProgram = host.createProgram;
+        host.createProgram = (rootNames, options, host, oldProgram, configDiagnostics, references) => {
+            // If we always do this, we'll get a crash the second time a program is created.
+            if (rootNames !== undefined) {
+                options = this.options.fixCompilerOptions(options || {});
+            }
+            return origCreateProgram(rootNames, options, host, oldProgram, configDiagnostics, references);
+        };
         const origAfterProgramCreate = host.afterProgramCreate;
         host.afterProgramCreate = (program) => {
             if (ts.getPreEmitDiagnostics(program.getProgram()).length === 0) {
@@ -234,7 +242,13 @@ let Application = Application_1 = class Application extends component_1.Childabl
         ts.createWatchProgram(host);
     }
     validate(project) {
-        (0, exports_1.validateExports)(project, this.logger, this.options.getValue("intentionallyNotExported"));
+        const checks = this.options.getValue("validation");
+        if (checks.notExported) {
+            (0, exports_1.validateExports)(project, this.logger, this.options.getValue("intentionallyNotExported"));
+        }
+        // checks.invalidLink is currently handled when rendering by the MarkedLinksPlugin.
+        // It should really move here, but I'm putting that off until done refactoring the comment
+        // parsing so that we don't have duplicate parse logic all over the place.
     }
     /**
      * Render HTML for the given project

package/dist/lib/converter/context.d.ts

@@ -43,7 +43,7 @@ export declare class Context {
      * /** We should use this comment */
      * export * as Mod from "./mod"
      * ```
-     * Will be removed in 0.22.
+     * Will be removed in 0.23.
      * @internal
      */
     exportSymbol?: ts.Symbol;

package/dist/lib/converter/convert-expression.js

@@ -26,6 +26,7 @@ function convertExpression(expression) {
         case ts.SyntaxKind.NullKeyword:
         case ts.SyntaxKind.NumericLiteral:
         case ts.SyntaxKind.PrefixUnaryExpression:
+        case ts.SyntaxKind.Identifier:
             return expression.getText();
     }
     if (ts.isArrayLiteralExpression(expression) &&
@@ -36,6 +37,19 @@ function convertExpression(expression) {
         expression.properties.length === 0) {
         return "{}";
     }
+    // a.b.c.d
+    if (ts.isPropertyAccessExpression(expression)) {
+        const parts = [expression.name.getText()];
+        let iter = expression.expression;
+        while (ts.isPropertyAccessExpression(iter)) {
+            parts.unshift(iter.name.getText());
+            iter = iter.expression;
+        }
+        if (ts.isIdentifier(iter)) {
+            parts.unshift(iter.text);
+            return parts.join(".");
+        }
+    }
     // More complex expressions are generally not useful in the documentation.
     // Show that there was a value, but not specifics.
     return "...";

package/dist/lib/converter/factories/comment.js

@@ -195,6 +195,9 @@ function parseComment(text, comment = new index_1.Comment()) {
         if (tagName === "return") {
             tagName = "returns";
         }
+        if (tagName === "example") {
+            line = line.replace(/<\/?caption>/g, "");
+        }
         if (tagName === "param" ||
             tagName === "typeparam" ||
             tagName === "template" ||

package/dist/lib/converter/plugins/CategoryPlugin.d.ts

@@ -1,4 +1,4 @@
-import { Reflection } from "../../models";
+import { Reflection, DeclarationReflection } from "../../models";
 import { ReflectionCategory } from "../../models/ReflectionCategory";
 import { ConverterComponent } from "../components";
 /**
@@ -42,7 +42,7 @@ export declare class CategoryPlugin extends ConverterComponent {
      * @param reflections  The reflections that should be categorized.
      * @returns An array containing all children of the given reflection categorized
      */
-    static getReflectionCategories(reflections: Reflection[]): ReflectionCategory[];
+    static getReflectionCategories(reflections: DeclarationReflection[]): ReflectionCategory[];
     /**
      * Return the category of a given reflection.
      *

package/dist/lib/converter/plugins/CommentPlugin.js

@@ -141,9 +141,29 @@ let CommentPlugin = CommentPlugin_1 = class CommentPlugin extends components_1.C
     onDeclaration(context, reflection, node) {
         var _a, _b;
         if (reflection.kindOf(index_2.ReflectionKind.FunctionOrMethod)) {
-            return;
+            // We only want a comment on functions/methods if this is a set of overloaded functions.
+            // In that case, TypeDoc lets you put a comment on the implementation, and will copy it over to
+            // the available signatures so that you can avoid documenting things multiple times.
+            // Once TypeDoc has proper support for TSDoc, this will go away since the same thing will be
+            // possible by using a @inheritDoc tag to specify that docs should be copied from a specific signature.
+            let specialOverloadCase = false;
+            if (node &&
+                (ts.isFunctionDeclaration(node) || ts.isMethodDeclaration(node))) {
+                const symbol = node.name && context.checker.getSymbolAtLocation(node.name);
+                if (symbol && symbol.declarations) {
+                    const declarations = symbol.declarations.filter((d) => ts.isFunctionDeclaration(d) ||
+                        ts.isMethodDeclaration(d));
+                    if (declarations.length > 1 &&
+                        "body" in declarations[declarations.length - 1]) {
+                        node = declarations[declarations.length - 1];
+                        specialOverloadCase = true;
+                    }
+                }
+            }
+            if (!specialOverloadCase)
+                return;
         }
-        // Clean this up in 0.22. We should really accept a ts.Symbol so we don't need exportSymbol on Context
+        // Clean this up in 0.23. We should really accept a ts.Symbol so we don't need exportSymbol on Context
         const exportNode = (_b = (_a = context.exportSymbol) === null || _a === void 0 ? void 0 : _a.getDeclarations()) === null || _b === void 0 ? void 0 : _b[0];
         let rawComment = exportNode && (0, comment_1.getRawComment)(exportNode, this.application.logger);
         rawComment !== null && rawComment !== void 0 ? rawComment : (rawComment = node && (0, comment_1.getRawComment)(node, this.application.logger));
@@ -220,13 +240,13 @@ let CommentPlugin = CommentPlugin_1 = class CommentPlugin extends components_1.C
         if (!signatures.length) {
             return;
         }
-        let movedComment = false;
         const comment = reflection.comment;
         if (comment && comment.hasTag("returns")) {
             comment.returns = comment.getTag("returns").text;
             comment.removeTags("returns");
         }
         signatures.forEach((signature) => {
+            var _a, _b;
             let childComment = signature.comment;
             if (childComment && childComment.hasTag("returns")) {
                 childComment.returns = childComment.getTag("returns").text;
@@ -234,34 +254,60 @@ let CommentPlugin = CommentPlugin_1 = class CommentPlugin extends components_1.C
             }
             if (comment) {
                 if (!childComment) {
-                    movedComment = true;
                     childComment = signature.comment = new index_1.Comment();
                 }
-                childComment.shortText =
-                    childComment.shortText || comment.shortText;
-                childComment.text = childComment.text || comment.text;
-                childComment.returns = childComment.returns || comment.returns;
-                childComment.tags = childComment.tags || comment.tags;
+                childComment.shortText || (childComment.shortText = comment.shortText);
+                childComment.text || (childComment.text = comment.text);
+                childComment.returns || (childComment.returns = comment.returns);
+                childComment.tags = childComment.tags.length
+                    ? childComment.tags
+                    : [...comment.tags];
             }
-            if (signature.parameters) {
-                signature.parameters.forEach((parameter) => {
-                    let tag;
-                    if (childComment) {
-                        tag = childComment.getTag("param", parameter.name);
-                    }
-                    if (comment && !tag) {
-                        tag = comment.getTag("param", parameter.name);
+            (_a = signature.parameters) === null || _a === void 0 ? void 0 : _a.forEach((parameter, index) => {
+                var _a;
+                let tag;
+                if (childComment && parameter.name === "__namedParameters") {
+                    const commentParams = childComment === null || childComment === void 0 ? void 0 : childComment.tags.filter((tag) => tag.tagName === "param" &&
+                        !tag.paramName.includes("."));
+                    if (((_a = signature.parameters) === null || _a === void 0 ? void 0 : _a.length) === commentParams.length &&
+                        commentParams[index].paramName) {
+                        parameter.name = commentParams[index].paramName;
                     }
-                    if (tag) {
-                        parameter.comment = new index_1.Comment(tag.text);
-                    }
-                });
-            }
+                }
+                if (childComment) {
+                    moveNestedParamTags(childComment, parameter);
+                    tag = childComment.getTag("param", parameter.name);
+                }
+                if (comment && !tag) {
+                    tag = comment.getTag("param", parameter.name);
+                }
+                if (tag) {
+                    parameter.comment = new index_1.Comment(tag.text);
+                }
+            });
+            (_b = signature.typeParameters) === null || _b === void 0 ? void 0 : _b.forEach((parameter) => {
+                let tag;
+                if (childComment) {
+                    tag =
+                        childComment.getTag("typeparam", parameter.name) ||
+                            childComment.getTag("template", parameter.name) ||
+                            childComment.getTag("param", `<${parameter.name}>`);
+                }
+                if (comment && !tag) {
+                    tag =
+                        comment.getTag("typeparam", parameter.name) ||
+                            comment.getTag("template", parameter.name) ||
+                            comment.getTag("param", `<${parameter.name}>`);
+                }
+                if (tag) {
+                    parameter.comment = new index_1.Comment(tag.text);
+                }
+            });
             childComment === null || childComment === void 0 ? void 0 : childComment.removeTags("param");
+            childComment === null || childComment === void 0 ? void 0 : childComment.removeTags("typeparam");
+            childComment === null || childComment === void 0 ? void 0 : childComment.removeTags("template");
         });
-        comment === null || comment === void 0 ? void 0 : comment.removeTags("param");
-        if (movedComment)
-            reflection.comment = void 0;
+        delete reflection.comment;
     }
     removeExcludedTags(comment) {
         for (const tag of TAG_BLACKLIST) {
@@ -301,3 +347,18 @@ CommentPlugin = CommentPlugin_1 = __decorate([
     (0, components_1.Component)({ name: "comment" })
 ], CommentPlugin);
 exports.CommentPlugin = CommentPlugin;
+// Moves tags like `@param foo.bar docs for bar` into the `bar` property of the `foo` parameter.
+function moveNestedParamTags(comment, parameter) {
+    if (parameter.type instanceof models_1.ReflectionType) {
+        const tags = comment.tags.filter((t) => t.tagName === "param" &&
+            t.paramName.startsWith(`${parameter.name}.`));
+        for (const tag of tags) {
+            const path = tag.paramName.split(".");
+            path.shift();
+            const child = parameter.type.declaration.getChildByName(path);
+            if (child && !child.comment) {
+                child.comment = new index_1.Comment(tag.text);
+            }
+        }
+    }
+}

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

@@ -1,4 +1,5 @@
 import { ConverterComponent } from "../components";
+import { RepositoryType } from "../../models";
 /**
  * Stores data of a repository.
  */
@@ -18,20 +19,24 @@ export declare class Repository {
     /**
      * The user/organization name of this repository on GitHub.
      */
-    gitHubUser?: string;
+    user?: string;
     /**
      * The project name of this repository on GitHub.
      */
-    gitHubProject?: string;
+    project?: string;
     /**
-     * The hostname for this github project.
+     * The hostname for this GitHub or Bitbucket project.
      *
      * Defaults to: `github.com` (for normal, public GitHub instance projects)
      *
      * Or the hostname for an enterprise version of GitHub, e.g. `github.acme.com`
      * (if found as a match in the list of git remotes).
      */
-    gitHubHostname: string;
+    hostname: string;
+    /**
+     * Whether this is a GitHub or Bitbucket repository.
+     */
+    type: RepositoryType;
     /**
      * Create a new Repository instance.
      *
@@ -46,12 +51,12 @@ export declare class Repository {
      */
     contains(fileName: string): boolean;
     /**
-     * Get the URL of the given file on GitHub.
+     * Get the URL of the given file on GitHub or Bitbucket.
      *
-     * @param fileName  The file whose GitHub URL should be determined.
-     * @returns An url pointing to the web preview of the given file or NULL.
+     * @param fileName  The file whose URL should be determined.
+     * @returns A URL pointing to the web preview of the given file or undefined.
      */
-    getGitHubURL(fileName: string): string | undefined;
+    getURL(fileName: string): string | undefined;
     /**
      * Try to create a new repository instance.
      *
@@ -62,6 +67,7 @@ export declare class Repository {
      * @returns A new instance of {@link Repository} or undefined.
      */
     static tryCreateRepository(path: string, gitRevision: string, gitRemote: string): Repository | undefined;
+    static getLineNumberAnchor(lineNumber: number, repositoryType: RepositoryType | undefined): string;
 }
 /**
  * A handler that watches for repositories with GitHub origin and links

package/dist/lib/converter/plugins/GitHubPlugin.js

@@ -13,6 +13,7 @@ const components_1 = require("../components");
 const base_path_1 = require("../utils/base-path");
 const converter_1 = require("../converter");
 const utils_1 = require("../../utils");
+const models_1 = require("../../models");
 function git(...args) {
     return (0, child_process_1.spawnSync)("git", args, { encoding: "utf-8", windowsHide: true });
 }
@@ -31,28 +32,39 @@ class Repository {
          */
         this.files = [];
         /**
-         * The hostname for this github project.
+         * The hostname for this GitHub or Bitbucket project.
          *
          * Defaults to: `github.com` (for normal, public GitHub instance projects)
          *
          * Or the hostname for an enterprise version of GitHub, e.g. `github.acme.com`
          * (if found as a match in the list of git remotes).
          */
-        this.gitHubHostname = "github.com";
+        this.hostname = "github.com";
+        /**
+         * Whether this is a GitHub or Bitbucket repository.
+         */
+        this.type = models_1.RepositoryType.GitHub;
         this.path = path;
         this.branch = gitRevision || "master";
         for (let i = 0, c = repoLinks.length; i < c; i++) {
-            const url = /(github(?:\.[a-z]+)*\.[a-z]{2,})[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
-            if (url) {
-                this.gitHubHostname = url[1];
-                this.gitHubUser = url[2];
-                this.gitHubProject = url[3];
-                if (this.gitHubProject.substr(-4) === ".git") {
-                    this.gitHubProject = this.gitHubProject.substr(0, this.gitHubProject.length - 4);
+            let match = /(github(?:\.[a-z]+)*\.[a-z]{2,})[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
+            if (!match) {
+                match = /(bitbucket.org)[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
+            }
+            if (match) {
+                this.hostname = match[1];
+                this.user = match[2];
+                this.project = match[3];
+                if (this.project.substr(-4) === ".git") {
+                    this.project = this.project.substr(0, this.project.length - 4);
                 }
                 break;
             }
         }
+        if (this.hostname.includes("bitbucket.org"))
+            this.type = models_1.RepositoryType.Bitbucket;
+        else
+            this.type = models_1.RepositoryType.GitHub;
         let out = git("-C", path, "ls-files");
         if (out.status === 0) {
             out.stdout.split("\n").forEach((file) => {
@@ -78,22 +90,20 @@ class Repository {
         return this.files.includes(fileName);
     }
     /**
-     * Get the URL of the given file on GitHub.
+     * Get the URL of the given file on GitHub or Bitbucket.
      *
-     * @param fileName  The file whose GitHub URL should be determined.
-     * @returns An url pointing to the web preview of the given file or NULL.
+     * @param fileName  The file whose URL should be determined.
+     * @returns A URL pointing to the web preview of the given file or undefined.
      */
-    getGitHubURL(fileName) {
-        if (!this.gitHubUser ||
-            !this.gitHubProject ||
-            !this.contains(fileName)) {
+    getURL(fileName) {
+        if (!this.user || !this.project || !this.contains(fileName)) {
             return;
         }
         return [
-            `https://${this.gitHubHostname}`,
-            this.gitHubUser,
-            this.gitHubProject,
-            "blob",
+            `https://${this.hostname}`,
+            this.user,
+            this.project,
+            this.type === "github" ? "blob" : "src",
             this.branch,
             fileName.substr(this.path.length + 1),
         ].join("/");
@@ -115,6 +125,15 @@ class Repository {
         }
         return new Repository(base_path_1.BasePath.normalize(out.stdout.replace("\n", "")), gitRevision, remotesOutput.stdout.split("\n"));
     }
+    static getLineNumberAnchor(lineNumber, repositoryType) {
+        switch (repositoryType) {
+            default:
+            case models_1.RepositoryType.GitHub:
+                return "L" + lineNumber;
+            case models_1.RepositoryType.Bitbucket:
+                return "lines-" + lineNumber;
+        }
+    }
 }
 exports.Repository = Repository;
 /**
@@ -185,7 +204,8 @@ let GitHubPlugin = class GitHubPlugin extends components_1.ConverterComponent {
         project.files.forEach((sourceFile) => {
             const repository = this.getRepository(sourceFile.fullFileName);
             if (repository) {
-                sourceFile.url = repository.getGitHubURL(sourceFile.fullFileName);
+                sourceFile.url = repository.getURL(sourceFile.fullFileName);
+                sourceFile.repositoryType = repository.type;
             }
         });
         for (const key in project.reflections) {
@@ -193,7 +213,10 @@ let GitHubPlugin = class GitHubPlugin extends components_1.ConverterComponent {
             if (reflection.sources) {
                 reflection.sources.forEach((source) => {
                     if (source.file && source.file.url) {
-                        source.url = source.file.url + "#L" + source.line;
+                        source.url =
+                            source.file.url +
+                                "#" +
+                                Repository.getLineNumberAnchor(source.line, source.file.repositoryType);
                     }
                 });
             }

package/dist/lib/converter/plugins/GroupPlugin.d.ts

@@ -1,4 +1,4 @@
-import { Reflection, ReflectionKind } from "../../models/reflections/index";
+import { ReflectionKind, DeclarationReflection } from "../../models/reflections/index";
 import { ReflectionGroup } from "../../models/ReflectionGroup";
 import { ConverterComponent } from "../components";
 import { SortStrategy } from "../../utils/sort";
@@ -53,7 +53,7 @@ export declare class GroupPlugin extends ConverterComponent {
      * @param reflections  The reflections that should be grouped.
      * @returns An array containing all children of the given reflection grouped by their kind.
      */
-    static getReflectionGroups(reflections: Reflection[]): ReflectionGroup[];
+    static getReflectionGroups(reflections: DeclarationReflection[]): ReflectionGroup[];
     /**
      * Transform the internal typescript kind identifier into a human readable version.
      *

package/dist/lib/converter/plugins/SourcePlugin.js

@@ -145,7 +145,6 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
                 });
             }
             directory.files.push(file);
-            // reflections.sort(GroupHandler.sortCallback);
             file.parent = directory;
             file.reflections = reflections;
         });

package/dist/lib/converter/plugins/index.d.ts

@@ -1,7 +1,6 @@
 export { CategoryPlugin } from "./CategoryPlugin";
 export { CommentPlugin } from "./CommentPlugin";
 export { DecoratorPlugin } from "./DecoratorPlugin";
-export { DeepCommentPlugin } from "./DeepCommentPlugin";
 export { GitHubPlugin } from "./GitHubPlugin";
 export { GroupPlugin } from "./GroupPlugin";
 export { ImplementsPlugin } from "./ImplementsPlugin";

package/dist/lib/converter/plugins/index.js

@@ -1,14 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InheritDocPlugin = exports.TypePlugin = exports.SourcePlugin = exports.PackagePlugin = exports.ImplementsPlugin = exports.GroupPlugin = exports.GitHubPlugin = exports.DeepCommentPlugin = exports.DecoratorPlugin = exports.CommentPlugin = exports.CategoryPlugin = void 0;
+exports.InheritDocPlugin = exports.TypePlugin = exports.SourcePlugin = exports.PackagePlugin = exports.ImplementsPlugin = exports.GroupPlugin = exports.GitHubPlugin = exports.DecoratorPlugin = exports.CommentPlugin = exports.CategoryPlugin = void 0;
 var CategoryPlugin_1 = require("./CategoryPlugin");
 Object.defineProperty(exports, "CategoryPlugin", { enumerable: true, get: function () { return CategoryPlugin_1.CategoryPlugin; } });
 var CommentPlugin_1 = require("./CommentPlugin");
 Object.defineProperty(exports, "CommentPlugin", { enumerable: true, get: function () { return CommentPlugin_1.CommentPlugin; } });
 var DecoratorPlugin_1 = require("./DecoratorPlugin");
 Object.defineProperty(exports, "DecoratorPlugin", { enumerable: true, get: function () { return DecoratorPlugin_1.DecoratorPlugin; } });
-var DeepCommentPlugin_1 = require("./DeepCommentPlugin");
-Object.defineProperty(exports, "DeepCommentPlugin", { enumerable: true, get: function () { return DeepCommentPlugin_1.DeepCommentPlugin; } });
 var GitHubPlugin_1 = require("./GitHubPlugin");
 Object.defineProperty(exports, "GitHubPlugin", { enumerable: true, get: function () { return GitHubPlugin_1.GitHubPlugin; } });
 var GroupPlugin_1 = require("./GroupPlugin");