typedoc 0.23.7 → 0.23.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/dist/lib/converter/comments/discovery.js +11 -2
  2. package/dist/lib/converter/comments/index.js +13 -1
  3. package/dist/lib/converter/comments/linkResolver.d.ts +4 -0
  4. package/dist/lib/converter/comments/linkResolver.js +186 -0
  5. package/dist/lib/converter/converter.d.ts +13 -3
  6. package/dist/lib/converter/converter.js +29 -7
  7. package/dist/lib/converter/factories/signature.js +2 -1
  8. package/dist/lib/converter/plugins/CommentPlugin.js +25 -7
  9. package/dist/lib/converter/plugins/LinkResolverPlugin.d.ts +0 -21
  10. package/dist/lib/converter/plugins/LinkResolverPlugin.js +6 -188
  11. package/dist/lib/converter/plugins/PackagePlugin.js +1 -3
  12. package/dist/lib/converter/plugins/SourcePlugin.d.ts +1 -0
  13. package/dist/lib/converter/plugins/SourcePlugin.js +11 -1
  14. package/dist/lib/converter/utils/repository.js +9 -1
  15. package/dist/lib/models/reflections/abstract.js +7 -4
  16. package/dist/lib/models/reflections/kind.d.ts +5 -0
  17. package/dist/lib/models/reflections/kind.js +5 -0
  18. package/dist/lib/models/types.js +1 -1
  19. package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts +3 -3
  20. package/dist/lib/output/themes/default/DefaultThemeRenderContext.js +4 -0
  21. package/dist/lib/output/themes/default/partials/comment.d.ts +1 -1
  22. package/dist/lib/output/themes/default/partials/comment.js +3 -3
  23. package/dist/lib/output/themes/default/partials/index.js +2 -2
  24. package/dist/lib/output/themes/default/partials/navigation.js +2 -2
  25. package/dist/lib/output/themes/default/templates/index.d.ts +1 -1
  26. package/dist/lib/output/themes/default/templates/index.js +2 -3
  27. package/dist/lib/output/themes/default/templates/reflection.js +2 -1
  28. package/dist/lib/output/themes/lib.d.ts +5 -1
  29. package/dist/lib/output/themes/lib.js +16 -1
  30. package/dist/lib/utils/entry-point.js +3 -1
  31. package/package.json +16 -16
  32. package/static/style.css +1 -1
  33. package/tsdoc.json +1 -1
