typedoc 0.20.33 → 0.20.37

package/dist/lib/application.d.ts

@@ -84,8 +84,8 @@ export declare class Application extends ChildableComponent<Application, Abstrac
     /**
      * Run the converter for the given set of files and write the reflections to a json file.
      *
-     * @param out  The path and file name of the target file.
-     * @returns TRUE if the json file could be written successfully, otherwise FALSE.
+     * @param out The path and file name of the target file.
+     * @returns Whether the JSON file could be written successfully.
      */
     generateJson(project: ProjectReflection, out: string): Promise<void>;
     /**

package/dist/lib/application.js

@@ -238,8 +238,8 @@ let Application = Application_1 = class Application extends component_1.Childabl
     /**
      * Run the converter for the given set of files and write the reflections to a json file.
      *
-     * @param out  The path and file name of the target file.
-     * @returns TRUE if the json file could be written successfully, otherwise FALSE.
+     * @param out The path and file name of the target file.
+     * @returns Whether the JSON file could be written successfully.
      */
     async generateJson(project, out) {
         out = Path.resolve(out);
@@ -251,7 +251,9 @@ let Application = Application_1 = class Application extends component_1.Childabl
             begin: eventData,
             end: eventData,
         });
-        await FS.promises.writeFile(out, JSON.stringify(ser, null, "\t"));
+        const space = this.application.options.getValue("pretty") ? "\t" : "";
+        index_2.ensureDirectoriesExist(Path.dirname(out));
+        await FS.promises.writeFile(out, JSON.stringify(ser, null, space));
         this.logger.success("JSON written to %s", out);
     }
     /**

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

@@ -77,7 +77,7 @@ export declare class Context {
     expectSymbolAtLocation(node: ts.Node): ts.Symbol;
     resolveAliasedSymbol(symbol: ts.Symbol): ts.Symbol;
     createDeclarationReflection(kind: ReflectionKind, symbol: ts.Symbol | undefined, exportSymbol: ts.Symbol | undefined, nameOverride?: string): DeclarationReflection;
-    finalizeDeclarationReflection(reflection: DeclarationReflection, symbol: ts.Symbol | undefined, exportSymbol?: ts.Symbol): void;
+    finalizeDeclarationReflection(reflection: DeclarationReflection, symbol: ts.Symbol | undefined, exportSymbol?: ts.Symbol, commentNode?: ts.Node): void;
     addChild(reflection: DeclarationReflection): void;
     shouldIgnore(symbol: ts.Symbol): boolean;
     /**

package/dist/lib/converter/context.js

@@ -128,10 +128,11 @@ class Context {
         this.registerReflection(reflection, symbol);
         return reflection;
     }
-    finalizeDeclarationReflection(reflection, symbol, exportSymbol) {
+    finalizeDeclarationReflection(reflection, symbol, exportSymbol, commentNode) {
+        var _a;
         this.exportSymbol = exportSymbol;
-        this.converter.trigger(converter_events_1.ConverterEvents.CREATE_DECLARATION, this, reflection, symbol &&
-            this.converter.getNodesForSymbol(symbol, reflection.kind)[0]);
+        this.converter.trigger(converter_events_1.ConverterEvents.CREATE_DECLARATION, this, reflection, (_a = (symbol &&
+            this.converter.getNodesForSymbol(symbol, reflection.kind)[0])) !== null && _a !== void 0 ? _a : commentNode);
         this.exportSymbol = undefined;
     }
     addChild(reflection) {

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

@@ -27,10 +27,17 @@ function convertExpression(expression) {
         case ts.SyntaxKind.NumericLiteral:
         case ts.SyntaxKind.PrefixUnaryExpression:
             return expression.getText();
-        default:
-            // More complex expressions are generally not useful in the documentation.
-            // Show that there was a value, but not specifics.
-            return "...";
     }
+    if (ts.isArrayLiteralExpression(expression) &&
+        expression.elements.length === 0) {
+        return "[]";
+    }
+    if (ts.isObjectLiteralExpression(expression) &&
+        expression.properties.length === 0) {
+        return "{}";
+    }
+    // More complex expressions are generally not useful in the documentation.
+    // Show that there was a value, but not specifics.
+    return "...";
 }
 exports.convertExpression = convertExpression;

package/dist/lib/converter/converter.js

@@ -175,7 +175,7 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
         }
         else {
             const reflection = context.createDeclarationReflection(index_1.ReflectionKind.Module, symbol, void 0, entryName);
-            context.finalizeDeclarationReflection(reflection, symbol);
+            context.finalizeDeclarationReflection(reflection, symbol, void 0, node);
             moduleContext = context.withScope(reflection);
         }
         for (const exp of getExports(context, node, symbol).filter((exp) => isDirectExport(context.resolveAliasedSymbol(exp), node))) {

package/dist/lib/converter/symbols.js

@@ -38,10 +38,19 @@ for (const key of Object.keys(symbolConverters)) {
     }
 }
 function convertSymbol(context, symbol, exportSymbol) {
-    var _a;
+    var _a, _b;
     if (context.shouldIgnore(symbol)) {
         return;
     }
+    // This check can catch symbols which ought to be documented as references
+    // but aren't aliased symbols because `export *` was used.
+    const previous = context.project.getReflectionFromSymbol(symbol);
+    if (!context.converter.application.options.getValue("disableAliases") &&
+        previous &&
+        ((_a = previous.parent) === null || _a === void 0 ? void 0 : _a.kindOf(models_1.ReflectionKind.Module | models_1.ReflectionKind.Project))) {
+        createAlias(previous, context, symbol, exportSymbol);
+        return;
+    }
     let flags = enum_1.removeFlag(symbol.flags, ts.SymbolFlags.Transient |
         ts.SymbolFlags.Assignment |
         ts.SymbolFlags.Optional |
@@ -69,7 +78,7 @@ function convertSymbol(context, symbol, exportSymbol) {
         if (!(flag in symbolConverters)) {
             context.logger.verbose(`Missing converter for symbol: ${symbol.name} with flag ${ts.SymbolFlags[flag]}`);
         }
-        (_a = symbolConverters[flag]) === null || _a === void 0 ? void 0 : _a.call(symbolConverters, context, symbol, exportSymbol);
+        (_b = symbolConverters[flag]) === null || _b === void 0 ? void 0 : _b.call(symbolConverters, context, symbol, exportSymbol);
     }
 }
 exports.convertSymbol = convertSymbol;
@@ -313,11 +322,6 @@ function convertProperty(context, symbol, exportSymbol) {
             parameterType = declaration.type;
         }
         setModifiers(symbol, declaration, reflection);
-        const parentSymbol = context.project.getSymbolFromReflection(context.scope);
-        assert(parentSymbol, "Tried to convert a property without a parent.");
-        if (ts.isPrivateIdentifier(declaration.name)) {
-            reflection.setFlag(models_1.ReflectionFlag.Private);
-        }
     }
     reflection.defaultValue = declaration && convert_expression_1.convertDefaultValue(declaration);
     // FIXME: This is a horrible hack because getTypeOfSymbol is not exposed.
@@ -371,22 +375,26 @@ function convertConstructSignatures(context, symbol) {
     }
 }
 function convertAlias(context, symbol, exportSymbol) {
-    var _a;
     const reflection = context.project.getReflectionFromSymbol(context.resolveAliasedSymbol(symbol));
-    if (!reflection) {
+    if (!reflection ||
+        context.converter.application.options.getValue("disableAliases")) {
         // We don't have this, convert it.
         convertSymbol(context, context.resolveAliasedSymbol(symbol), exportSymbol !== null && exportSymbol !== void 0 ? exportSymbol : symbol);
     }
     else {
-        // We already have this. Create a reference.
-        const ref = new models_1.ReferenceReflection((_a = exportSymbol === null || exportSymbol === void 0 ? void 0 : exportSymbol.name) !== null && _a !== void 0 ? _a : symbol.name, reflection, context.scope);
-        context.addChild(ref);
-        context.registerReflection(ref, symbol);
-        context.trigger(converter_events_1.ConverterEvents.CREATE_DECLARATION, ref, 
-        // FIXME this isn't good enough.
-        context.converter.getNodesForSymbol(symbol, models_1.ReflectionKind.Reference)[0]);
+        createAlias(reflection, context, symbol, exportSymbol);
     }
 }
+function createAlias(target, context, symbol, exportSymbol) {
+    var _a;
+    // We already have this. Create a reference.
+    const ref = new models_1.ReferenceReflection((_a = exportSymbol === null || exportSymbol === void 0 ? void 0 : exportSymbol.name) !== null && _a !== void 0 ? _a : symbol.name, target, context.scope);
+    context.addChild(ref);
+    context.registerReflection(ref, symbol);
+    context.trigger(converter_events_1.ConverterEvents.CREATE_DECLARATION, ref, 
+    // FIXME this isn't good enough.
+    context.converter.getNodesForSymbol(symbol, models_1.ReflectionKind.Reference)[0]);
+}
 function convertVariable(context, symbol, exportSymbol) {
     var _a;
     const declaration = (_a = symbol.getDeclarations()) === null || _a === void 0 ? void 0 : _a[0];
@@ -464,8 +472,13 @@ function isInherited(context, symbol) {
 function setModifiers(symbol, declaration, reflection) {
     var _a;
     const modifiers = ts.getCombinedModifierFlags(declaration);
-    // Note: We only set this flag if the modifier is present because we allow
-    // fake "private" or "protected" members via @private and @protected
+    if (ts.isMethodDeclaration(declaration) ||
+        ts.isPropertyDeclaration(declaration) ||
+        ts.isAccessor(declaration)) {
+        if (ts.isPrivateIdentifier(declaration.name)) {
+            reflection.setFlag(models_1.ReflectionFlag.Private);
+        }
+    }
     if (enum_1.hasAllFlags(modifiers, ts.ModifierFlags.Private)) {
         reflection.setFlag(models_1.ReflectionFlag.Private);
     }

package/dist/lib/converter/types.js

@@ -77,10 +77,6 @@ function convertType(context, typeOrNode) {
         }
         return requestBugReport(context, typeOrNode);
     }
-    // TS 4.2 added this to enable better tracking of type aliases.
-    if (typeOrNode.isUnion() && typeOrNode.origin) {
-        return convertType(context, typeOrNode.origin);
-    }
     // IgnoreErrors is important, without it, we can't assert that we will get a node.
     const node = context.checker.typeToTypeNode(typeOrNode, void 0, ts.NodeBuilderFlags.IgnoreErrors);
     assert(node); // According to the TS source of typeToString, this is a bug if it does not hold.
@@ -625,6 +621,10 @@ const typeOperatorConverter = {
         // keyof will only show up with generic functions, otherwise it gets eagerly
         // resolved to a union of strings.
         if (node.operator === ts.SyntaxKind.KeyOfKeyword) {
+            // TS 4.2 added this to enable better tracking of type aliases.
+            if (type.isUnion() && type.origin) {
+                return convertType(context, type.origin);
+            }
             // There's probably an interface for this somewhere... I couldn't find it.
             const targetType = type.type;
             return new models_1.TypeOperatorType(convertType(context, targetType), "keyof");
@@ -640,6 +640,10 @@ const unionConverter = {
         return new models_1.UnionType(node.types.map((type) => convertType(context, type)));
     },
     convertType(context, type) {
+        // TS 4.2 added this to enable better tracking of type aliases.
+        if (type.origin) {
+            return convertType(context, type.origin);
+        }
         return new models_1.UnionType(type.types.map((type) => convertType(context, type)));
     },
 };

package/dist/lib/output/plugins/MarkedPlugin.d.ts

@@ -51,6 +51,8 @@ export declare class MarkedPlugin extends ContextAwareRendererComponent {
      * The pattern used to find media links.
      */
     private mediaPattern;
