typedoc 0.26.11 → 0.27.0-beta.1

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

@@ -1,17 +1,9 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNamedNode = isNamedNode;
-exports.getHeritageTypes = getHeritageTypes;
-exports.isObjectType = isObjectType;
-const typescript_1 = __importDefault(require("typescript"));
-function isNamedNode(node) {
+import ts from "typescript";
+export function isNamedNode(node) {
     const name = node.name;
-    return !!name && (typescript_1.default.isMemberName(name) || typescript_1.default.isComputedPropertyName(name));
+    return !!name && (ts.isMemberName(name) || ts.isComputedPropertyName(name));
 }
-function getHeritageTypes(declarations, kind) {
+export function getHeritageTypes(declarations, kind) {
     const exprs = declarations.flatMap((d) => (d.heritageClauses ?? [])
         .filter((hc) => hc.token === kind)
         .flatMap((hc) => hc.types));
@@ -25,6 +17,6 @@ function getHeritageTypes(declarations, kind) {
         return true;
     });
 }
-function isObjectType(type) {
+export function isObjectType(type) {
     return typeof type.objectFlags === "number";
 }

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

@@ -1,2 +1,2 @@
-import { type SomeType } from "../../models";
+import { type SomeType } from "../../models/index.js";
 export declare function removeUndefined(type: SomeType): SomeType;

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

@@ -1,11 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeUndefined = removeUndefined;
-const models_1 = require("../../models");
-function removeUndefined(type) {
-    if (type instanceof models_1.UnionType) {
+import { IntrinsicType, UnionType } from "../../models/index.js";
+export function removeUndefined(type) {
+    if (type instanceof UnionType) {
         const types = type.types.filter((t) => {
-            if (t instanceof models_1.IntrinsicType) {
+            if (t instanceof IntrinsicType) {
                 return t.name !== "undefined";
             }
             return true;

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

@@ -1,4 +1,4 @@
-import { type Logger } from "../../utils";
+import { type Logger } from "../../utils/index.js";
 export declare function gitIsInstalled(): boolean;
 export interface Repository {
     readonly path: string;

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

@@ -1,4 +1,3 @@
-"use strict";
 var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
     function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
     var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
@@ -33,29 +32,28 @@ var __runInitializers = (this && this.__runInitializers) || function (thisArg, i
     }
     return useValue ? value : void 0;
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RepositoryManager = exports.GitRepository = exports.AssumedRepository = void 0;
-exports.gitIsInstalled = gitIsInstalled;
-exports.guessSourceUrlTemplate = guessSourceUrlTemplate;
-const child_process_1 = require("child_process");
-const utils_1 = require("../../utils");
-const general_1 = require("../../utils/general");
-const path_1 = require("path");
-const fs_1 = require("fs");
+import { spawnSync } from "child_process";
+import { normalizePath } from "../../utils/index.js";
+import { NonEnumerable } from "../../utils/general.js";
+import { dirname, join } from "path";
+import { existsSync } from "fs";
 const TEN_MEGABYTES = 1024 * 10000;
 function git(...args) {
-    return (0, child_process_1.spawnSync)("git", args, {
+    return spawnSync("git", args, {
         encoding: "utf-8",
         windowsHide: true,
         maxBuffer: TEN_MEGABYTES,
     });
 }
 let haveGit;
-function gitIsInstalled() {
+export function gitIsInstalled() {
     haveGit ??= git("--version").status === 0;
     return haveGit;
 }
-class AssumedRepository {
+export class AssumedRepository {
+    path;
+    gitRevision;
+    sourceLinkTemplate;
     constructor(path, gitRevision, sourceLinkTemplate) {
         this.path = path;
         this.gitRevision = gitRevision;
@@ -71,97 +69,99 @@ class AssumedRepository {
         return this.sourceLinkTemplate.replace(/\{(gitRevision|gitRevision:short|path|line)\}/g, (_, key) => replacements[key]);
     }
 }
-exports.AssumedRepository = AssumedRepository;
 /**
  * Stores data of a repository.
  */
 let GitRepository = (() => {
-    var _a;
     let _files_decorators;
     let _files_initializers = [];
     let _files_extraInitializers = [];
-    return _a = class GitRepository {
-            /**
-             * Create a new Repository instance.
-             *
-             * @param path  The root path of the repository.
-             */
-            constructor(path, gitRevision, urlTemplate) {
-                /**
-                 * All files tracked by the repository.
-                 */
-                this.files = __runInitializers(this, _files_initializers, new Set());
-                this.urlTemplate = __runInitializers(this, _files_extraInitializers);
-                this.path = path;
-                this.gitRevision = gitRevision;
-                this.urlTemplate = urlTemplate;
-                const out = git("-C", path, "ls-files", "-z");
-                if (out.status === 0) {
-                    out.stdout.split("\0").forEach((file) => {
-                        if (file !== "") {
-                            this.files.add((0, utils_1.normalizePath)(path + "/" + file));
-                        }
-                    });
-                }
+    return class GitRepository {
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
+            _files_decorators = [NonEnumerable];
+            __esDecorate(null, null, _files_decorators, { kind: "field", name: "files", static: false, private: false, access: { has: obj => "files" in obj, get: obj => obj.files, set: (obj, value) => { obj.files = value; } }, metadata: _metadata }, _files_initializers, _files_extraInitializers);
+            if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        }
+        /**
+         * The path of this repository on disk.
+         */
+        path;
+        /**
+         * All files tracked by the repository.
+         */
+        files = __runInitializers(this, _files_initializers, new Set());
+        urlTemplate = __runInitializers(this, _files_extraInitializers);
+        gitRevision;
+        /**
+         * Create a new Repository instance.
+         *
+         * @param path  The root path of the repository.
+         */
+        constructor(path, gitRevision, urlTemplate) {
+            this.path = path;
+            this.gitRevision = gitRevision;
+            this.urlTemplate = urlTemplate;
+            const out = git("-C", path, "ls-files", "-z");
+            if (out.status === 0) {
+                out.stdout.split("\0").forEach((file) => {
+                    if (file !== "") {
+                        this.files.add(normalizePath(path + "/" + file));
+                    }
+                });
             }
-            /**
-             * Get the URL of the given file on GitHub or Bitbucket.
-             *
-             * @param fileName  The file whose URL should be determined.
-             * @returns A URL pointing to the web preview of the given file or undefined.
-             */
-            getURL(fileName, line) {
-                if (!this.files.has(fileName)) {
-                    return;
-                }
-                const replacements = {
-                    gitRevision: this.gitRevision,
-                    "gitRevision:short": this.gitRevision.substring(0, 8),
-                    path: fileName.substring(this.path.length + 1),
-                    line,
-                };
-                return this.urlTemplate.replace(/\{(gitRevision|gitRevision:short|path|line)\}/g, (_, key) => replacements[key]);
+        }
+        /**
+         * Get the URL of the given file on GitHub or Bitbucket.
+         *
+         * @param fileName  The file whose URL should be determined.
+         * @returns A URL pointing to the web preview of the given file or undefined.
+         */
+        getURL(fileName, line) {
+            if (!this.files.has(fileName)) {
+                return;
             }
-            /**
-             * Try to create a new repository instance.
-             *
-             * Checks whether the given path is the root of a valid repository and if so
-             * creates a new instance of {@link GitRepository}.
-             *
-             * @param path  The potential repository root.
-             * @returns A new instance of {@link GitRepository} or undefined.
-             */
-            static tryCreateRepository(path, sourceLinkTemplate, gitRevision, gitRemote, logger) {
-                gitRevision ||= git("-C", path, "rev-parse", "HEAD").stdout.trim();
-                if (!gitRevision)
-                    return; // Will only happen in a repo with no commits.
-                let urlTemplate;
-                if (sourceLinkTemplate) {
-                    urlTemplate = sourceLinkTemplate;
+            const replacements = {
+                gitRevision: this.gitRevision,
+                "gitRevision:short": this.gitRevision.substring(0, 8),
+                path: fileName.substring(this.path.length + 1),
+                line,
+            };
+            return this.urlTemplate.replace(/\{(gitRevision|gitRevision:short|path|line)\}/g, (_, key) => replacements[key]);
+        }
+        /**
+         * Try to create a new repository instance.
+         *
+         * Checks whether the given path is the root of a valid repository and if so
+         * creates a new instance of {@link GitRepository}.
+         *
+         * @param path  The potential repository root.
+         * @returns A new instance of {@link GitRepository} or undefined.
+         */
+        static tryCreateRepository(path, sourceLinkTemplate, gitRevision, gitRemote, logger) {
+            gitRevision ||= git("-C", path, "rev-parse", "HEAD").stdout.trim();
+            if (!gitRevision)
+                return; // Will only happen in a repo with no commits.
+            let urlTemplate;
+            if (sourceLinkTemplate) {
+                urlTemplate = sourceLinkTemplate;
+            }
+            else {
+                const remotesOut = git("-C", path, "remote", "get-url", gitRemote);
+                if (remotesOut.status === 0) {
+                    urlTemplate = guessSourceUrlTemplate(remotesOut.stdout.split("\n"));
                 }
                 else {
-                    const remotesOut = git("-C", path, "remote", "get-url", gitRemote);
-                    if (remotesOut.status === 0) {
-                        urlTemplate = guessSourceUrlTemplate(remotesOut.stdout.split("\n"));
-                    }
-                    else {
-                        logger.warn(logger.i18n.git_remote_0_not_valid(gitRemote));
-                    }
+                    logger.warn(logger.i18n.git_remote_0_not_valid(gitRemote));
                 }
-                if (!urlTemplate)
-                    return;
-                return new _a((0, utils_1.normalizePath)(path), gitRevision, urlTemplate);
             }
-        },
-        (() => {
-            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
-            _files_decorators = [general_1.NonEnumerable];
-            __esDecorate(null, null, _files_decorators, { kind: "field", name: "files", static: false, private: false, access: { has: obj => "files" in obj, get: obj => obj.files, set: (obj, value) => { obj.files = value; } }, metadata: _metadata }, _files_initializers, _files_extraInitializers);
-            if (_metadata) Object.defineProperty(_a, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
-        })(),
-        _a;
+            if (!urlTemplate)
+                return;
+            return new GitRepository(normalizePath(path), gitRevision, urlTemplate);
+        }
+    };
 })();
-exports.GitRepository = GitRepository;
+export { GitRepository };
 /**
  * Responsible for keeping track of 0-N repositories which exist on a machine.
  * This used to be inlined in SourcePlugin, moved out for easy unit testing.
@@ -187,7 +187,15 @@ exports.GitRepository = GitRepository;
  * file. Unlike TypeScript, we will resolve the path, as the repo link should really
  * point to the actual file.
  */
-class RepositoryManager {
+export class RepositoryManager {
+    basePath;
+    gitRevision;
+    gitRemote;
+    sourceLinkTemplate;
+    disableGit;
+    logger;
+    cache = new Map();
+    assumedRepo;
     constructor(basePath, gitRevision, gitRemote, sourceLinkTemplate, disableGit, logger) {
         this.basePath = basePath;
         this.gitRevision = gitRevision;
@@ -195,7 +203,6 @@ class RepositoryManager {
         this.sourceLinkTemplate = sourceLinkTemplate;
         this.disableGit = disableGit;
         this.logger = logger;
-        this.cache = new Map();
         this.assumedRepo = new AssumedRepository(this.basePath, this.gitRevision, this.sourceLinkTemplate);
     }
     /**
@@ -208,13 +215,13 @@ class RepositoryManager {
         if (this.disableGit) {
             return this.assumedRepo;
         }
-        return this.getRepositoryFolder((0, utils_1.normalizePath)((0, path_1.dirname)(fileName)));
+        return this.getRepositoryFolder(normalizePath(dirname(fileName)));
     }
     getRepositoryFolder(dir) {
         if (this.cache.has(dir)) {
             return this.cache.get(dir);
         }
-        if ((0, fs_1.existsSync)((0, path_1.join)(dir, ".git"))) {
+        if (existsSync(join(dir, ".git"))) {
             // This might just be a git repo, or we might be in some self-recursive symlink
             // loop, and the repo is actually somewhere else. Ask Git where the repo actually is.
             const repo = git("-C", dir, "rev-parse", "--show-toplevel");
@@ -235,12 +242,11 @@ class RepositoryManager {
         else {
             // We may be at the root of the file system, in which case there is no repo.
             this.cache.set(dir, undefined);
-            this.cache.set(dir, this.getRepositoryFolder((0, path_1.dirname)(dir)));
+            this.cache.set(dir, this.getRepositoryFolder(dirname(dir)));
         }
         return this.cache.get(dir);
     }
 }
-exports.RepositoryManager = RepositoryManager;
 // Should have three capturing groups:
 // 1. hostname
 // 2. user
@@ -253,7 +259,7 @@ const repoExpressions = [
     /(bitbucket.org)[:/]([^/]+)\/(.*)/,
     /(gitlab.com)[:/]([^/]+)\/(.*)/,
 ];
-function guessSourceUrlTemplate(remotes) {
+export function guessSourceUrlTemplate(remotes) {
     let hostname = "";
     let user = "";
     let project = "";

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

@@ -1,13 +1,7 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveAliasedSymbol = resolveAliasedSymbol;
-const typescript_1 = __importDefault(require("typescript"));
-function resolveAliasedSymbol(symbol, checker) {
+import ts from "typescript";
+export function resolveAliasedSymbol(symbol, checker) {
     const seen = new Set();
-    while (typescript_1.default.SymbolFlags.Alias & symbol.flags) {
+    while (ts.SymbolFlags.Alias & symbol.flags) {
         symbol = checker.getAliasedSymbol(symbol);
         // #2438, with declaration files, we might have an aliased symbol which eventually points to itself.
         if (seen.has(symbol))

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

@@ -1,7 +1,6 @@
 /**
- * Internationalization module, see {@link "Adding Locales" | Adding Locales} for details on extending TypeDoc.
- *
+ * Internationalization module for localized strings in output.
+ * @summary Internationalization module for localized strings in output.
  * @module
- * @document ../../../internal-docs/internationalization.md
  */
-export { type TranslatableStrings, Internationalization, type TranslatedString, type TranslationProxy, } from "./internationalization";
+export { type TranslatableStrings, Internationalization, type TranslatedString, type TranslationProxy, } from "./internationalization.js";

package/dist/lib/internationalization/index.js

@@ -1,11 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Internationalization = void 0;
 /**
- * Internationalization module, see {@link "Adding Locales" | Adding Locales} for details on extending TypeDoc.
- *
+ * Internationalization module for localized strings in output.
+ * @summary Internationalization module for localized strings in output.
  * @module
- * @document ../../../internal-docs/internationalization.md
  */
-var internationalization_1 = require("./internationalization");
-Object.defineProperty(exports, "Internationalization", { enumerable: true, get: function () { return internationalization_1.Internationalization; } });
+export { Internationalization, } from "./internationalization.js";

package/dist/lib/internationalization/internationalization.d.ts

@@ -1,7 +1,8 @@
-import type { Application } from "../application";
-import { translatable, type BuiltinTranslatableStringArgs } from "./translatable";
-import { ReflectionKind } from "../models/reflections/kind";
-import { ReflectionFlag } from "../models";
+import type { Application } from "../application.js";
+import { ReflectionKind } from "../models/reflections/kind.js";
+import { ReflectionFlag } from "../models/index.js";
+import { type BuiltinTranslatableStringArgs } from "./translatable.js";
+import translatable from "./locales/en.cjs";
 /**
  * ### What is translatable?
  * TypeDoc includes a lot of literal strings. By convention, messages which are displayed