@@ -39,6 +39,9 @@ const wantedKinds = {
39
39
  [models_1.ReflectionKind.Function]: [
40
40
  ts.SyntaxKind.FunctionDeclaration,
41
41
  ts.SyntaxKind.BindingElement,
42
+ ts.SyntaxKind.VariableDeclaration,
43
+ ts.SyntaxKind.ExportAssignment,
44
+ ts.SyntaxKind.PropertyAccessExpression,
42
45
  ],
43
46
  [models_1.ReflectionKind.Class]: [
44
47
  ts.SyntaxKind.ClassDeclaration,
@@ -51,6 +54,8 @@ const wantedKinds = {
51
54
  ts.SyntaxKind.PropertySignature,
52
55
  ts.SyntaxKind.BinaryExpression,
53
56
  ts.SyntaxKind.PropertyAssignment,
57
+ // class X { constructor(/** Comment */ readonly z: any) }
58
+ ts.SyntaxKind.Parameter,
54
59
  ],
55
60
  [models_1.ReflectionKind.Method]: [
56
61
  ts.SyntaxKind.FunctionDeclaration,
@@ -98,8 +103,12 @@ function discoverComment(symbol, kind, logger, commentStyle) {
98
103
  // However, we don't want to skip the node if it is a reference to something.
99
104
  // See the gh1770 test for an example.
100
105
  if (kind & models_1.ReflectionKind.ContainsCallSignatures &&
101
- !node.body &&
102
- node.kind !== ts.SyntaxKind.BindingElement) {
106
+ [
107
+ ts.SyntaxKind.FunctionDeclaration,
108
+ ts.SyntaxKind.MethodDeclaration,
109
+ ts.SyntaxKind.Constructor,
110
+ ].includes(node.kind) &&
111
+ !node.body) {
103
112
  continue;
104
113
  }
105
114
  const comments = collectCommentRanges(ts.getLeadingCommentRanges(text, node.pos));
@@ -8,6 +8,13 @@ const blockLexer_1 = require("./blockLexer");
8
8
  const discovery_1 = require("./discovery");
9
9
  const lineLexer_1 = require("./lineLexer");
10
10
  const parser_1 = require("./parser");
11
+ const jsDocCommentKinds = [
12
+ ts.SyntaxKind.JSDocPropertyTag,
13
+ ts.SyntaxKind.JSDocCallbackTag,
14
+ ts.SyntaxKind.JSDocTypedefTag,
15
+ ts.SyntaxKind.JSDocTemplateTag,
16
+ ts.SyntaxKind.JSDocEnumTag,
17
+ ];
11
18
  const commentCache = new WeakMap();
12
19
  function getCommentWithCache(discovered, config, logger) {
13
20
  if (!discovered)
@@ -52,6 +59,11 @@ function getCommentImpl(commentSource, config, logger, moduleComment) {
52
59
  return comment;
53
60
  }
54
61
  function getComment(symbol, kind, config, logger, commentStyle) {
62
+ if (symbol
63
+ .getDeclarations()
64
+ ?.every((d) => jsDocCommentKinds.includes(d.kind))) {
65
+ return getJsDocComment(symbol.declarations[0], config, logger);
66
+ }
55
67
  return getCommentImpl((0, discovery_1.discoverComment)(symbol, kind, logger, commentStyle), config, logger, symbol.declarations?.some(ts.isSourceFile) || false);
56
68
  }
57
69
  exports.getComment = getComment;
@@ -106,7 +118,7 @@ function getJsDocComment(declaration, config, logger) {
106
118
  logger.error(`Failed to find JSDoc tag for ${name} after parsing comment, please file a bug report.`, declaration);
107
119
  }
108
120
  else {
109
- return new models_1.Comment(tag.content.slice());
121
+ return new models_1.Comment(models_1.Comment.cloneDisplayParts(tag.content));
110
122
  }
111
123
  }
112
124
  exports.getJsDocComment = getJsDocComment;
@@ -0,0 +1,4 @@
1
+ import { Comment, CommentDisplayPart, Reflection } from "../../models";
2
+ import type { Logger, ValidationOptions } from "../../utils";
3
+ export declare function resolveLinks(comment: Comment, reflection: Reflection, validation: ValidationOptions, logger: Logger): void;
4
+ export declare function resolvePartLinks(reflection: Reflection, parts: readonly CommentDisplayPart[], warn: () => void, validation: ValidationOptions, logger: Logger): CommentDisplayPart[];
@@ -0,0 +1,186 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.resolvePartLinks = exports.resolveLinks = void 0;
4
+ const ts = require("typescript");
5
+ const models_1 = require("../../models");
6
+ const declarationReference_1 = require("./declarationReference");
7
+ const declarationReferenceResolver_1 = require("./declarationReferenceResolver");
8
+ const urlPrefix = /^(http|ftp)s?:\/\//;
9
+ const brackets = /\[\[(?!include:)([^\]]+)\]\]/g;
10
+ function resolveLinks(comment, reflection, validation, logger) {
11
+ let warned = false;
12
+ const warn = () => {
13
+ if (!warned) {
14
+ warned = true;
15
+ logger.warn(`${reflection.getFriendlyFullName()}: Comment [[target]] style links are deprecated and will be removed in 0.24`);
16
+ }
17
+ };
18
+ comment.summary = resolvePartLinks(reflection, comment.summary, warn, validation, logger);
19
+ for (const tag of comment.blockTags) {
20
+ tag.content = resolvePartLinks(reflection, tag.content, warn, validation, logger);
21
+ }
22
+ if (reflection instanceof models_1.DeclarationReflection && reflection.readme) {
23
+ reflection.readme = resolvePartLinks(reflection, reflection.readme, warn, validation, logger);
24
+ }
25
+ }
26
+ exports.resolveLinks = resolveLinks;
27
+ function resolvePartLinks(reflection, parts, warn, validation, logger) {
28
+ return parts.flatMap((part) => processPart(reflection, part, warn, validation, logger));
29
+ }
30
+ exports.resolvePartLinks = resolvePartLinks;
31
+ function processPart(reflection, part, warn, validation, logger) {
32
+ if (part.kind === "text" && brackets.test(part.text)) {
33
+ warn();
34
+ return replaceBrackets(reflection, part.text, validation, logger);
35
+ }
36
+ if (part.kind === "inline-tag") {
37
+ if (part.tag === "@link" ||
38
+ part.tag === "@linkcode" ||
39
+ part.tag === "@linkplain") {
40
+ return resolveLinkTag(reflection, part, (msg) => {
41
+ if (validation.invalidLink) {
42
+ logger.warn(msg);
43
+ }
44
+ });
45
+ }
46
+ }
47
+ return part;
48
+ }
49
+ function resolveLinkTag(reflection, part, warn) {
50
+ let pos = 0;
51
+ const end = part.text.length;
52
+ while (pos < end && ts.isWhiteSpaceLike(part.text.charCodeAt(pos))) {
53
+ pos++;
54
+ }
55
+ const origText = part.text;
56
+ // Try to parse one
57
+ const declRef = (0, declarationReference_1.parseDeclarationReference)(part.text, pos, end);
58
+ let target;
59
+ if (declRef) {
60
+ // Got one, great! Try to resolve the link
61
+ target = (0, declarationReferenceResolver_1.resolveDeclarationReference)(reflection, declRef[0]);
62
+ pos = declRef[1];
63
+ }
64
+ if (!target) {
65
+ if (urlPrefix.test(part.text)) {
66
+ const wsIndex = part.text.search(/\s/);
67
+ target =
68
+ wsIndex === -1 ? part.text : part.text.substring(0, wsIndex);
69
+ pos = target.length;
70
+ }
71
+ }
72
+ // If resolution via a declaration reference failed, revert to the legacy "split and check"
73
+ // method... this should go away in 0.24, once people have had a chance to migrate any failing links.
74
+ if (!target) {
75
+ const resolved = legacyResolveLinkTag(reflection, part);
76
+ if (resolved) {
77
+ warn(`Failed to resolve {@link ${origText}} in ${reflection.getFriendlyFullName()} with declaration references. This link will break in v0.24.`);
78
+ }
79
+ return resolved;
80
+ }
81
+ // Remaining text after an optional pipe is the link text, so advance
82
+ // until that's consumed.
83
+ while (pos < end && ts.isWhiteSpaceLike(part.text.charCodeAt(pos))) {
84
+ pos++;
85
+ }
86
+ if (pos < end && part.text[pos] === "|") {
87
+ pos++;
88
+ }
89
+ part.target = target;
90
+ part.text =
91
+ part.text.substring(pos).trim() ||
92
+ (typeof target === "string" ? target : target.name);
93
+ return part;
94
+ }
95
+ function legacyResolveLinkTag(reflection, part) {
96
+ const { caption, target } = splitLinkText(part.text);
97
+ if (urlPrefix.test(target)) {
98
+ part.text = caption;
99
+ part.target = target;
100
+ }
101
+ else {
102
+ const targetRefl = reflection.findReflectionByName(target);
103
+ if (targetRefl) {
104
+ part.text = caption;
105
+ part.target = targetRefl;
106
+ }
107
+ }
108
+ return part;
109
+ }
110
+ function replaceBrackets(reflection, text, validation, logger) {
111
+ const parts = [];
112
+ let begin = 0;
113
+ brackets.lastIndex = 0;
114
+ for (const match of text.matchAll(brackets)) {
115
+ if (begin != match.index) {
116
+ parts.push({
117
+ kind: "text",
118
+ text: text.substring(begin, match.index),
119
+ });
120
+ }
121
+ begin = match.index + match[0].length;
122
+ const content = match[1];
123
+ const { target, caption } = splitLinkText(content);
124
+ if (urlPrefix.test(target)) {
125
+ parts.push({
126
+ kind: "inline-tag",
127
+ tag: "@link",
128
+ text: caption,
129
+ target,
130
+ });
131
+ }
132
+ else {
133
+ const targetRefl = reflection.findReflectionByName(target);
134
+ if (targetRefl) {
135
+ parts.push({
136
+ kind: "inline-tag",
137
+ tag: "@link",
138
+ text: caption,
139
+ target: targetRefl,
140
+ });
141
+ }
142
+ else {
143
+ if (validation.invalidLink) {
144
+ logger.warn("Failed to find target: " + content);
145
+ }
146
+ parts.push({
147
+ kind: "inline-tag",
148
+ tag: "@link",
149
+ text: content,
150
+ });
151
+ }
152
+ }
153
+ }
154
+ parts.push({
155
+ kind: "text",
156
+ text: text.substring(begin),
157
+ });
158
+ return parts;
159
+ }
160
+ /**
161
+ * Split the given link into text and target at first pipe or space.
162
+ *
163
+ * @param text The source string that should be checked for a split character.
164
+ * @returns An object containing the link text and target.
165
+ */
166
+ function splitLinkText(text) {
167
+ let splitIndex = text.indexOf("|");
168
+ if (splitIndex === -1) {
169
+ splitIndex = text.search(/\s/);
170
+ }
171
+ if (splitIndex !== -1) {
172
+ return {
173
+ caption: text
174
+ .substring(splitIndex + 1)
175
+ .replace(/\n+/, " ")
176
+ .trim(),
177
+ target: text.substring(0, splitIndex).trim(),
178
+ };
179
+ }
180
+ else {
181
+ return {
182
+ caption: text,
183
+ target: text,
184
+ };
185
+ }
186
+ }
@@ -1,12 +1,13 @@
1
1
  import * as ts from "typescript";
2
2
  import type { Application } from "../application";
3
- import { ProjectReflection, SomeType } from "../models/index";
3
+ import { Comment, CommentDisplayPart, ProjectReflection, Reflection, SomeType } from "../models/index";
4
4
  import { Context } from "./context";
5
5
  import { ConverterComponent } from "./components";
6
6
  import { ChildableComponent } from "../utils/component";
7
+ import { MinimalSourceFile } from "../utils";
7
8
  import type { DocumentationEntryPoint } from "../utils/entry-point";
8
9
  import { CommentParserConfig } from "./comments";
9
- import type { CommentStyle } from "../utils/options/declaration";
10
+ import type { CommentStyle, ValidationOptions } from "../utils/options/declaration";
10
11
  /**
11
12
  * Compiles source files using TypeScript and converts compiler symbols to reflections.
12
13
  */
@@ -23,6 +24,8 @@ export declare class Converter extends ChildableComponent<Application, Converter
23
24
  excludePrivate: boolean;
24
25
  excludeProtected: boolean;
25
26
  commentStyle: CommentStyle;
27
+ /** @internal */
28
+ validation: ValidationOptions;
26
29
  private _config?;
27
30
  get config(): CommentParserConfig;
28
31
  /**
@@ -51,7 +54,8 @@ export declare class Converter extends ChildableComponent<Application, Converter
51
54
  static readonly EVENT_CREATE_DECLARATION: "createDeclaration";
52
55
  /**
53
56
  * Triggered when the converter has created a signature reflection.
54
- * The listener will be given {@link Context}, {@link SignatureReflection} | {@link ProjectReflection} and a `ts.Node?`
57
+ * The listener will be given {@link Context}, {@link SignatureReflection} | {@link ProjectReflection} and
58
+ * `ts.SignatureDeclaration | ts.IndexSignatureDeclaration | ts.JSDocSignature | undefined`
55
59
  * @event
56
60
  */
57
61
  static readonly EVENT_CREATE_SIGNATURE: "createSignature";
@@ -103,6 +107,12 @@ export declare class Converter extends ChildableComponent<Application, Converter
103
107
  * @internal
104
108
  */
105
109
  convertType(context: Context, node: ts.TypeNode | ts.Type | undefined): SomeType;
110
+ /**
111
+ * Parse the given file into a comment. Intended to be used with markdown files.
112
+ */
113
+ parseRawComment(file: MinimalSourceFile): Comment;
114
+ resolveLinks(comment: Comment, owner: Reflection): void;
115
+ resolveLinks(parts: readonly CommentDisplayPart[], owner: Reflection): CommentDisplayPart[];
106
116
  /**
107
117
  * Compile the files within the given context and convert the compiler symbols to reflections.
108
118
  *
@@ -22,6 +22,7 @@ const enum_1 = require("../utils/enum");
22
22
  const comments_1 = require("./comments");
23
23
  const parser_1 = require("./comments/parser");
24
24
  const rawLexer_1 = require("./comments/rawLexer");
25
+ const linkResolver_1 = require("./comments/linkResolver");
25
26
  /**
26
27
  * Compiles source files using TypeScript and converts compiler symbols to reflections.
27
28
  */
@@ -60,6 +61,27 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
60
61
  convertType(context, node) {
61
62
  return (0, types_1.convertType)(context, node);
62
63
  }
64
+ /**
65
+ * Parse the given file into a comment. Intended to be used with markdown files.
66
+ */
67
+ parseRawComment(file) {
68
+ return (0, parser_1.parseComment)((0, rawLexer_1.lexCommentString)(file.text), this.config, file, this.application.logger);
69
+ }
70
+ resolveLinks(comment, owner) {
71
+ if (comment instanceof index_1.Comment) {
72
+ (0, linkResolver_1.resolveLinks)(comment, owner, this.validation, this.owner.logger);
73
+ }
74
+ else {
75
+ let warned = false;
76
+ const warn = () => {
77
+ if (!warned) {
78
+ warned = true;
79
+ this.application.logger.warn(`${owner.name}: Comment [[target]] style links are deprecated and will be removed in 0.24`);
80
+ }
81
+ };
82
+ return (0, linkResolver_1.resolvePartLinks)(owner, comment, warn, this.validation, this.owner.logger);
83
+ }
84
+ }
63
85
  /**
64
86
  * Compile the files within the given context and convert the compiler symbols to reflections.
65
87
  *
@@ -91,11 +113,6 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
91
113
  const entryName = entryPoint.displayName;
92
114
  const symbol = getSymbolForModuleLike(context, node);
93
115
  let moduleContext;
94
- const allExports = getExports(context, node, symbol);
95
- if (allExports.every((exp) => this.shouldIgnore(exp))) {
96
- this.owner.logger.verbose(`All members of ${entryName} are excluded, ignoring entry point.`);
97
- return;
98
- }
99
116
  if (singleEntryPoint) {
100
117
  // Special case for when we're giving a single entry point, we don't need to
101
118
  // create modules for each entry. Register the project as this module.
@@ -110,7 +127,7 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
110
127
  const reflection = context.createDeclarationReflection(index_1.ReflectionKind.Module, symbol, void 0, entryName);
111
128
  if (entryPoint.readmeFile) {
112
129
  const readme = (0, utils_1.readFile)(entryPoint.readmeFile);
113
- const comment = (0, parser_1.parseComment)((0, rawLexer_1.lexCommentString)(readme), context.converter.config, new utils_1.MinimalSourceFile(readme, entryPoint.readmeFile), context.logger);
130
+ const comment = this.parseRawComment(new utils_1.MinimalSourceFile(readme, entryPoint.readmeFile));
114
131
  if (comment.blockTags.length || comment.modifierTags.size) {
115
132
  const ignored = [
116
133
  ...comment.blockTags.map((tag) => tag.tag),
@@ -124,6 +141,7 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
124
141
  context.finalizeDeclarationReflection(reflection);
125
142
  moduleContext = context.withScope(reflection);
126
143
  }
144
+ const allExports = getExports(context, node, symbol);
127
145
  for (const exp of allExports.filter((exp) => isDirectExport(context.resolveAliasedSymbol(exp), node))) {
128
146
  (0, symbols_1.convertSymbol)(moduleContext, exp);
129
147
  }
@@ -206,7 +224,8 @@ Converter.EVENT_END = converter_events_1.ConverterEvents.END;
206
224
  Converter.EVENT_CREATE_DECLARATION = converter_events_1.ConverterEvents.CREATE_DECLARATION;
207
225
  /**
208
226
  * Triggered when the converter has created a signature reflection.
209
- * The listener will be given {@link Context}, {@link SignatureReflection} | {@link ProjectReflection} and a `ts.Node?`
227
+ * The listener will be given {@link Context}, {@link SignatureReflection} | {@link ProjectReflection} and
228
+ * `ts.SignatureDeclaration | ts.IndexSignatureDeclaration | ts.JSDocSignature | undefined`
210
229
  * @event
211
230
  */
212
231
  Converter.EVENT_CREATE_SIGNATURE = converter_events_1.ConverterEvents.CREATE_SIGNATURE;
@@ -264,6 +283,9 @@ __decorate([
264
283
  __decorate([
265
284
  (0, utils_1.BindOption)("commentStyle")
266
285
  ], Converter.prototype, "commentStyle", void 0);
286
+ __decorate([
287
+ (0, utils_1.BindOption)("validation")
288
+ ], Converter.prototype, "validation", void 0);
267
289
  Converter = Converter_1 = __decorate([
268
290
  (0, component_1.Component)({
269
291
  name: "converter",
@@ -49,7 +49,7 @@ function createSignature(context, kind, signature, declaration) {
49
49
  context.scope.signatures.push(sigRef);
50
50
  break;
51
51
  }
52
- context.trigger(converter_events_1.ConverterEvents.CREATE_SIGNATURE, sigRef);
52
+ context.trigger(converter_events_1.ConverterEvents.CREATE_SIGNATURE, sigRef, declaration);
53
53
  }
54
54
  exports.createSignature = createSignature;
55
55
  function convertParameters(context, sigRef, parameters, parameterNodes) {
@@ -62,6 +62,7 @@ function convertParameters(context, sigRef, parameters, parameterNodes) {
62
62
  if (declaration && ts.isJSDocParameterTag(declaration)) {
63
63
  paramRefl.comment = (0, comments_1.getJsDocComment)(declaration, context.converter.config, context.logger);
64
64
  }
65
+ paramRefl.comment || (paramRefl.comment = (0, comments_1.getComment)(param, paramRefl.kind, context.converter.config, context.logger, context.converter.commentStyle));
65
66
  context.registerReflection(paramRefl, param);
66
67
  context.trigger(converter_events_1.ConverterEvents.CREATE_PARAMETER, paramRefl);
67
68
  let type;
@@ -174,14 +174,16 @@ let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent
174
174
  }
175
175
  hidden.forEach((reflection) => project.removeReflection(reflection));
176
176
  // remove functions with empty signatures after their signatures have been removed
177
- const [allRemoved, someRemoved] = (0, utils_1.partition)((0, utils_1.filterMap)(hidden, (reflection) => reflection.parent?.kindOf(models_1.ReflectionKind.FunctionOrMethod | models_1.ReflectionKind.Constructor)
177
+ const [allRemoved, someRemoved] = (0, utils_1.partition)((0, utils_1.unique)((0, utils_1.filterMap)(hidden, (reflection) => reflection.parent?.kindOf(models_1.ReflectionKind.SignatureContainer)
178
178
  ? reflection.parent
179
- : void 0), (method) => method.signatures?.length === 0);
179
+ : void 0)), (method) => method.getNonIndexSignatures().length === 0);
180
180
  allRemoved.forEach((reflection) => {
181
181
  project.removeReflection(reflection);
182
182
  });
183
183
  someRemoved.forEach((reflection) => {
184
- reflection.sources = (0, utils_1.unique)(reflection.signatures.flatMap((s) => s.sources ?? []));
184
+ reflection.sources = reflection
185
+ .getNonIndexSignatures()
186
+ .flatMap((s) => s.sources ?? []);
185
187
  });
186
188
  }
187
189
  /**
@@ -282,8 +284,9 @@ let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent
282
284
  }
283
285
  if (!comment) {
284
286
  if (this.excludeNotDocumented) {
285
- // Only allow excludeNotDocumented to exclude root level reflections
286
- if (!(reflection instanceof models_1.DeclarationReflection)) {
287
+ // Don't let excludeNotDocumented remove parameters.
288
+ if (!(reflection instanceof models_1.DeclarationReflection) &&
289
+ !(reflection instanceof models_1.SignatureReflection)) {
287
290
  return false;
288
291
  }
289
292
  // excludeNotDocumented should hide a module only if it has no visible children
@@ -297,14 +300,29 @@ let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent
297
300
  if (reflection.kind === models_1.ReflectionKind.EnumMember) {
298
301
  return false;
299
302
  }
303
+ // signature containers should only be hidden if all their signatures are hidden
304
+ if (reflection.kindOf(models_1.ReflectionKind.SignatureContainer)) {
305
+ return reflection
306
+ .getAllSignatures()
307
+ .every((child) => this.isHidden(child));
308
+ }
300
309
  // excludeNotDocumented should never hide parts of "type" reflections
301
310
  return inTypeLiteral(reflection) === false;
302
311
  }
303
312
  return false;
304
313
  }
305
- return (comment.hasModifier("@hidden") ||
314
+ const isHidden = comment.hasModifier("@hidden") ||
306
315
  comment.hasModifier("@ignore") ||
307
- (comment.hasModifier("@internal") && this.excludeInternal));
316
+ (comment.hasModifier("@internal") && this.excludeInternal);
317
+ if (isHidden &&
318
+ reflection.kindOf(models_1.ReflectionKind.ContainsCallSignatures)) {
319
+ return reflection
320
+ .getNonIndexSignatures()
321
+ .every((sig) => {
322
+ return !sig.comment || this.isHidden(sig);
323
+ });
324
+ }
325
+ return isHidden;
308
326
  }
309
327
  };
310
328
  __decorate([
@@ -1,4 +1,3 @@
1
- import type { Reflection } from "../../models/reflections/abstract";
2
1
  import { ConverterComponent } from "../components";
3
2
  import type { Context } from "../../converter";
4
3
  import { ValidationOptions } from "../../utils";
@@ -11,25 +10,5 @@ export declare class LinkResolverPlugin extends ConverterComponent {
11
10
  * Create a new LinkResolverPlugin instance.
12
11
  */
13
12
  initialize(): void;
14
- /**
15
- * Find all old style double bracket references to symbols within the given text and transform them into a link.
16
- *
17
- * @param text The text that should be parsed.
18
- * @returns The text with symbol references replaced by links.
19
- */
20
- private replaceBrackets;
21
13
  onResolve(context: Context): void;
22
- processReflection(reflection: Reflection): void;
23
- private processParts;
24
- private processPart;
25
- /**
26
- * Split the given link into text and target at first pipe or space.
27
- *
28
- * @param text The source string that should be checked for a split character.
29
- * @returns An object containing the link text and target.
30
- */
31
- static splitLinkText(text: string): {
32
- caption: string;
33
- target: string;
34
- };
35
14
  }
@@ -5,22 +5,15 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
5
5
  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
6
  return c > 3 && r && Object.defineProperty(target, key, r), r;
7
7
  };
8
- var LinkResolverPlugin_1;
9
8
  Object.defineProperty(exports, "__esModule", { value: true });
10
9
  exports.LinkResolverPlugin = void 0;
11
10
  const components_1 = require("../components");
12
11
  const converter_events_1 = require("../converter-events");
13
- const declarationReference_1 = require("../comments/declarationReference");
14
- const ts = require("typescript");
15
12
  const utils_1 = require("../../utils");
16
- const declarationReferenceResolver_1 = require("../comments/declarationReferenceResolver");
17
- const models_1 = require("../../models");
18
- const urlPrefix = /^(http|ftp)s?:\/\//;
19
- const brackets = /\[\[(?!include:)([^\]]+)\]\]/g;
20
13
  /**
21
14
  * A plugin that resolves `{@link Foo}` tags.
22
15
  */
23
- let LinkResolverPlugin = LinkResolverPlugin_1 = class LinkResolverPlugin extends components_1.ConverterComponent {
16
+ let LinkResolverPlugin = class LinkResolverPlugin extends components_1.ConverterComponent {
24
17
  /**
25
18
  * Create a new LinkResolverPlugin instance.
26
19
  */
@@ -28,196 +21,21 @@ let LinkResolverPlugin = LinkResolverPlugin_1 = class LinkResolverPlugin extends
28
21
  super.initialize();
29
22
  this.owner.on(converter_events_1.ConverterEvents.RESOLVE_END, this.onResolve, this, -300);
30
23
  }
31
- /**
32
- * Find all old style double bracket references to symbols within the given text and transform them into a link.
33
- *
34
- * @param text The text that should be parsed.
35
- * @returns The text with symbol references replaced by links.
36
- */
37
- replaceBrackets(reflection, text) {
38
- const parts = [];
39
- let begin = 0;
40
- brackets.lastIndex = 0;
41
- for (const match of text.matchAll(brackets)) {
42
- if (begin != match.index) {
43
- parts.push({
44
- kind: "text",
45
- text: text.substring(begin, match.index),
46
- });
47
- }
48
- begin = match.index + match[0].length;
49
- const content = match[1];
50
- const { target, caption } = LinkResolverPlugin_1.splitLinkText(content);
51
- if (urlPrefix.test(target)) {
52
- parts.push({
53
- kind: "inline-tag",
54
- tag: "@link",
55
- text: caption,
56
- target,
57
- });
58
- }
59
- else {
60
- const targetRefl = reflection.findReflectionByName(target);
61
- if (targetRefl) {
62
- parts.push({
63
- kind: "inline-tag",
64
- tag: "@link",
65
- text: caption,
66
- target: targetRefl,
67
- });
68
- }
69
- else {
70
- if (this.validation.invalidLink) {
71
- this.application.logger.warn("Failed to find target: " + content);
72
- }
73
- parts.push({
74
- kind: "inline-tag",
75
- tag: "@link",
76
- text: content,
77
- });
78
- }
79
- }
80
- }
81
- parts.push({
82
- kind: "text",
83
- text: text.substring(begin),
84
- });
85
- return parts;
86
- }
87
24
  onResolve(context) {
88
25
  for (const reflection of Object.values(context.project.reflections)) {
89
- this.processReflection(reflection);
90
- }
91
- let warned = false;
92
- const warn = () => {
93
- if (!warned) {
94
- warned = true;
95
- this.application.logger.warn(`README: Comment [[target]] style links are deprecated and will be removed in 0.24`);
96
- }
97
- };
98
- if (context.project.readme) {
99
- context.project.readme = this.processParts(context.project, context.project.readme, warn);
100
- }
101
- }
102
- processReflection(reflection) {
103
- const comment = reflection.comment;
104
- if (!comment)
105
- return;
106
- let warned = false;
107
- const warn = () => {
108
- if (!warned) {
109
- warned = true;
110
- this.application.logger.warn(`${reflection.getFriendlyFullName()}: Comment [[target]] style links are deprecated and will be removed in 0.24`);
111
- }
112
- };
113
- comment.summary = this.processParts(reflection, comment.summary, warn);
114
- for (const tag of comment.blockTags) {
115
- tag.content = this.processParts(reflection, tag.content, warn);
116
- }
117
- if (reflection instanceof models_1.DeclarationReflection && reflection.readme) {
118
- reflection.readme = this.processParts(reflection, reflection.readme, warn);
119
- }
120
- }
121
- processParts(reflection, parts, warn) {
122
- return parts.flatMap((part) => this.processPart(reflection, part, warn));
123
- }
124
- processPart(reflection, part, warn) {
125
- if (part.kind === "text" && brackets.test(part.text)) {
126
- warn();
127
- return this.replaceBrackets(reflection, part.text);
128
- }
129
- if (part.kind === "inline-tag") {
130
- if (part.tag === "@link" ||
131
- part.tag === "@linkcode" ||
132
- part.tag === "@linkplain") {
133
- return resolveLinkTag(reflection, part, (msg) => {
134
- if (this.validation.invalidLink) {
135
- this.application.logger.warn(msg);
136
- }
137
- });
26
+ if (reflection.comment) {
27
+ context.converter.resolveLinks(reflection.comment, reflection);
138
28
  }
139
29
  }
140
- return part;
141
- }
142
- /**
143
- * Split the given link into text and target at first pipe or space.
144
- *
145
- * @param text The source string that should be checked for a split character.
146
- * @returns An object containing the link text and target.
147
- */
148
- static splitLinkText(text) {
149
- let splitIndex = text.indexOf("|");
150
- if (splitIndex === -1) {
151
- splitIndex = text.search(/\s/);
152
- }
153
- if (splitIndex !== -1) {
154
- return {
155
- caption: text
156
- .substring(splitIndex + 1)
157
- .replace(/\n+/, " ")
158
- .trim(),
159
- target: text.substring(0, splitIndex).trim(),
160
- };
161
- }
162
- else {
163
- return {
164
- caption: text,
165
- target: text,
166
- };
30
+ if (context.project.readme) {
31
+ context.project.readme = context.converter.resolveLinks(context.project.readme, context.project);
167
32
  }
168
33
  }
169
34
  };
170
35
  __decorate([
171
36
  (0, utils_1.BindOption)("validation")
172
37
  ], LinkResolverPlugin.prototype, "validation", void 0);
173
- LinkResolverPlugin = LinkResolverPlugin_1 = __decorate([
38
+ LinkResolverPlugin = __decorate([
174
39
  (0, components_1.Component)({ name: "link-resolver" })
175
40
  ], LinkResolverPlugin);
176
41
  exports.LinkResolverPlugin = LinkResolverPlugin;
177
- function resolveLinkTag(reflection, part, warn) {
178
- let pos = 0;
179
- const end = part.text.length;
180
- // Try to parse one
181
- const declRef = (0, declarationReference_1.parseDeclarationReference)(part.text, pos, end);
182
- let target;
183
- if (declRef) {
184
- // Got one, great! Try to resolve the link
185
- target = (0, declarationReferenceResolver_1.resolveDeclarationReference)(reflection, declRef[0]);
186
- pos = declRef[1];
187
- }
188
- // If resolution via a declaration reference failed, revert to the legacy "split and check"
189
- // method... this should go away in 0.24, once people have had a chance to migrate any failing links.
190
- if (!target) {
191
- const resolved = legacyResolveLinkTag(reflection, part);
192
- if (resolved) {
193
- warn(`Failed to resolve {@link ${part.text}} in ${reflection.getFriendlyFullName()} with declaration references. This link will break in v0.24.`);
194
- }
195
- return resolved;
196
- }
197
- // Remaining text after an optional pipe is the link text, so advance
198
- // until that's consumed.
199
- while (pos < end && ts.isWhiteSpaceLike(part.text.charCodeAt(pos))) {
200
- pos++;
201
- }
202
- if (pos < end && part.text[pos] === "|") {
203
- pos++;
204
- }
205
- part.target = target;
206
- part.text = part.text.substring(pos).trim() || target.name;
207
- return part;
208
- }
209
- function legacyResolveLinkTag(reflection, part) {
210
- const { caption, target } = LinkResolverPlugin.splitLinkText(part.text);
211
- if (urlPrefix.test(target)) {
212
- part.text = caption;
213
- part.target = target;
214
- }
215
- else {
216
- const targetRefl = reflection.findReflectionByName(target);
217
- if (targetRefl) {
218
- part.text = caption;
219
- part.target = targetRefl;
220
- }
221
- }
222
- return part;
223
- }
@@ -14,8 +14,6 @@ const converter_1 = require("../converter");
14
14
  const utils_1 = require("../../utils");
15
15
  const fs_1 = require("../../utils/fs");
16
16
  const paths_1 = require("../../utils/paths");
17
- const rawLexer_1 = require("../comments/rawLexer");
18
- const parser_1 = require("../comments/parser");
19
17
  const minimalSourceFile_1 = require("../../utils/minimalSourceFile");
20
18
  /**
21
19
  * 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
76
74
  const project = context.project;
77
75
  if (this.readmeFile) {
78
76
  const readme = (0, utils_1.readFile)(this.readmeFile);
79
- const comment = (0, parser_1.parseComment)((0, rawLexer_1.lexCommentString)(readme), context.converter.config, new minimalSourceFile_1.MinimalSourceFile(readme, this.readmeFile), context.logger);
77
+ const comment = context.converter.parseRawComment(new minimalSourceFile_1.MinimalSourceFile(readme, this.readmeFile));
80
78
  if (comment.blockTags.length || comment.modifierTags.size) {
81
79
  const ignored = [
82
80
  ...comment.blockTags.map((tag) => tag.tag),
@@ -33,6 +33,7 @@ export declare class SourcePlugin extends ConverterComponent {
33
33
  * @param reflection The reflection that is currently processed.
34
34
  */
35
35
  private onDeclaration;
36
+ private onSignature;
36
37
  /**
37
38
  * Triggered when the converter begins resolving a project.
38
39
  *
@@ -42,7 +42,7 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
42
42
  this.listenTo(this.owner, {
43
43
  [converter_1.Converter.EVENT_END]: this.onEnd,
44
44
  [converter_1.Converter.EVENT_CREATE_DECLARATION]: this.onDeclaration,
45
- [converter_1.Converter.EVENT_CREATE_SIGNATURE]: this.onDeclaration,
45
+ [converter_1.Converter.EVENT_CREATE_SIGNATURE]: this.onSignature,
46
46
  [converter_1.Converter.EVENT_RESOLVE_BEGIN]: this.onBeginResolve,
47
47
  });
48
48
  }
@@ -77,6 +77,16 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
77
77
  reflection.sources.push(new models_1.SourceReference(fileName, position.line + 1, position.character));
78
78
  }
79
79
  }
80
+ onSignature(_context, reflection, sig) {
81
+ if (this.disableSources || !sig)
82
+ return;
83
+ const sourceFile = sig.getSourceFile();
84
+ const fileName = sourceFile.fileName;
85
+ this.fileNames.add(fileName);
86
+ const position = ts.getLineAndCharacterOfPosition(sourceFile, sig.getStart());
87
+ reflection.sources || (reflection.sources = []);
88
+ reflection.sources.push(new models_1.SourceReference(fileName, position.line + 1, position.character));
89
+ }
80
90
  /**
81
91
  * Triggered when the converter begins resolving a project.
82
92
  *
@@ -44,11 +44,19 @@ class Repository {
44
44
  this.path = path;
45
45
  this.branch = gitRevision || "master";
46
46
  for (let i = 0, c = repoLinks.length; i < c; i++) {
47
- let match = /(github(?:\.[a-z]+)*\.[a-z]{2,})[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
47
+ let match = /(github(?!.us)(?:\.[a-z]+)*\.[a-z]{2,})[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
48
48
  // Github Enterprise
49
49
  if (!match) {
50
50
  match = /(\w+\.githubprivate.com)[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
51
51
  }
52
+ // Github Enterprise
53
+ if (!match) {
54
+ match = /(\w+\.ghe.com)[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
55
+ }
56
+ // Github Enterprise
57
+ if (!match) {
58
+ match = /(\w+\.github.us)[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
59
+ }
52
60
  if (!match) {
53
61
  match = /(bitbucket.org)[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
54
62
  }
@@ -284,19 +284,22 @@ class Reflection {
284
284
  if (alias === "") {
285
285
  alias = "reflection-" + this.id;
286
286
  }
287
+ // NTFS/ExFAT use uppercase, so we will too. It probably won't matter
288
+ // in this case since names will generally be valid identifiers, but to be safe...
289
+ const upperAlias = alias.toUpperCase();
287
290
  let target = this;
288
291
  while (target.parent && !target.hasOwnDocument) {
289
292
  target = target.parent;
290
293
  }
291
294
  target._aliases || (target._aliases = new Map());
292
295
  let suffix = "";
293
- if (!target._aliases.has(alias)) {
294
- target._aliases.set(alias, 1);
296
+ if (!target._aliases.has(upperAlias)) {
297
+ target._aliases.set(upperAlias, 1);
295
298
  }
296
299
  else {
297
- const count = target._aliases.get(alias);
300
+ const count = target._aliases.get(upperAlias);
298
301
  suffix = "-" + count.toString();
299
- target._aliases.set(alias, count + 1);
302
+ target._aliases.set(upperAlias, count + 1);
300
303
  }
301
304
  alias += suffix;
302
305
  this._alias = alias;
@@ -45,4 +45,9 @@ export declare namespace ReflectionKind {
45
45
  const Inheritable: number;
46
46
  /** @internal */
47
47
  const ContainsCallSignatures: number;
48
+ /**
49
+ * Note: This does not include Class/Interface, even though they technically could contain index signatures
50
+ * @internal
51
+ */
52
+ const SignatureContainer: number;
48
53
  }
@@ -78,4 +78,9 @@ var ReflectionKind;
78
78
  ReflectionKind.ContainsCallSignatures = ReflectionKind.Constructor |
79
79
  ReflectionKind.Function |
80
80
  ReflectionKind.Method;
81
+ /**
82
+ * Note: This does not include Class/Interface, even though they technically could contain index signatures
83
+ * @internal
84
+ */
85
+ ReflectionKind.SignatureContainer = ReflectionKind.ContainsCallSignatures | ReflectionKind.Accessor;
81
86
  })(ReflectionKind = exports.ReflectionKind || (exports.ReflectionKind = {}));
@@ -671,7 +671,7 @@ class ReferenceType extends Type {
671
671
  .fileName.replace(/\\/g, "/");
672
672
  if (!symbolPath)
673
673
  return ref;
674
- let startIndex = symbolPath.indexOf("node_modules/");
674
+ let startIndex = symbolPath.lastIndexOf("node_modules/");
675
675
  if (startIndex === -1)
676
676
  return ref;
677
677
  startIndex += "node_modules/".length;
@@ -1,6 +1,6 @@
1
1
  import type { RendererHooks } from "../..";
2
- import type { ReferenceType, Reflection } from "../../../models";
3
- import type { Options } from "../../../utils";
2
+ import type { CommentDisplayPart, ReferenceType, Reflection } from "../../../models";
3
+ import type { NeverIfInternal, Options } from "../../../utils";
4
4
  import type { DefaultTheme } from "./DefaultTheme";
5
5
  export declare class DefaultThemeRenderContext {
6
6
  private theme;
@@ -11,7 +11,7 @@ export declare class DefaultThemeRenderContext {
11
11
  /** Avoid this in favor of urlTo if possible */
12
12
  relativeURL: (url: string | undefined) => string | undefined;
13
13
  urlTo: (reflection: Reflection) => string | undefined;
14
- markdown: (md: string | undefined) => string;
14
+ markdown: (md: readonly CommentDisplayPart[] | NeverIfInternal<string | undefined>) => string;
15
15
  attemptExternalResolution: (type: ReferenceType) => string | undefined;
16
16
  reflectionTemplate: (props: import("../..").PageEvent<import("../../../models").ContainerReflection>) => import("../../../utils/jsx.elements").JsxElement;
17
17
  indexTemplate: (props: import("../..").PageEvent<import("../../../models").ProjectReflection>) => import("../../../utils/jsx.elements").JsxElement;
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.DefaultThemeRenderContext = void 0;
4
+ const lib_1 = require("../lib");
4
5
  const default_1 = require("./layouts/default");
5
6
  const partials_1 = require("./partials");
6
7
  const analytics_1 = require("./partials/analytics");
@@ -42,6 +43,9 @@ class DefaultThemeRenderContext {
42
43
  };
43
44
  this.urlTo = (reflection) => this.relativeURL(reflection.url);
44
45
  this.markdown = (md) => {
46
+ if (md instanceof Array) {
47
+ return this.theme.markedPlugin.parseMarkdown((0, lib_1.displayPartsToMarkdown)(md, this.urlTo));
48
+ }
45
49
  return md ? this.theme.markedPlugin.parseMarkdown(md) : "";
46
50
  };
47
51
  this.attemptExternalResolution = (type) => {
@@ -1,4 +1,4 @@
1
1
  import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
2
2
  import { JSX } from "../../../../utils";
3
3
  import type { Reflection } from "../../../../models";
4
- export declare function comment({ markdown, urlTo }: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;
4
+ export declare function comment({ markdown }: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;
@@ -3,14 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.comment = void 0;
4
4
  const utils_1 = require("../../../../utils");
5
5
  const lib_1 = require("../../lib");
6
- function comment({ markdown, urlTo }, props) {
6
+ function comment({ markdown }, props) {
7
7
  if (!props.comment?.hasVisibleComponent())
8
8
  return;
9
9
  // Note: Comment modifiers are handled in `renderFlags`
10
10
  return (utils_1.JSX.createElement("div", { class: "tsd-comment tsd-typography" },
11
- utils_1.JSX.createElement(utils_1.Raw, { html: markdown((0, lib_1.displayPartsToMarkdown)(props.comment.summary, urlTo)) }),
11
+ utils_1.JSX.createElement(utils_1.Raw, { html: markdown(props.comment.summary) }),
12
12
  props.comment.blockTags.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
13
13
  utils_1.JSX.createElement("h3", null, (0, lib_1.camelToTitleCase)(item.tag.substring(1))),
14
- utils_1.JSX.createElement(utils_1.Raw, { html: markdown((0, lib_1.displayPartsToMarkdown)(item.content, urlTo)) }))))));
14
+ utils_1.JSX.createElement(utils_1.Raw, { html: markdown(item.content) }))))));
15
15
  }
16
16
  exports.comment = comment;
@@ -10,7 +10,7 @@ function renderCategory({ urlTo, icons }, item, prependName = "") {
10
10
  utils_1.JSX.createElement("div", { class: "tsd-index-list" }, item.children.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
11
11
  utils_1.JSX.createElement("a", { href: urlTo(item), class: (0, lib_1.classNames)({ "tsd-index-link": true, deprecated: item.isDeprecated() }, item.cssClasses) },
12
12
  icons[item.kind](),
13
- utils_1.JSX.createElement("span", null, item.name ? (0, lib_1.wbr)(item.name) : utils_1.JSX.createElement("em", null, (0, lib_1.wbr)(item.kindString)))),
13
+ utils_1.JSX.createElement("span", null, (0, lib_1.renderName)(item))),
14
14
  "\n"))))));
