typedoc 0.23.7 → 0.23.8

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

@@ -4,6 +4,7 @@ import { ProjectReflection, SomeType } from "../models/index";
 import { Context } from "./context";
 import { ConverterComponent } from "./components";
 import { ChildableComponent } from "../utils/component";
+import { MinimalSourceFile } from "../utils";
 import type { DocumentationEntryPoint } from "../utils/entry-point";
 import { CommentParserConfig } from "./comments";
 import type { CommentStyle } from "../utils/options/declaration";
@@ -51,7 +52,8 @@ export declare class Converter extends ChildableComponent<Application, Converter
     static readonly EVENT_CREATE_DECLARATION: "createDeclaration";
     /**
      * Triggered when the converter has created a signature reflection.
-     * The listener will be given {@link Context}, {@link SignatureReflection} | {@link ProjectReflection} and a `ts.Node?`
+     * The listener will be given {@link Context}, {@link SignatureReflection} | {@link ProjectReflection} and
+     * `ts.SignatureDeclaration | ts.IndexSignatureDeclaration | ts.JSDocSignature | undefined`
      * @event
      */
     static readonly EVENT_CREATE_SIGNATURE: "createSignature";
@@ -103,6 +105,10 @@ export declare class Converter extends ChildableComponent<Application, Converter
      * @internal
      */
     convertType(context: Context, node: ts.TypeNode | ts.Type | undefined): SomeType;
+    /**
+     * Parse the given file into a comment. Intended to be used with markdown files.
+     */
+    parseRawComment(file: MinimalSourceFile): import("../models/index").Comment;
     /**
      * Compile the files within the given context and convert the compiler symbols to reflections.
      *

package/dist/lib/converter/converter.js

@@ -60,6 +60,12 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
     convertType(context, node) {
         return (0, types_1.convertType)(context, node);
     }
+    /**
+     * Parse the given file into a comment. Intended to be used with markdown files.
+     */
+    parseRawComment(file) {
+        return (0, parser_1.parseComment)((0, rawLexer_1.lexCommentString)(file.text), this.config, file, this.application.logger);
+    }
     /**
      * Compile the files within the given context and convert the compiler symbols to reflections.
      *
@@ -110,7 +116,7 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
             const reflection = context.createDeclarationReflection(index_1.ReflectionKind.Module, symbol, void 0, entryName);
             if (entryPoint.readmeFile) {
                 const readme = (0, utils_1.readFile)(entryPoint.readmeFile);
-                const comment = (0, parser_1.parseComment)((0, rawLexer_1.lexCommentString)(readme), context.converter.config, new utils_1.MinimalSourceFile(readme, entryPoint.readmeFile), context.logger);
+                const comment = this.parseRawComment(new utils_1.MinimalSourceFile(readme, entryPoint.readmeFile));
                 if (comment.blockTags.length || comment.modifierTags.size) {
                     const ignored = [
                         ...comment.blockTags.map((tag) => tag.tag),
@@ -206,7 +212,8 @@ Converter.EVENT_END = converter_events_1.ConverterEvents.END;
 Converter.EVENT_CREATE_DECLARATION = converter_events_1.ConverterEvents.CREATE_DECLARATION;
 /**
  * Triggered when the converter has created a signature reflection.
- * The listener will be given {@link Context}, {@link SignatureReflection} | {@link ProjectReflection} and a `ts.Node?`
+ * The listener will be given {@link Context}, {@link SignatureReflection} | {@link ProjectReflection} and
+ * `ts.SignatureDeclaration | ts.IndexSignatureDeclaration | ts.JSDocSignature | undefined`
  * @event
  */
 Converter.EVENT_CREATE_SIGNATURE = converter_events_1.ConverterEvents.CREATE_SIGNATURE;

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

@@ -49,7 +49,7 @@ function createSignature(context, kind, signature, declaration) {
             context.scope.signatures.push(sigRef);
             break;
     }
-    context.trigger(converter_events_1.ConverterEvents.CREATE_SIGNATURE, sigRef);
+    context.trigger(converter_events_1.ConverterEvents.CREATE_SIGNATURE, sigRef, declaration);
 }
 exports.createSignature = createSignature;
 function convertParameters(context, sigRef, parameters, parameterNodes) {

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

@@ -174,14 +174,16 @@ let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent
         }
         hidden.forEach((reflection) => project.removeReflection(reflection));
         // remove functions with empty signatures after their signatures have been removed
