typedoc 0.24.0 → 0.24.2

package/dist/lib/utils/html.d.ts

@@ -0,0 +1 @@
+export declare function getTextContent(text: string): string;

package/dist/lib/utils/html.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTextContent = void 0;
+// There is a fixed list of named character references which will not be expanded in the future.
+// This json file is based on https://html.spec.whatwg.org/multipage/named-characters.html#named-character-references
+// with some modifications to reduce the file size of the original JSON since we just need.
+const html_entities_json_1 = __importDefault(require("./html-entities.json"));
+// Three cases:
+// { - numeric escape
+//  - hex escape
+// & - named escape
+function unescapeEntities(html) {
+    return html.replace(/&(#(?:\d+);?|(?:#[xX][0-9A-Fa-f]+);?|(?:\w+);?)/g, (_, n) => {
+        if (n[0] === "#") {
+            return String.fromCharCode(n[1] === "x" || n[1] === "X"
+                ? parseInt(n.substring(2), 16)
+                : parseInt(n.substring(1), 10));
+        }
+        return html_entities_json_1.default[n] || "";
+    });
+}
+function getTextContent(text) {
+    return unescapeEntities(text.replace(/<.*?(?:>|$)/g, ""));
+}
+exports.getTextContent = getTextContent;

package/dist/lib/utils/index.d.ts