15
15
  }
16
16
  function index(context, props) {
@@ -42,7 +42,7 @@ function index(context, props) {
42
42
  props.kind === models_1.ReflectionKind.Module &&
43
43
  props.readme?.length !== 0 && (utils_1.JSX.createElement("section", { class: "tsd-panel-group" },
44
44
  utils_1.JSX.createElement("section", { class: "tsd-panel tsd-typography" },
45
- utils_1.JSX.createElement(utils_1.Raw, { html: context.markdown((0, lib_1.displayPartsToMarkdown)(props.readme || [], context.urlTo)) })))),
45
+ utils_1.JSX.createElement(utils_1.Raw, { html: context.markdown(props.readme || []) })))),
46
46
  utils_1.JSX.createElement("section", { class: "tsd-panel-group tsd-index-group" },
47
47
  utils_1.JSX.createElement("section", { class: "tsd-panel tsd-index-panel" }, content))));
48
48
  }
@@ -103,7 +103,7 @@ function secondaryNavigation(context, props) {
103
103
  return (utils_1.JSX.createElement("li", { class: (0, lib_1.classNames)({ deprecated: child.isDeprecated(), current: props.model === child }, child.cssClasses) },
104
104
  utils_1.JSX.createElement("a", { href: context.urlTo(child), class: "tsd-index-link" },
105
105
  context.icons[child.kind](),
106
- (0, lib_1.wbr)(child.name))));
106
+ (0, lib_1.renderName)(child))));
107
107
  });