+    private sources?;
+    private outputFileName?;
     /**
      * Create a new MarkedPlugin instance.
      */

package/dist/lib/output/plugins/MarkedPlugin.js

@@ -75,6 +75,9 @@ let MarkedPlugin = class MarkedPlugin extends components_1.ContextAwareRendererC
         // eslint-disable-next-line @typescript-eslint/no-this-alias
         const that = this;
         Handlebars.registerHelper("markdown", function (arg) {
+            const root = arg.data.root;
+            that.outputFileName = root.filename;
+            that.sources = root.model.sources;
             return that.parseMarkdown(arg.fn(this), this);
         });
         Handlebars.registerHelper("relativeURL", (url) => url ? this.getRelativeUrl(url) : url);
@@ -87,11 +90,18 @@ let MarkedPlugin = class MarkedPlugin extends components_1.ContextAwareRendererC
      * @return A html string with syntax highlighting.
      */
     getHighlighted(text, lang) {
+        var _a;
         lang = lang || "typescript";
         lang = lang.toLowerCase();
         if (!highlighter_1.isSupportedLanguage(lang)) {
             // Extra newline because of the progress bar
-            this.application.logger.warn(`\nUnsupported highlight language "${lang}" will not be highlighted. Run typedoc --help for a list of supported languages.`);
+            this.application.logger.warn(`
+Unsupported highlight language "${lang}" will not be highlighted. Run typedoc --help for a list of supported languages.
+target code block :
+\t${text.split("\n").join("\n\t")}
+source files :${(_a = this.sources) === null || _a === void 0 ? void 0 : _a.map((source) => `\n\t${source.fileName}`).join()}
+output file :
+\t${this.outputFileName}`);
             return text;
         }
         return highlighter_1.highlight(text, lang, this.theme);

package/dist/lib/output/renderer.js

@@ -75,6 +75,7 @@ let Renderer = Renderer_1 = class Renderer extends component_1.ChildableComponen
         output.settings = this.application.options.getRawValues();
         output.urls = this.theme.getUrls(project);
         const bar = new ProgressBar("Rendering [:bar] :percent", {
+            stream: process.stdout,
             total: output.urls.length,
             width: 40,
         });

package/dist/lib/output/themes/DefaultTheme.js

@@ -333,10 +333,7 @@ class NavigationBuilder {
                 }
                 target = target.parent;
             }
