typedoc 0.23.26 → 0.23.28

package/bin/typedoc

@@ -94,13 +94,17 @@ async function run(app) {
         return ExitCodes.CompileError;
     }
 
+    const preValidationWarnCount = app.logger.warningCount;
     app.validate(project);
+    const hadValidationWarnings =
+        app.logger.warningCount !== preValidationWarnCount;
     if (app.logger.hasErrors()) {
         return ExitCodes.ValidationError;
     }
     if (
-        app.options.getValue("treatWarningsAsErrors") &&
-        app.logger.hasWarnings()
+        hadValidationWarnings &&
+        (app.options.getValue("treatWarningsAsErrors") ||
+            app.options.getValue("treatValidationWarningsAsErrors"))
     ) {
         return ExitCodes.ValidationError;
     }

package/dist/lib/converter/comments/discovery.js

@@ -9,6 +9,7 @@ const models_1 = require("../../models");
 const utils_1 = require("../../utils");
 const declaration_1 = require("../../utils/options/declaration");
 const paths_1 = require("../../utils/paths");
+const assert_1 = require("assert");
 // Note: This does NOT include JSDoc syntax kinds. This is important!
 // Comments from @typedef and @callback tags are handled specially by
 // the JSDoc converter because we only want part of the comment when
@@ -147,6 +148,20 @@ function discoverSignatureComment(declaration, commentStyle) {
     if (!node) {
         return;
     }
+    if (typescript_1.default.isJSDocSignature(node)) {
+        const comment = node.parent.parent;
+        (0, assert_1.ok)(typescript_1.default.isJSDoc(comment));
+        return [
+            node.getSourceFile(),
+            [
+                {
+                    kind: typescript_1.default.SyntaxKind.MultiLineCommentTrivia,
+                    pos: comment.pos,
+                    end: comment.end,
+                },
+            ],
+        ];
+    }
     const text = node.getSourceFile().text;
     const comments = collectCommentRanges(typescript_1.default.getLeadingCommentRanges(text, node.pos));
     comments.reverse();

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

@@ -46,7 +46,7 @@ export declare class Context {
      */
     constructor(converter: Converter, programs: readonly ts.Program[], project: ProjectReflection, scope?: Context["scope"]);
     /** @internal */
-    get logger(): import("../utils/loggers").Logger;
+    get logger(): import("../utils").Logger;
     /**
      * Return the compiler options.
      */

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

@@ -153,9 +153,15 @@ function convertTypeParameters(context, parent, parameters) {
             : void 0;
         // There's no way to determine directly from a ts.TypeParameter what it's variance modifiers are
         // so unfortunately we have to go back to the node for this...
-        const variance = getVariance(param.getSymbol()?.declarations?.find(typescript_1.default.isTypeParameterDeclaration)
-            ?.modifiers);
+        const declaration = param
+            .getSymbol()
+            ?.declarations?.find(typescript_1.default.isTypeParameterDeclaration);
+        const variance = getVariance(declaration?.modifiers);
         const paramRefl = new models_1.TypeParameterReflection(param.symbol.name, constraint, defaultType, parent, variance);
+        // No way to determine this from the type parameter itself, need to go back to the declaration
+        if (declaration?.modifiers?.some((m) => m.kind === typescript_1.default.SyntaxKind.ConstKeyword)) {
+            paramRefl.flags.setFlag(models_1.ReflectionFlag.Const, true);
+        }
         context.registerReflection(paramRefl, param.getSymbol());
         context.trigger(converter_events_1.ConverterEvents.CREATE_TYPE_PARAMETER, paramRefl);
         return paramRefl;
@@ -173,6 +179,9 @@ function createTypeParamReflection(param, context) {
         ? context.converter.convertType(context, param.default)
         : void 0;
     const paramRefl = new models_1.TypeParameterReflection(param.name.text, constraint, defaultType, context.scope, getVariance(param.modifiers));
+    if (param.modifiers?.some((m) => m.kind === typescript_1.default.SyntaxKind.ConstKeyword)) {
+        paramRefl.flags.setFlag(models_1.ReflectionFlag.Const, true);
+    }
     context.registerReflection(paramRefl, param.symbol);
     if (typescript_1.default.isJSDocTemplateTag(param.parent)) {
         paramRefl.comment = (0, comments_1.getJsDocComment)(param.parent, context.converter.config, context.logger);

package/dist/lib/converter/symbols.js

@@ -243,8 +243,8 @@ function convertFunctionOrMethod(context, symbol, exportSymbol) {
     const scope = context.withScope(reflection);
     // Can't use zip here. We might have less declarations than signatures
     // or less signatures than declarations.
-    for (let i = 0; i < signatures.length; i++) {
-        (0, signature_1.createSignature)(scope, models_1.ReflectionKind.CallSignature, signatures[i], declarations[i]);
+    for (const sig of signatures) {
+        (0, signature_1.createSignature)(scope, models_1.ReflectionKind.CallSignature, sig);
     }
 }
 // getDeclaredTypeOfSymbol gets the INSTANCE type
@@ -354,8 +354,10 @@ function convertProperty(context, symbol, exportSymbol) {
         (typescript_1.default.isPropertyDeclaration(declaration) ||
             typescript_1.default.isPropertySignature(declaration) ||
             typescript_1.default.isParameter(declaration) ||
-            typescript_1.default.isPropertyAccessExpression(declaration))) {
-        if (!typescript_1.default.isPropertyAccessExpression(declaration)) {
+            typescript_1.default.isPropertyAccessExpression(declaration) ||
+            typescript_1.default.isPropertyAssignment(declaration))) {
+        if (!typescript_1.default.isPropertyAccessExpression(declaration) &&
+            !typescript_1.default.isPropertyAssignment(declaration)) {
             parameterType = declaration.type;
         }
         setModifiers(symbol, declaration, reflection);
@@ -544,8 +546,9 @@ function setModifiers(symbol, declaration, reflection) {
         reflection.setFlag(models_1.ReflectionFlag.Public);
     }
     reflection.setFlag(models_1.ReflectionFlag.Optional, (0, enum_1.hasAllFlags)(symbol.flags, typescript_1.default.SymbolFlags.Optional));
-    reflection.setFlag(models_1.ReflectionFlag.Readonly, (0, enum_1.hasAllFlags)(symbol.checkFlags ?? 0, typescript_1.default.CheckFlags.Readonly) ||
-        (0, enum_1.hasAllFlags)(modifiers, typescript_1.default.ModifierFlags.Readonly));
+    reflection.setFlag(models_1.ReflectionFlag.Readonly, (0, enum_1.hasAllFlags)(
+    // TS 4.9: symbol.checkFlags, links was introduced in 5.0
+    symbol.checkFlags ?? symbol.links?.checkFlags ?? 0, typescript_1.default.CheckFlags.Readonly) || (0, enum_1.hasAllFlags)(modifiers, typescript_1.default.ModifierFlags.Readonly));
     reflection.setFlag(models_1.ReflectionFlag.Abstract, (0, enum_1.hasAllFlags)(modifiers, typescript_1.default.ModifierFlags.Abstract));
     if (reflection.kindOf(models_1.ReflectionKind.Variable) &&
         (0, enum_1.hasAllFlags)(symbol.flags, typescript_1.default.SymbolFlags.BlockScopedVariable)) {

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

@@ -172,7 +172,6 @@ class ReflectionFlags extends Array {
             .map((flag) => [flag, true]));
     }
 }
-exports.ReflectionFlags = ReflectionFlags;
 ReflectionFlags.serializedFlags = [
     "isPrivate",
     "isProtected",
@@ -186,6 +185,7 @@ ReflectionFlags.serializedFlags = [
     "isConst",
     "isReadonly",
 ];
+exports.ReflectionFlags = ReflectionFlags;
 var TraverseProperty;
 (function (TraverseProperty) {
     TraverseProperty[TraverseProperty["Children"] = 0] = "Children";

package/dist/lib/output/events.js

@@ -56,7 +56,6 @@ class RendererEvent extends events_1.Event {
         return event;
     }
 }
-exports.RendererEvent = RendererEvent;
 /**
  * Triggered before the renderer starts rendering a project.
  * @event
@@ -67,6 +66,7 @@ RendererEvent.BEGIN = "beginRender";
  * @event
  */
 RendererEvent.END = "endRender";
+exports.RendererEvent = RendererEvent;
 /**
  * An event emitted by the {@link Renderer} class before and after the
  * markup of a page is rendered.
@@ -76,7 +76,6 @@ RendererEvent.END = "endRender";
  */
 class PageEvent extends events_1.Event {
 }
-exports.PageEvent = PageEvent;
 /**
  * Triggered before a document will be rendered.
  * @event
@@ -87,6 +86,7 @@ PageEvent.BEGIN = "beginPage";
  * @event
  */
 PageEvent.END = "endPage";
+exports.PageEvent = PageEvent;
 /**
  * An event emitted when markdown is being parsed. Allows other plugins to manipulate the result.
  *
@@ -99,12 +99,12 @@ class MarkdownEvent extends events_1.Event {
         this.parsedText = parsedText;
     }
 }
-exports.MarkdownEvent = MarkdownEvent;
 /**
  * Triggered on the renderer when this plugin parses a markdown string.
  * @event
  */
 MarkdownEvent.PARSE = "parseMarkdown";
+exports.MarkdownEvent = MarkdownEvent;
 /**
  * An event emitted when the search index is being prepared.
  */
@@ -136,9 +136,9 @@ class IndexEvent extends events_1.Event {
         this.searchFields = Array.from({ length: this.searchResults.length }, () => ({}));
     }
 }
-exports.IndexEvent = IndexEvent;
 /**
  * Triggered on the renderer when the search index is being prepared.
  * @event
  */
 IndexEvent.PREPARE_INDEX = "prepareIndex";
+exports.IndexEvent = IndexEvent;

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

@@ -253,8 +253,8 @@ class DefaultTheme extends theme_1.Theme {
         return str.replace(/(\w)([A-Z])/g, (_m, m1, m2) => m1 + "-" + m2).toLowerCase();
     }
 }
-exports.DefaultTheme = DefaultTheme;
 DefaultTheme.URL_PREFIX = /^(http|ftp)s?:\/\//;
+exports.DefaultTheme = DefaultTheme;
 function hasReadme(readme) {
     return !readme.endsWith("none");
 }

package/dist/lib/output/themes/default/partials/typeParameters.js

@@ -8,6 +8,7 @@ function typeParameters(context, typeParameters) {
             utils_1.JSX.createElement("h4", null, "Type Parameters"),
             utils_1.JSX.createElement("ul", { class: "tsd-type-parameters" }, typeParameters?.map((item) => (utils_1.JSX.createElement("li", null,
                 utils_1.JSX.createElement("h4", null,
+                    item.flags.isConst && "const ",
                     item.varianceModifier ? `${item.varianceModifier} ` : "",
                     item.name,
                     !!item.type && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,

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

@@ -73,6 +73,7 @@ function renderTypeParametersSignature(typeParameters) {
     return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null, !!typeParameters && typeParameters.length > 0 && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
         utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "<"),
         join(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, ", "), typeParameters, (item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+            item.flags.isConst && "const ",
             item.varianceModifier ? `${item.varianceModifier} ` : "",
             utils_1.JSX.createElement("span", { class: "tsd-signature-type", "data-tsd-kind": item.kindString }, item.name)))),
         utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, ">")))));

package/dist/lib/serialization/serializer.js

@@ -52,7 +52,6 @@ class Serializer extends utils_1.EventDispatcher {
         return project;
     }
 }
-exports.Serializer = Serializer;
 /**
  * Triggered when the {@link Serializer} begins transforming a project.
  * @event EVENT_BEGIN
@@ -63,3 +62,4 @@ Serializer.EVENT_BEGIN = "begin";
  * @event EVENT_END
  */
 Serializer.EVENT_END = "end";
+exports.Serializer = Serializer;

package/dist/lib/utils/component.js

@@ -49,9 +49,9 @@ class ComponentEvent extends events_1.Event {
         this.component = component;
     }
 }
-exports.ComponentEvent = ComponentEvent;
 ComponentEvent.ADDED = "componentAdded";
 ComponentEvent.REMOVED = "componentRemoved";
+exports.ComponentEvent = ComponentEvent;
 /**
  * Component base class.  Has an owner (unless it's the application root component),
  * can dispatch events to its children, and has access to the root Application component.

package/dist/lib/utils/entry-point.js

@@ -291,12 +291,12 @@ function getEntryPointsForPackages(logger, packageGlobPaths, options) {
             logger.error(`Entry point "${packageEntryPoint}" does not appear to be built by/included in the tsconfig found at "${tsconfigFile}"`);
             return;
         }
+        const packageName = packageJson["name"];
         if (includeVersion && !(0, validation_1.validate)({ version: String }, packageJson)) {
             logger.warn(`--includeVersion was specified, but "${(0, paths_1.nicePath)(packageJsonPath)}" does not properly specify a version.`);
         }
         results.push({
-            displayName: typedocPackageConfig?.displayName ??
-                packageJson["name"],
+            displayName: typedocPackageConfig?.displayName ?? packageName,
             version: includeVersion
                 ? packageJson["version"]
                 : void 0,

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

@@ -115,6 +115,7 @@ export interface TypeDocOptionMap {
     logger: unknown;
     logLevel: typeof LogLevel;
     treatWarningsAsErrors: boolean;
+    treatValidationWarningsAsErrors: boolean;
     intentionallyNotExported: string[];
     validation: ValidationOptions;
     requiredToBeDocumented: (keyof typeof ReflectionKind)[];

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

@@ -288,7 +288,12 @@ function addTypeDocOptions(options) {
         name: "excludeTags",
         help: "Remove the listed block/modifier tags from doc comments.",
         type: declaration_1.ParameterType.Array,
-        defaultValue: ["@override", "@virtual", "@privateRemarks"],
+        defaultValue: [
+            "@override",
+            "@virtual",
+            "@privateRemarks",
+            "@satisfies",
+        ],
         validate(value) {
             if (!Validation.validate([Array, Validation.isTagString], value)) {
                 throw new Error(`excludeTags must be an array of valid tag names.`);
@@ -582,7 +587,12 @@ function addTypeDocOptions(options) {
     });
     options.addDeclaration({
         name: "treatWarningsAsErrors",
-        help: "If set, warnings will be treated as errors.",
+        help: "If set, all warnings will be treated as errors.",
+        type: declaration_1.ParameterType.Boolean,
+    });
+    options.addDeclaration({
+        name: "treatValidationWarningsAsErrors",
+        help: "If set, warnings emitted during validation will be treated as errors. This option cannot be used to disable treatWarningsAsErrors for validation warnings.",
         type: declaration_1.ParameterType.Boolean,
     });
     options.addDeclaration({

package/dist/lib/utils/options/tsdoc-defaults.d.ts

@@ -1,6 +1,6 @@
 export declare const tsdocBlockTags: readonly ["@deprecated", "@param", "@remarks", "@returns", "@throws", "@privateRemarks", "@defaultValue", "@typeParam"];
-export declare const blockTags: readonly ["@deprecated", "@param", "@remarks", "@returns", "@throws", "@privateRemarks", "@defaultValue", "@typeParam", "@module", "@inheritDoc", "@group", "@category", "@template", "@type", "@typedef", "@callback", "@prop", "@property"];
+export declare const blockTags: readonly ["@deprecated", "@param", "@remarks", "@returns", "@throws", "@privateRemarks", "@defaultValue", "@typeParam", "@module", "@inheritDoc", "@group", "@category", "@template", "@type", "@typedef", "@callback", "@prop", "@property", "@satisfies"];
 export declare const tsdocInlineTags: readonly ["@link", "@inheritDoc", "@label"];
 export declare const inlineTags: string[];
 export declare const tsdocModifierTags: readonly ["@public", "@private", "@protected", "@internal", "@readonly", "@packageDocumentation", "@eventProperty", "@alpha", "@beta", "@experimental", "@sealed", "@override", "@virtual"];
-export declare const modifierTags: readonly ["@public", "@private", "@protected", "@internal", "@readonly", "@packageDocumentation", "@eventProperty", "@alpha", "@beta", "@experimental", "@sealed", "@override", "@virtual", "@hidden", "@ignore", "@enum", "@event"];
+export declare const modifierTags: readonly ["@public", "@private", "@protected", "@internal", "@readonly", "@packageDocumentation", "@eventProperty", "@alpha", "@beta", "@experimental", "@sealed", "@override", "@virtual", "@hidden", "@ignore", "@enum", "@event", "@overload"];

package/dist/lib/utils/options/tsdoc-defaults.js

@@ -26,6 +26,7 @@ exports.blockTags = [
     "@callback",
     "@prop",
     "@property",
+    "@satisfies",
 ];
 exports.tsdocInlineTags = ["@link", "@inheritDoc", "@label"];
 exports.inlineTags = [...exports.tsdocInlineTags, "@linkcode", "@linkplain"];
@@ -50,4 +51,5 @@ exports.modifierTags = [
     "@ignore",
     "@enum",
     "@event",
+    "@overload",
 ];

package/dist/lib/utils/package-manifest.js

@@ -44,13 +44,13 @@ function extractTypedocConfigFromPackageManifest(logger, packageJsonPath) {
         return undefined;
     }
     if (hasOwnProperty(packageJson, "typedoc") &&
-        typeof packageJson.typedoc == "object" &&
-        packageJson.typedoc) {
-        if (!(0, validation_1.validate)(typedocPackageManifestConfigSchema, packageJson.typedoc)) {
+        typeof packageJson["typedoc"] == "object" &&
+        packageJson["typedoc"]) {
+        if (!(0, validation_1.validate)(typedocPackageManifestConfigSchema, packageJson["typedoc"])) {
             logger.error(`Typedoc config extracted from package manifest file ${packageJsonPath} is not valid`);
             return undefined;
         }
-        return packageJson.typedoc;
+        return packageJson["typedoc"];
     }
     return undefined;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.23.26",
+  "version": "0.23.28",
   "homepage": "https://typedoc.org",
   "main": "./dist/index.js",
   "exports": {
@@ -31,24 +31,24 @@
     "shiki": "^0.14.1"
   },
   "peerDependencies": {
-    "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x"
+    "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x"
   },
   "devDependencies": {
     "@types/lunr": "^2.3.4",
     "@types/marked": "^4.0.8",
     "@types/mocha": "^10.0.1",
     "@types/node": "14",
-    "@typescript-eslint/eslint-plugin": "^5.51.0",
-    "@typescript-eslint/parser": "^5.51.0",
+    "@typescript-eslint/eslint-plugin": "^5.55.0",
+    "@typescript-eslint/parser": "^5.55.0",
     "@typestrong/fs-fixture-builder": "github:TypeStrong/fs-fixture-builder#5a9486bc66f6e36988106685768396281f6cbc10",
-    "c8": "^7.12.0",
-    "esbuild": "^0.17.7",
-    "eslint": "^8.34.0",
+    "c8": "^7.13.0",
+    "esbuild": "^0.17.12",
+    "eslint": "^8.36.0",
     "mocha": "^10.2.0",
     "prettier": "2.8.4",
     "puppeteer": "^13.5.2",
     "ts-node": "^10.9.1",
-    "typescript": "4.9.5"
+    "typescript": "5.0.2"
   },
   "files": [
     "/bin",

package/static/style.css

@@ -483,10 +483,9 @@ blockquote {
     .has-menu .col-menu {
         visibility: visible;
         transform: translate(0, 0);
-        display: grid;
-        align-items: center;
-        grid-template-rows: auto 1fr;
-        grid-gap: 1.5rem;
+        display: flex;
+        flex-direction: column;
+        gap: 1.5rem;
         max-height: 100vh;
         padding: 1rem 2rem;
     }
@@ -911,7 +910,7 @@ a.tsd-index-link {
     margin-right: 0.8rem;
 }
 
-@media (min-width: 1024px) {
+@media (min-width: 1025px) {
     .col-content {
         margin: 2rem auto;
     }

package/tsdoc.json

@@ -66,6 +66,22 @@
             "tagName": "@linkplain",
             "syntaxKind": "block",
             "allowMultiple": true
+        },
+        {
+            "tagName": "@private",
+            "syntaxKind": "modifier"
+        },
+        {
+            "tagName": "@protected",
+            "syntaxKind": "modifier"
+        },
+        {
+            "tagName": "@satisfies",
+            "syntaxKind": "block"
+        },
+        {
+            "tagName": "@overload",
+            "syntaxKind": "modifier"
         }
     ]
 }