108
108
  if (effectivePageParent.kindOf(models_1.ReflectionKind.SomeModule | models_1.ReflectionKind.Project)) {
109
109
  return (utils_1.JSX.createElement("nav", { class: "tsd-navigation secondary menu-sticky" }, !!pageNavigation.length && utils_1.JSX.createElement("ul", null, pageNavigation)));
@@ -116,7 +116,7 @@ function secondaryNavigation(context, props) {
116
116
  }, effectivePageParent.cssClasses) },
117
117
  utils_1.JSX.createElement("a", { href: context.urlTo(effectivePageParent), class: "tsd-index-link" },
118
118
  context.icons[effectivePageParent.kind](),
119
- utils_1.JSX.createElement("span", null, (0, lib_1.wbr)(effectivePageParent.name))),
119
+ utils_1.JSX.createElement("span", null, (0, lib_1.renderName)(effectivePageParent))),
120
120
  !!pageNavigation.length && utils_1.JSX.createElement("ul", null, pageNavigation)))));
121
121
  }
122
122
  exports.secondaryNavigation = secondaryNavigation;
@@ -2,4 +2,4 @@ import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
2
2
  import type { ProjectReflection } from "../../../../models";
3
3
  import type { PageEvent } from "../../../events";
4
4
  import { JSX } from "../../../../utils";