-            if (inScope &&
-                someModule instanceof index_1.DeclarationReflection &&
-                someModule.children &&
-                someModule.children.length > 0) {
+            if (inScope && someModule instanceof index_1.DeclarationReflection) {
                 modules.push(someModule);
             }
         });

package/dist/lib/utils/options/declaration.d.ts

@@ -32,6 +32,7 @@ export interface TypeDocOptionMap {
     excludeNotDocumented: boolean;
     excludeInternal: boolean;
     disableSources: boolean;
+    disableAliases: boolean;
     includes: string;
     media: string;
     emit: boolean;
@@ -39,6 +40,7 @@ export interface TypeDocOptionMap {
     preserveWatchOutput: boolean;
     out: string;
     json: string;
+    pretty: boolean;
     theme: string;
     name: string;
     includeVersion: boolean;

package/dist/lib/utils/options/sources/typedoc.js

@@ -13,7 +13,7 @@ function addTypeDocOptions(options) {
     });
     options.addDeclaration({
         name: "tsconfig",
-        help: "Specify a typescript config file that should be loaded. If not specified TypeDoc will look for 'tsconfig.json' in the current directory.",
+        help: "Specify a TypeScript config file that should be loaded. If not specified TypeDoc will look for 'tsconfig.json' in the current directory.",
         hint: declaration_1.ParameterHint.File,
         defaultValue: process.cwd(),
     });
@@ -45,7 +45,7 @@ function addTypeDocOptions(options) {
     });
     options.addDeclaration({
         name: "excludeInternal",
-        help: "Prevent symbols that marked with @internal from being documented.",
+        help: "Prevent symbols that are marked with @internal from being documented.",
         type: declaration_1.ParameterType.Boolean,
     });
     options.addDeclaration({
@@ -63,6 +63,11 @@ function addTypeDocOptions(options) {
         help: "Disables setting the source of a reflection when documenting it.",
         type: declaration_1.ParameterType.Boolean,
     });
+    options.addDeclaration({
+        name: "disableAliases",
+        help: "Disables creating aliases for shared reflections.",
+        type: declaration_1.ParameterType.Boolean,
+    });
     options.addDeclaration({
         name: "includes",
         help: "Specifies the location to look for included documents (use [[include:FILENAME]] in comments).",
@@ -95,12 +100,18 @@ function addTypeDocOptions(options) {
     });
     options.addDeclaration({
         name: "json",
-        help: "Specifies the location and file name a json file describing the project is written to.",
+        help: "Specifies the location and filename a JSON file describing the project is written to.",
         hint: declaration_1.ParameterHint.File,
     });
+    options.addDeclaration({
+        name: "pretty",
+        help: "Specifies whether the output JSON should be formatted with tabs.",
+        type: declaration_1.ParameterType.Boolean,
+        defaultValue: true,
+    });
     options.addDeclaration({
         name: "theme",
-        help: "Specify the path to the theme that should be used or 'default' or 'minimal' to use built-in themes.",
+        help: "Specify the path to the theme that should be used, or 'default' or 'minimal' to use built-in themes.",
         type: declaration_1.ParameterType.String,
         defaultValue: "default",
     });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.20.33",
+  "version": "0.20.37",
   "homepage": "https://typedoc.org",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -25,35 +25,35 @@
     "handlebars": "^4.7.7",
     "lodash": "^4.17.21",
     "lunr": "^2.3.9",
-    "marked": "^2.0.1",
+    "marked": "~2.0.3",
     "minimatch": "^3.0.0",
     "progress": "^2.0.3",
     "shelljs": "^0.8.4",
     "shiki": "^0.9.3",
-    "typedoc-default-themes": "^0.12.9"
+    "typedoc-default-themes": "^0.12.10"
   },
   "peerDependencies": {
     "typescript": "3.9.x || 4.0.x || 4.1.x || 4.2.x"
   },
   "devDependencies": {
-    "@types/fs-extra": "^9.0.8",
+    "@types/fs-extra": "^9.0.11",
     "@types/lodash": "^4.14.168",
     "@types/lunr": "^2.3.3",
-    "@types/marked": "^2.0.0",
-    "@types/minimatch": "3.0.3",
-    "@types/mocha": "^8.2.1",
+    "@types/marked": "^2.0.2",
+    "@types/minimatch": "3.0.4",
+    "@types/mocha": "^8.2.2",
     "@types/mockery": "^1.4.29",
-    "@types/node": "^14.14.34",
+    "@types/node": "^14.14.41",
     "@types/semver": "^7.3.4",
     "@types/shelljs": "^0.8.8",
-    "@typescript-eslint/eslint-plugin": "^4.17.0",
-    "@typescript-eslint/parser": "^4.17.0",
-    "eslint": "^7.22.0",
-    "mocha": "^8.3.0",
+    "@typescript-eslint/eslint-plugin": "^4.22.0",
+    "@typescript-eslint/parser": "^4.22.0",
+    "eslint": "^7.24.0",
+    "mocha": "^8.3.2",
     "mockery": "^2.1.0",
     "nyc": "^15.1.0",
     "prettier": "^2.2.1",
-    "typescript": "^4.2.3"
+    "typescript": "^4.2.4"
   },
   "files": [
     "bin",