typedoc 0.23.8 → 0.23.9

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.
@@ -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,
@@ -98,8 +101,12 @@ function discoverComment(symbol, kind, logger, commentStyle) {
98
101
  // However, we don't want to skip the node if it is a reference to something.
99
102
  // See the gh1770 test for an example.
100
103
  if (kind & models_1.ReflectionKind.ContainsCallSignatures &&
101
- !node.body &&
102
- node.kind !== ts.SyntaxKind.BindingElement) {
104
+ [
105
+ ts.SyntaxKind.FunctionDeclaration,
106
+ ts.SyntaxKind.MethodDeclaration,
107
+ ts.SyntaxKind.Constructor,
108
+ ].includes(node.kind) &&
109
+ !node.body) {
103
110
  continue;
104
111
  }
105
112
  const comments = collectCommentRanges(ts.getLeadingCommentRanges(text, node.pos));
@@ -97,11 +97,6 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
97
97
  const entryName = entryPoint.displayName;
98
98
  const symbol = getSymbolForModuleLike(context, node);
99
99
  let moduleContext;
100
- const allExports = getExports(context, node, symbol);
101
- if (allExports.every((exp) => this.shouldIgnore(exp))) {
102
- this.owner.logger.verbose(`All members of ${entryName} are excluded, ignoring entry point.`);
103
- return;
104
- }
105
100
  if (singleEntryPoint) {
106
101
  // Special case for when we're giving a single entry point, we don't need to
107
102
  // create modules for each entry. Register the project as this module.
@@ -130,6 +125,7 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
130
125
  context.finalizeDeclarationReflection(reflection);
131
126
  moduleContext = context.withScope(reflection);
132
127
  }
128
+ const allExports = getExports(context, node, symbol);
133
129
  for (const exp of allExports.filter((exp) => isDirectExport(context.resolveAliasedSymbol(exp), node))) {
134
130
  (0, symbols_1.convertSymbol)(moduleContext, exp);
135
131
  }
@@ -311,9 +311,18 @@ let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent
311
311
  }
312
312
  return false;
313
313
  }
314
- return (comment.hasModifier("@hidden") ||
314
+ const isHidden = comment.hasModifier("@hidden") ||
315
315
  comment.hasModifier("@ignore") ||
316
- (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;
317
326
  }
318
327
  };
319
328
  __decorate([
@@ -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;
@@ -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.8",
4
+ "version": "0.23.9",
5
5
  "homepage": "https://typedoc.org",
6
6
  "main": "./dist/index.js",
7
7
  "exports": {
@@ -66,7 +66,8 @@
66
66
  "/tsdoc.json"
67
67
  ],
68
68
  "scripts": {
69
- "test": "c8 mocha -r ts-node/register --config .config/mocha.fast.json",
69
+ "test": "mocha -r ts-node/register --config .config/mocha.fast.json",
70
+ "test:cov": "c8 mocha -r ts-node/register --config .config/mocha.fast.json",
70
71
  "build:c2": "node bin/typedoc --tsconfig src/test/converter2/tsconfig.json",
71
72
  "test:full": "c8 mocha -r ts-node/register --config .config/mocha.full.json",
72
73
  "test:visual": "node ./dist/test/capture-screenshots.js && reg-suit -c .config/regconfig.json compare",