-        const [allRemoved, someRemoved] = (0, utils_1.partition)((0, utils_1.filterMap)(hidden, (reflection) => reflection.parent?.kindOf(models_1.ReflectionKind.FunctionOrMethod | models_1.ReflectionKind.Constructor)
+        const [allRemoved, someRemoved] = (0, utils_1.partition)((0, utils_1.unique)((0, utils_1.filterMap)(hidden, (reflection) => reflection.parent?.kindOf(models_1.ReflectionKind.SignatureContainer)
             ? reflection.parent
-            : void 0), (method) => method.signatures?.length === 0);
+            : void 0)), (method) => method.getNonIndexSignatures().length === 0);
         allRemoved.forEach((reflection) => {
             project.removeReflection(reflection);
         });
         someRemoved.forEach((reflection) => {
-            reflection.sources = (0, utils_1.unique)(reflection.signatures.flatMap((s) => s.sources ?? []));
+            reflection.sources = reflection
+                .getNonIndexSignatures()
+                .flatMap((s) => s.sources ?? []);
         });
     }
     /**
@@ -282,8 +284,9 @@ let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent
         }
         if (!comment) {
             if (this.excludeNotDocumented) {
-                // Only allow excludeNotDocumented to exclude root level reflections
-                if (!(reflection instanceof models_1.DeclarationReflection)) {
+                // Don't let excludeNotDocumented remove parameters.
+                if (!(reflection instanceof models_1.DeclarationReflection) &&
+                    !(reflection instanceof models_1.SignatureReflection)) {
                     return false;
                 }
                 // excludeNotDocumented should hide a module only if it has no visible children
@@ -297,6 +300,12 @@ let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent
                 if (reflection.kind === models_1.ReflectionKind.EnumMember) {
                     return false;
                 }
+                // signature containers should only be hidden if all their signatures are hidden
+                if (reflection.kindOf(models_1.ReflectionKind.SignatureContainer)) {
+                    return reflection
+                        .getAllSignatures()
+                        .every((child) => this.isHidden(child));
+                }
                 // excludeNotDocumented should never hide parts of "type" reflections
                 return inTypeLiteral(reflection) === false;
             }

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

@@ -177,6 +177,10 @@ exports.LinkResolverPlugin = LinkResolverPlugin;
 function resolveLinkTag(reflection, part, warn) {
     let pos = 0;
     const end = part.text.length;
+    while (pos < end && ts.isWhiteSpaceLike(part.text.charCodeAt(pos))) {
+        pos++;
+    }
+    const origText = part.text;
     // Try to parse one
     const declRef = (0, declarationReference_1.parseDeclarationReference)(part.text, pos, end);
     let target;
@@ -185,12 +189,20 @@ function resolveLinkTag(reflection, part, warn) {
         target = (0, declarationReferenceResolver_1.resolveDeclarationReference)(reflection, declRef[0]);
         pos = declRef[1];
     }
+    if (!target) {
+        if (urlPrefix.test(part.text)) {
+            const wsIndex = part.text.search(/\s/);
+            target =
+                wsIndex === -1 ? part.text : part.text.substring(0, wsIndex);
+            pos = target.length;
+        }
+    }
     // If resolution via a declaration reference failed, revert to the legacy "split and check"
     // method... this should go away in 0.24, once people have had a chance to migrate any failing links.
     if (!target) {
         const resolved = legacyResolveLinkTag(reflection, part);
         if (resolved) {
-            warn(`Failed to resolve {@link ${part.text}} in ${reflection.getFriendlyFullName()} with declaration references. This link will break in v0.24.`);
+            warn(`Failed to resolve {@link ${origText}} in ${reflection.getFriendlyFullName()} with declaration references. This link will break in v0.24.`);
         }
         return resolved;
     }
@@ -203,7 +215,9 @@ function resolveLinkTag(reflection, part, warn) {
         pos++;
     }
     part.target = target;
-    part.text = part.text.substring(pos).trim() || target.name;
+    part.text =
+        part.text.substring(pos).trim() ||
+            (typeof target === "string" ? target : target.name);
     return part;
 }
 function legacyResolveLinkTag(reflection, part) {

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

@@ -14,8 +14,6 @@ const converter_1 = require("../converter");
 const utils_1 = require("../../utils");
 const fs_1 = require("../../utils/fs");
 const paths_1 = require("../../utils/paths");
-const rawLexer_1 = require("../comments/rawLexer");
-const parser_1 = require("../comments/parser");
 const minimalSourceFile_1 = require("../../utils/minimalSourceFile");
 /**
  * A handler that tries to find the package.json and readme.md files of the
@@ -76,7 +74,7 @@ let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent
         const project = context.project;
         if (this.readmeFile) {
             const readme = (0, utils_1.readFile)(this.readmeFile);
-            const comment = (0, parser_1.parseComment)((0, rawLexer_1.lexCommentString)(readme), context.converter.config, new minimalSourceFile_1.MinimalSourceFile(readme, this.readmeFile), context.logger);
+            const comment = context.converter.parseRawComment(new minimalSourceFile_1.MinimalSourceFile(readme, this.readmeFile));
             if (comment.blockTags.length || comment.modifierTags.size) {
                 const ignored = [
                     ...comment.blockTags.map((tag) => tag.tag),

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

@@ -33,6 +33,7 @@ export declare class SourcePlugin extends ConverterComponent {
      * @param reflection  The reflection that is currently processed.
      */
     private onDeclaration;