5
- export declare const indexTemplate: ({ markdown, urlTo }: DefaultThemeRenderContext, props: PageEvent<ProjectReflection>) => JSX.Element;
5
+ export declare const indexTemplate: ({ markdown }: DefaultThemeRenderContext, props: PageEvent<ProjectReflection>) => JSX.Element;
@@ -2,7 +2,6 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.indexTemplate = void 0;
4
4
  const utils_1 = require("../../../../utils");
5
- const lib_1 = require("../../lib");
6
- const indexTemplate = ({ markdown, urlTo }, props) => (utils_1.JSX.createElement("div", { class: "tsd-panel tsd-typography" },
7
- utils_1.JSX.createElement(utils_1.Raw, { html: markdown((0, lib_1.displayPartsToMarkdown)(props.model.readme || [], urlTo)) })));
5
+ const indexTemplate = ({ markdown }, props) => (utils_1.JSX.createElement("div", { class: "tsd-panel tsd-typography" },
6
+ utils_1.JSX.createElement(utils_1.Raw, { html: markdown(props.model.readme || []) })));
8
7
  exports.indexTemplate = indexTemplate;
@@ -36,7 +36,8 @@ function reflectionTemplate(context, props) {
36
36
  context.type(props.model.indexSignature.type)),
37
37
  context.comment(props.model.indexSignature),