@@ -2,13 +2,14 @@ export { filterMap, insertPrioritySorted, partition, removeIf, removeIfPresent,
 export { AbstractComponent, ChildableComponent, Component } from "./component";
 export * from "./enum";
 export { Event, EventDispatcher } from "./events";
-export { isFile, copy, copySync, getCommonDirectory, normalizePath, readFile, writeFile, writeFileSync, discoverInParentDir, discoverPackageJson, } from "./fs";
+export { isFile, copy, copySync, getCommonDirectory, readFile, writeFile, writeFileSync, discoverInParentDir, discoverPackageJson, } from "./fs";
+export { normalizePath } from "./paths";
 export type { IfInternal, NeverIfInternal, Chars } from "./general";
 export { assertNever } from "./general";
 export { ConsoleLogger, Logger, LogLevel } from "./loggers";
 export { DefaultMap } from "./map";
 export { ArgumentsReader, BindOption, CommentStyle, Options, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, } from "./options";
-export type { ArrayDeclarationOption, BooleanDeclarationOption, DeclarationOption, DeclarationOptionBase, DeclarationOptionToOptionType, KeyToDeclaration, MapDeclarationOption, MixedDeclarationOption, NumberDeclarationOption, FlagsDeclarationOption, ObjectDeclarationOption, OptionsReader, StringDeclarationOption, TypeDocOptionMap, TypeDocOptions, ValidationOptions, TypeDocOptionValues, ParameterTypeToOptionTypeMap, ManuallyValidatedOption, } from "./options";
+export type { ArrayDeclarationOption, BooleanDeclarationOption, DeclarationOption, DeclarationOptionBase, DeclarationOptionToOptionType, KeyToDeclaration, MapDeclarationOption, MixedDeclarationOption, NumberDeclarationOption, FlagsDeclarationOption, ObjectDeclarationOption, OptionsReader, StringDeclarationOption, TypeDocOptionMap, TypeDocOptions, ValidationOptions, TypeDocOptionValues, ParameterTypeToOptionTypeMap, ManuallyValidatedOption, JsDocCompatibility, } from "./options";
 export { loadPlugins } from "./plugins";
 export { getSortFunction } from "./sort";
 export type { SortStrategy } from "./sort";

package/dist/lib/utils/index.js

@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MinimalSourceFile = exports.Validation = exports.renderElement = exports.Raw = exports.Fragment = exports.JSX = exports.EventHooks = exports.getSortFunction = exports.loadPlugins = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.CommentStyle = exports.BindOption = exports.ArgumentsReader = exports.DefaultMap = exports.LogLevel = exports.Logger = exports.ConsoleLogger = exports.assertNever = exports.discoverPackageJson = exports.discoverInParentDir = exports.writeFileSync = exports.writeFile = exports.readFile = exports.normalizePath = exports.getCommonDirectory = exports.copySync = exports.copy = exports.isFile = exports.EventDispatcher = exports.Event = exports.Component = exports.ChildableComponent = exports.AbstractComponent = exports.unique = exports.removeIfPresent = exports.removeIf = exports.partition = exports.insertPrioritySorted = exports.filterMap = void 0;
+exports.MinimalSourceFile = exports.Validation = exports.renderElement = exports.Raw = exports.Fragment = exports.JSX = exports.EventHooks = exports.getSortFunction = exports.loadPlugins = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.CommentStyle = exports.BindOption = exports.ArgumentsReader = exports.DefaultMap = exports.LogLevel = exports.Logger = exports.ConsoleLogger = exports.assertNever = exports.normalizePath = exports.discoverPackageJson = exports.discoverInParentDir = exports.writeFileSync = exports.writeFile = exports.readFile = exports.getCommonDirectory = exports.copySync = exports.copy = exports.isFile = exports.EventDispatcher = exports.Event = exports.Component = exports.ChildableComponent = exports.AbstractComponent = exports.unique = exports.removeIfPresent = exports.removeIf = exports.partition = exports.insertPrioritySorted = exports.filterMap = void 0;
 var array_1 = require("./array");
 Object.defineProperty(exports, "filterMap", { enumerable: true, get: function () { return array_1.filterMap; } });
 Object.defineProperty(exports, "insertPrioritySorted", { enumerable: true, get: function () { return array_1.insertPrioritySorted; } });
@@ -47,12 +47,13 @@ Object.defineProperty(exports, "isFile", { enumerable: true, get: function () {
 Object.defineProperty(exports, "copy", { enumerable: true, get: function () { return fs_1.copy; } });
 Object.defineProperty(exports, "copySync", { enumerable: true, get: function () { return fs_1.copySync; } });
 Object.defineProperty(exports, "getCommonDirectory", { enumerable: true, get: function () { return fs_1.getCommonDirectory; } });
-Object.defineProperty(exports, "normalizePath", { enumerable: true, get: function () { return fs_1.normalizePath; } });
 Object.defineProperty(exports, "readFile", { enumerable: true, get: function () { return fs_1.readFile; } });
 Object.defineProperty(exports, "writeFile", { enumerable: true, get: function () { return fs_1.writeFile; } });
 Object.defineProperty(exports, "writeFileSync", { enumerable: true, get: function () { return fs_1.writeFileSync; } });
 Object.defineProperty(exports, "discoverInParentDir", { enumerable: true, get: function () { return fs_1.discoverInParentDir; } });
 Object.defineProperty(exports, "discoverPackageJson", { enumerable: true, get: function () { return fs_1.discoverPackageJson; } });
+var paths_1 = require("./paths");
+Object.defineProperty(exports, "normalizePath", { enumerable: true, get: function () { return paths_1.normalizePath; } });
 var general_1 = require("./general");
 Object.defineProperty(exports, "assertNever", { enumerable: true, get: function () { return general_1.assertNever; } });
 var loggers_1 = require("./loggers");

package/dist/lib/utils/jsx.js

@@ -28,14 +28,15 @@ function Raw(_props) {
     return null;
 }
 exports.Raw = Raw;
+const htmlEscapes = {
+    "&": "&",
+    "<": "&lt;",
+    ">": "&gt;",
+    '"': "&quot;",
+    "'": "&#39;",
+};
 function escapeHtml(html) {
-    return html.replace(/[&<>'"]/g, (c) => ({
-        "&": "&amp;",
-        "<": "&lt;",
-        ">": "&gt;",
-        '"': "&quot;",
-        "'": "&#39;",
-    }[c]));
+    return html.replace(/[&<>'"]/g, (c) => htmlEscapes[c]);
 }
 const voidElements = new Set([
     "area",

package/dist/lib/utils/map.d.ts

@@ -2,6 +2,7 @@ export declare class DefaultMap<K, V> extends Map<K, V> {
     private creator;
     constructor(creator: () => V);
     get(key: K): V;
+    getNoInsert(key: K): V | undefined;
 }
 export declare class StableKeyMap<K extends {
     getStableKey(): string;

package/dist/lib/utils/map.js

@@ -16,6 +16,9 @@ class DefaultMap extends Map {
         this.set(key, created);
         return created;
     }
+    getNoInsert(key) {
+        return super.get(key);
+    }
 }
 exports.DefaultMap = DefaultMap;
 class StableKeyMap {

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

@@ -59,6 +59,7 @@ export interface TypeDocOptionMap {
     options: string;
     tsconfig: string;
     compilerOptions: unknown;
+    plugin: string[];
     entryPoints: string[];
     entryPointStrategy: typeof EntryPointStrategy;
     exclude: string[];
@@ -70,9 +71,13 @@ export interface TypeDocOptionMap {
     excludePrivate: boolean;
     excludeProtected: boolean;
     excludeReferences: boolean;
-    externalSymbolLinkMappings: ManuallyValidatedOption<Record<string, Record<string, string>>>;
-    media: string;
-    includes: string;
+    name: string;
+    includeVersion: boolean;
+    disableSources: boolean;
+    sourceLinkTemplate: string;
+    gitRevision: string;
+    gitRemote: string;
+    readme: string;
     out: string;
     json: string;
     pretty: boolean;
@@ -82,59 +87,55 @@ export interface TypeDocOptionMap {
     darkHighlightTheme: ShikiTheme;
     customCss: string;
     markedOptions: unknown;
-    name: string;
-    includeVersion: boolean;
-    disableSources: boolean;
     basePath: string;
-    excludeTags: `@${string}`[];
-    readme: string;
     cname: string;
-    sourceLinkTemplate: string;
-    gitRevision: string;
-    gitRemote: string;
     htmlLang: string;
     githubPages: boolean;
+    cacheBust: boolean;
     gaID: string;
     hideGenerator: boolean;
-    cacheBust: boolean;
+    hideParameterTypesInTitle: boolean;
     searchInComments: boolean;
     cleanOutputDir: boolean;
     titleLink: string;
     navigationLinks: ManuallyValidatedOption<Record<string, string>>;
     sidebarLinks: ManuallyValidatedOption<Record<string, string>>;
-    jsDocCompatibility: JsDocCompatibility;
+    visibilityFilters: ManuallyValidatedOption<{
+        protected?: boolean;
+        private?: boolean;
+        inherited?: boolean;
+        external?: boolean;
+        [tag: `@${string}`]: boolean;
+    }>;
+    searchCategoryBoosts: ManuallyValidatedOption<Record<string, number>>;
+    searchGroupBoosts: ManuallyValidatedOption<Record<string, number>>;
     commentStyle: typeof CommentStyle;
     useTsLinkResolution: boolean;
+    jsDocCompatibility: JsDocCompatibility;
     blockTags: `@${string}`[];
     inlineTags: `@${string}`[];
     modifierTags: `@${string}`[];
+    excludeTags: `@${string}`[];
+    externalSymbolLinkMappings: ManuallyValidatedOption<Record<string, Record<string, string>>>;
+    media: string;
+    includes: string;
     categorizeByGroup: boolean;
     defaultCategory: string;
     categoryOrder: string[];
     sort: SortStrategy[];
     kindSortOrder: ReflectionKind.KindString[];
-    visibilityFilters: ManuallyValidatedOption<{
-        protected?: boolean;
-        private?: boolean;
-        inherited?: boolean;
-        external?: boolean;
-        [tag: `@${string}`]: boolean;
-    }>;
-    searchCategoryBoosts: ManuallyValidatedOption<Record<string, number>>;
-    searchGroupBoosts: ManuallyValidatedOption<Record<string, number>>;
+    treatWarningsAsErrors: boolean;
+    treatValidationWarningsAsErrors: boolean;
+    intentionallyNotExported: string[];
+    validation: ValidationOptions;
+    requiredToBeDocumented: ReflectionKind.KindString[];
     watch: boolean;
     preserveWatchOutput: boolean;
-    skipErrorChecking: boolean;
     help: boolean;
     version: boolean;
     showConfig: boolean;
-    plugin: string[];
     logLevel: typeof LogLevel;
-    treatWarningsAsErrors: boolean;
-    treatValidationWarningsAsErrors: boolean;
-    intentionallyNotExported: string[];
-    validation: ValidationOptions;
-    requiredToBeDocumented: ReflectionKind.KindString[];
+    skipErrorChecking: boolean;
 }
 /**
  * Wrapper type for values in TypeDocOptionMap which are represented with an unknown option type, but

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

@@ -2,4 +2,4 @@ export { Options, BindOption } from "./options";
 export type { OptionsReader } from "./options";
 export { ArgumentsReader, PackageJsonReader, TypeDocReader, TSConfigReader, } from "./readers";
 export { CommentStyle, EmitStrategy, ParameterType, ParameterHint, } from "./declaration";
-export type { TypeDocOptions, TypeDocOptionMap, ValidationOptions, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, ObjectDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, TypeDocOptionValues, ParameterTypeToOptionTypeMap, ManuallyValidatedOption, } from "./declaration";
+export type { TypeDocOptions, TypeDocOptionMap, ValidationOptions, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, ObjectDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, TypeDocOptionValues, ParameterTypeToOptionTypeMap, ManuallyValidatedOption, JsDocCompatibility, } from "./declaration";

package/dist/lib/utils/options/readers/tsconfig.js

@@ -65,7 +65,7 @@ class TSConfigReader {
             }
             return;
         }
-        fileToRead = (0, fs_1.normalizePath)((0, path_1.resolve)(fileToRead));
+        fileToRead = (0, paths_1.normalizePath)((0, path_1.resolve)(fileToRead));
         logger.verbose(`Reading tsconfig at ${(0, paths_1.nicePath)(fileToRead)}`);
         this.addTagsFromTsdocJson(container, logger, (0, path_1.resolve)(fileToRead));
         const parsed = (0, tsconfig_1.readTsConfig)(fileToRead, logger);
@@ -142,7 +142,7 @@ class TSConfigReader {
             return;
         }
         this.seenTsdocPaths.add(path);
-        const { config, error } = typescript_1.default.readConfigFile((0, fs_1.normalizePath)(path), typescript_1.default.sys.readFile);
+        const { config, error } = typescript_1.default.readConfigFile((0, paths_1.normalizePath)(path), typescript_1.default.sys.readFile);
         if (error) {
             logger.error(`Failed to read tsdoc.json file at ${(0, paths_1.nicePath)(path)}.`);
             return;

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

@@ -76,7 +76,7 @@ class TypeDocReader {
         seen.add(file);
         let fileContent;
         if (file.endsWith(".json")) {
-            const readResult = typescript_1.default.readConfigFile((0, fs_1.normalizePath)(file), (path) => FS.readFileSync(path, "utf-8"));
+            const readResult = typescript_1.default.readConfigFile((0, paths_1.normalizePath)(file), (path) => FS.readFileSync(path, "utf-8"));
             if (readResult.error) {
                 logger.error(`Failed to parse ${(0, paths_1.nicePath)(file)}, ensure it exists and contains an object.`);
                 return;

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

@@ -352,6 +352,12 @@ function addTypeDocOptions(options) {
         help: "Do not print the TypeDoc link at the end of the page.",
         type: declaration_1.ParameterType.Boolean,
     });
+    options.addDeclaration({
+        name: "hideParameterTypesInTitle",
+        help: "Hides parameter types in signature titles for easier scanning.",
+        type: declaration_1.ParameterType.Boolean,
+        defaultValue: true,
+    });
     options.addDeclaration({
         name: "cacheBust",
         help: "Include the generation time in links to static assets.",

package/dist/lib/utils/paths.d.ts

@@ -7,3 +7,10 @@ import { Minimatch } from "minimatch";
 export declare function createMinimatch(patterns: string[]): Minimatch[];
 export declare function matchesAny(patterns: readonly Minimatch[], path: string): boolean;
 export declare function nicePath(absPath: string): string;
+/**
+ * Normalize the given path.
+ *
+ * @param path  The path that should be normalized.
+ * @returns The normalized path.
+ */
+export declare function normalizePath(path: string): string;

package/dist/lib/utils/paths.js

@@ -1,22 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.nicePath = exports.matchesAny = exports.createMinimatch = void 0;
+exports.normalizePath = exports.nicePath = exports.matchesAny = exports.createMinimatch = void 0;
 const minimatch_1 = require("minimatch");
 const path_1 = require("path");
-const fs_1 = require("./fs");
 /**
  * Convert array of glob patterns to array of minimatch instances.
  *
  * Handle a few Windows-Unix path gotchas.
  */
 function createMinimatch(patterns) {
-    return patterns.map((pattern) => new minimatch_1.Minimatch((0, fs_1.normalizePath)(pattern).replace(/^\w:\//, ""), {
+    return patterns.map((pattern) => new minimatch_1.Minimatch(normalizePath(pattern).replace(/^\w:\//, ""), {
         dot: true,
     }));
 }
 exports.createMinimatch = createMinimatch;
 function matchesAny(patterns, path) {
-    const normPath = (0, fs_1.normalizePath)(path).replace(/^\w:\//, "");
+    const normPath = normalizePath(path).replace(/^\w:\//, "");
     return patterns.some((pat) => pat.match(normPath));
 }
 exports.matchesAny = matchesAny;
@@ -25,8 +24,18 @@ function nicePath(absPath) {
         return absPath;
     const relativePath = (0, path_1.relative)(process.cwd(), absPath);
     if (relativePath.startsWith("..")) {
-        return (0, fs_1.normalizePath)(absPath);
+        return normalizePath(absPath);
     }
-    return `./${(0, fs_1.normalizePath)(relativePath)}`;
+    return `./${normalizePath(relativePath)}`;
 }
 exports.nicePath = nicePath;
+/**
+ * Normalize the given path.
+ *
+ * @param path  The path that should be normalized.
+ * @returns The normalized path.
+ */
+function normalizePath(path) {
+    return path.replace(/\\/g, "/");
+}
+exports.normalizePath = normalizePath;

package/dist/lib/utils/sort.d.ts

@@ -4,6 +4,6 @@
  */
 import type { DeclarationReflection } from "../models/reflections/declaration";
 import type { Options } from "./options";
-export declare const SORT_STRATEGIES: readonly ["source-order", "alphabetical", "enum-value-ascending", "enum-value-descending", "static-first", "instance-first", "visibility", "required-first", "kind"];
+export declare const SORT_STRATEGIES: readonly ["source-order", "alphabetical", "enum-value-ascending", "enum-value-descending", "enum-member-source-order", "static-first", "instance-first", "visibility", "required-first", "kind"];
 export type SortStrategy = (typeof SORT_STRATEGIES)[number];
 export declare function getSortFunction(opts: Options): (reflections: DeclarationReflection[]) => void;

package/dist/lib/utils/sort.js

@@ -12,6 +12,7 @@ exports.SORT_STRATEGIES = [
     "alphabetical",
     "enum-value-ascending",
     "enum-value-descending",
+    "enum-member-source-order",
     "static-first",
     "instance-first",
     "visibility",
@@ -56,7 +57,7 @@ const sorts = {
                 return true;
             }
             if (aSymbol.fileName === bSymbol.fileName &&
-                aSymbol.pos < aSymbol.pos) {
+                aSymbol.pos < bSymbol.pos) {
                 return true;
             }
             return false;
@@ -86,6 +87,13 @@ const sorts = {
         }
         return false;
     },
+    "enum-member-source-order"(a, b, data) {
+        if (a.kind === kind_1.ReflectionKind.EnumMember &&
+            b.kind === kind_1.ReflectionKind.EnumMember) {
+            return sorts["source-order"](a, b, data);
+        }
+        return false;
+    },
     "static-first"(a, b) {
         return a.flags.isStatic && !b.flags.isStatic;
     },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.24.0",
+  "version": "0.24.2",
   "homepage": "https://typedoc.org",
   "exports": {
     ".": "./dist/index.js",
@@ -25,8 +25,8 @@
   },
   "dependencies": {
     "lunr": "^2.3.9",
-    "marked": "^4.2.12",
-    "minimatch": "^7.1.3",
+    "marked": "^4.3.0",
+    "minimatch": "^9.0.0",
     "shiki": "^0.14.1"
   },
   "peerDependencies": {
@@ -37,17 +37,17 @@
     "@types/marked": "^4.0.8",
     "@types/mocha": "^10.0.1",
     "@types/node": "14",
-    "@typescript-eslint/eslint-plugin": "^5.55.0",
-    "@typescript-eslint/parser": "^5.55.0",
+    "@typescript-eslint/eslint-plugin": "^5.58.0",
+    "@typescript-eslint/parser": "^5.58.0",
     "@typestrong/fs-fixture-builder": "github:TypeStrong/fs-fixture-builder#8abd1494280116ff5318dde2c50ad01e1663790c",
     "c8": "^7.13.0",
-    "esbuild": "^0.17.12",
-    "eslint": "^8.36.0",
+    "esbuild": "^0.17.16",
+    "eslint": "^8.38.0",
     "mocha": "^10.2.0",
-    "prettier": "2.8.4",
+    "prettier": "2.8.7",
     "puppeteer": "^13.5.2",
     "ts-node": "^10.9.1",
-    "typescript": "5.0.2"
+    "typescript": "5.0.4"
   },
   "files": [
     "/bin",