+    private onSignature;
     /**
      * Triggered when the converter begins resolving a project.
      *

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

@@ -42,7 +42,7 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
         this.listenTo(this.owner, {
             [converter_1.Converter.EVENT_END]: this.onEnd,
             [converter_1.Converter.EVENT_CREATE_DECLARATION]: this.onDeclaration,
-            [converter_1.Converter.EVENT_CREATE_SIGNATURE]: this.onDeclaration,
+            [converter_1.Converter.EVENT_CREATE_SIGNATURE]: this.onSignature,
             [converter_1.Converter.EVENT_RESOLVE_BEGIN]: this.onBeginResolve,
         });
     }
@@ -77,6 +77,16 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
             reflection.sources.push(new models_1.SourceReference(fileName, position.line + 1, position.character));
         }
     }
+    onSignature(_context, reflection, sig) {
+        if (this.disableSources || !sig)
+            return;
+        const sourceFile = sig.getSourceFile();
+        const fileName = sourceFile.fileName;
+        this.fileNames.add(fileName);
+        const position = ts.getLineAndCharacterOfPosition(sourceFile, sig.getStart());
+        reflection.sources || (reflection.sources = []);
+        reflection.sources.push(new models_1.SourceReference(fileName, position.line + 1, position.character));
+    }
     /**
      * Triggered when the converter begins resolving a project.
      *

package/dist/lib/converter/utils/repository.js

@@ -44,11 +44,19 @@ class Repository {
         this.path = path;
         this.branch = gitRevision || "master";
         for (let i = 0, c = repoLinks.length; i < c; i++) {
-            let match = /(github(?:\.[a-z]+)*\.[a-z]{2,})[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
+            let match = /(github(?!.us)(?:\.[a-z]+)*\.[a-z]{2,})[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
             // Github Enterprise
             if (!match) {
                 match = /(\w+\.githubprivate.com)[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
             }
+            // Github Enterprise
+            if (!match) {
+                match = /(\w+\.ghe.com)[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
+            }
+            // Github Enterprise
+            if (!match) {
+                match = /(\w+\.github.us)[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
+            }
             if (!match) {
                 match = /(bitbucket.org)[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
             }

package/dist/lib/models/reflections/kind.d.ts

@@ -45,4 +45,9 @@ export declare namespace ReflectionKind {
     const Inheritable: number;
     /** @internal */
     const ContainsCallSignatures: number;
+    /**
+     * Note: This does not include Class/Interface, even though they technically could contain index signatures
+     * @internal
+     */
+    const SignatureContainer: number;
 }

package/dist/lib/models/reflections/kind.js

@@ -78,4 +78,9 @@ var ReflectionKind;
     ReflectionKind.ContainsCallSignatures = ReflectionKind.Constructor |
         ReflectionKind.Function |
         ReflectionKind.Method;
+    /**
+     * Note: This does not include Class/Interface, even though they technically could contain index signatures
+     * @internal
+     */
+    ReflectionKind.SignatureContainer = ReflectionKind.ContainsCallSignatures | ReflectionKind.Accessor;
 })(ReflectionKind = exports.ReflectionKind || (exports.ReflectionKind = {}));

package/dist/lib/output/themes/default/templates/reflection.js

@@ -36,7 +36,8 @@ function reflectionTemplate(context, props) {
                     context.type(props.model.indexSignature.type)),
                 context.comment(props.model.indexSignature),
                 props.model.indexSignature?.type instanceof models_1.ReflectionType &&
-                    context.parameter(props.model.indexSignature.type.declaration))))),
+                    context.parameter(props.model.indexSignature.type.declaration))),
+            !props.model.signatures && context.memberSources(props.model))),
         !!props.model.children?.length && context.index(props.model),
         context.members(props.model)));
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.23.7",
+  "version": "0.23.8",
   "homepage": "https://typedoc.org",
   "main": "./dist/index.js",
   "exports": {

package/static/style.css

@@ -942,7 +942,7 @@ a.tsd-index-link {
     margin: 2rem 0;
 }
 .tsd-panel-group.tsd-index-group details {
-    margin: 4rem 0;
+    margin: 2rem 0;
 }
 
 #tsd-search {