38
38
  props.model.indexSignature?.type instanceof models_1.ReflectionType &&
39
- context.parameter(props.model.indexSignature.type.declaration))))),
39
+ context.parameter(props.model.indexSignature.type.declaration))),
40
+ !props.model.signatures && context.memberSources(props.model))),
40
41
  !!props.model.children?.length && context.index(props.model),
41
42
  context.members(props.model)));
42
43
  }
@@ -19,4 +19,8 @@ export declare function hasTypeParameters(reflection: Reflection): reflection is
19
19
  };
20
20
  export declare function renderTypeParametersSignature(typeParameters: readonly TypeParameterReflection[] | undefined): JSX.Element;
21
21
  export declare function camelToTitleCase(text: string): string;
22
- export declare function displayPartsToMarkdown(parts: CommentDisplayPart[], urlTo: DefaultThemeRenderContext["urlTo"]): string;
22
+ export declare function displayPartsToMarkdown(parts: readonly CommentDisplayPart[], urlTo: DefaultThemeRenderContext["urlTo"]): string;
23
+ /**
24
+ * Renders the reflection name with an additional `?` if optional.
25
+ */
26
+ export declare function renderName(refl: Reflection): JSX.Element | (string | JSX.Element)[];
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.displayPartsToMarkdown = exports.camelToTitleCase = exports.renderTypeParametersSignature = exports.hasTypeParameters = exports.classNames = exports.renderFlags = exports.join = exports.wbr = exports.stringify = void 0;
3
+ exports.renderName = exports.displayPartsToMarkdown = exports.camelToTitleCase = exports.renderTypeParametersSignature = exports.hasTypeParameters = exports.classNames = exports.renderFlags = exports.join = exports.wbr = exports.stringify = void 0;
4
4
  const models_1 = require("../../models");
5
5
  const utils_1 = require("../../utils");
6
6
  function stringify(data) {
@@ -122,3 +122,18 @@ function displayPartsToMarkdown(parts, urlTo) {
122
122
  return result.join("");
123
123
  }
124
124
  exports.displayPartsToMarkdown = displayPartsToMarkdown;
125
+ /**
126
+ * Renders the reflection name with an additional `?` if optional.
127
+ */
128
+ function renderName(refl) {
129
+ if (!refl.name) {
130
+ return utils_1.JSX.createElement("em", null, wbr(refl.kindString));
131
+ }
132
+ if (refl.flags.isOptional) {
133
+ return utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
134
+ wbr(refl.name),
135
+ "?");
136
+ }
137
+ return wbr(refl.name);
138
+ }
139
+ exports.renderName = renderName;
@@ -261,7 +261,9 @@ function getEntryPointsForPackages(logger, packageGlobPaths, options) {
261
261
  results.push({
262
262
  displayName: typedocPackageConfig?.displayName ??
263
263
  packageJson["name"],
264
- version: packageJson["version"],
264
+ version: includeVersion
265
+ ? packageJson["version"]
266
+ : void 0,
265
267
  readmeFile: typedocPackageConfig?.readmeFile
266
268
  ? Path.resolve(Path.join(packageJsonPath, "..", typedocPackageConfig?.readmeFile))
267
269
  : undefined,
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "typedoc",
3
3
  "description": "Create api documentation for TypeScript projects.",
4
- "version": "0.23.7",
4
+ "version": "0.23.10",
5
5
  "homepage": "https://typedoc.org",
6
6
  "main": "./dist/index.js",
7
7
  "exports": {
@@ -25,7 +25,7 @@
25
25
  },
26
26
  "dependencies": {
27
27
  "lunr": "^2.3.9",
28
- "marked": "^4.0.16",
28
+ "marked": "^4.0.18",
29
29
  "minimatch": "^5.1.0",
30
30
  "shiki": "^0.10.1"
31
31
  },
@@ -37,22 +37,21 @@
37
37
  "@types/marked": "^4.0.3",
38
38
  "@types/minimatch": "3.0.5",
39
39
  "@types/mocha": "^9.1.1",
40
- "@types/node": "^17.0.35",
41
- "@typescript-eslint/eslint-plugin": "^5.26.0",
42
- "@typescript-eslint/parser": "^5.26.0",
40
+ "@types/node": "^18.6.3",
41
+ "@typescript-eslint/eslint-plugin": "^5.31.0",
42
+ "@typescript-eslint/parser": "^5.31.0",
43
43
  "@typestrong/fs-fixture-builder": "github:TypeStrong/fs-fixture-builder#b88cd06fe814614a0d924af9d10d04ff95a551de",
44
- "c8": "^7.11.3",
44
+ "c8": "^7.12.0",
45
45
  "esbuild": "^0.14.39",
46
- "eslint": "^8.16.0",
47
- "mocha": "^9.2.1",
48
- "prettier": "2.6.2",
46
+ "eslint": "^8.20.0",
47
+ "mocha": "^10.0.0",
48
+ "prettier": "2.7.1",
49
49
  "puppeteer": "^13.5.2",
50
- "reg-notify-github-plugin": "^0.11.1",
51
- "reg-suit": "^0.11.1",
52
- "reg-suit-core": "^0.11.1",
53
- "reg-suit-interface": "^0.11.0",
54
- "ts-node": "^10.8.0",
55
- "typescript": "^4.7.2"
50
+ "reg-suit": "^0.12.1",
51
+ "reg-suit-core": "^0.12.1",
52
+ "reg-suit-interface": "^0.12.0",
53
+ "ts-node": "^10.9.1",
54
+ "typescript": "^4.7.4"
56
55
  },
57
56
  "files": [
58
57
  "/bin",
@@ -66,7 +65,8 @@
66
65
  "/tsdoc.json"
67
66
  ],
68
67
  "scripts": {
69
- "test": "c8 mocha -r ts-node/register --config .config/mocha.fast.json",
68
+ "test": "mocha -r ts-node/register --config .config/mocha.fast.json",
69
+ "test:cov": "c8 mocha -r ts-node/register --config .config/mocha.fast.json",
70
70
  "build:c2": "node bin/typedoc --tsconfig src/test/converter2/tsconfig.json",
71
71
  "test:full": "c8 mocha -r ts-node/register --config .config/mocha.full.json",
72
72
  "test:visual": "node ./dist/test/capture-screenshots.js && reg-suit -c .config/regconfig.json compare",
package/static/style.css CHANGED
@@ -942,7 +942,7 @@ a.tsd-index-link {
942
942
  margin: 2rem 0;
943
943
  }
944
944
  .tsd-panel-group.tsd-index-group details {
945
- margin: 4rem 0;
945
+ margin: 2rem 0;
946
946
  }
947
947
 
948
948
  #tsd-search {
package/tsdoc.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "$schema": "https://developer.microsoft.com/en-us/json-schemas/tsdoc/v0/tsdoc.schema.json",
2
+ "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
3
3
  "noStandardTags": false,
4
4
  "tagDefinitions": [
5
5
  {