typedoc 0.25.12 → 0.26.0-beta.0

package/dist/index.d.ts

@@ -18,11 +18,12 @@ export * as Models from "./lib/models";
 export * as Configuration from "./lib/utils/options";
 export * from "./lib/models";
 export { Converter, Context, type CommentParserConfig, type DeclarationReference, type SymbolReference, type ComponentPath, type Meaning, type MeaningKeyword, type ExternalResolveResult, type ExternalSymbolResolver, } from "./lib/converter";
-export { Renderer, DefaultTheme, DefaultThemeRenderContext, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, IndexEvent, } from "./lib/output";
+export { Renderer, DefaultTheme, DefaultThemeRenderContext, Slugger, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, IndexEvent, } from "./lib/output";
 export type { RenderTemplate, RendererHooks, NavigationElement, } from "./lib/output";
-export { ArgumentsReader, Option, BindOption, CommentStyle, JSX, LogLevel, Logger, Options, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, MinimalSourceFile, normalizePath, } from "./lib/utils";
+export { ArgumentsReader, Option, CommentStyle, JSX, LogLevel, Logger, Options, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, MinimalSourceFile, normalizePath, } from "./lib/utils";
 export type { OptionsReader, TypeDocOptions, TypeDocOptionMap, ValidationOptions, TypeDocOptionValues, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, ObjectDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, SortStrategy, ParameterTypeToOptionTypeMap, DocumentationEntryPoint, ManuallyValidatedOption, EnumKeys, JsDocCompatibility, } from "./lib/utils";
 export type { EventMap, EventCallback } from "./lib/utils/events";
 export { JSONOutput, Serializer, Deserializer, type Deserializable, type DeserializerComponent, type SerializerComponent, SerializeEvent, } from "./lib/serialization";
+export * as Internationalization from "./lib/internationalization/index";
 import TypeScript from "typescript";
 export { TypeScript };

package/dist/index.js

@@ -29,7 +29,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeScript = exports.SerializeEvent = exports.Deserializer = exports.Serializer = exports.JSONOutput = exports.normalizePath = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.BindOption = exports.Option = exports.ArgumentsReader = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.Configuration = exports.Models = exports.resetReflectionID = exports.Event = exports.EventDispatcher = exports.Application = void 0;
+exports.TypeScript = exports.Internationalization = exports.SerializeEvent = exports.Deserializer = exports.Serializer = exports.JSONOutput = exports.normalizePath = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.Option = exports.ArgumentsReader = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.Slugger = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.Configuration = exports.Models = exports.resetReflectionID = exports.Event = exports.EventDispatcher = exports.Application = void 0;
 var application_1 = require("./lib/application");
 Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return application_1.Application; } });
 var events_1 = require("./lib/utils/events");
@@ -60,6 +60,7 @@ var output_1 = require("./lib/output");
 Object.defineProperty(exports, "Renderer", { enumerable: true, get: function () { return output_1.Renderer; } });
 Object.defineProperty(exports, "DefaultTheme", { enumerable: true, get: function () { return output_1.DefaultTheme; } });
 Object.defineProperty(exports, "DefaultThemeRenderContext", { enumerable: true, get: function () { return output_1.DefaultThemeRenderContext; } });
+Object.defineProperty(exports, "Slugger", { enumerable: true, get: function () { return output_1.Slugger; } });
 Object.defineProperty(exports, "UrlMapping", { enumerable: true, get: function () { return output_1.UrlMapping; } });
 Object.defineProperty(exports, "Theme", { enumerable: true, get: function () { return output_1.Theme; } });
 Object.defineProperty(exports, "PageEvent", { enumerable: true, get: function () { return output_1.PageEvent; } });
@@ -69,7 +70,6 @@ Object.defineProperty(exports, "IndexEvent", { enumerable: true, get: function (
 var utils_1 = require("./lib/utils");
 Object.defineProperty(exports, "ArgumentsReader", { enumerable: true, get: function () { return utils_1.ArgumentsReader; } });
 Object.defineProperty(exports, "Option", { enumerable: true, get: function () { return utils_1.Option; } });
-Object.defineProperty(exports, "BindOption", { enumerable: true, get: function () { return utils_1.BindOption; } });
 Object.defineProperty(exports, "CommentStyle", { enumerable: true, get: function () { return utils_1.CommentStyle; } });
 Object.defineProperty(exports, "JSX", { enumerable: true, get: function () { return utils_1.JSX; } });
 Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return utils_1.LogLevel; } });
@@ -89,5 +89,6 @@ Object.defineProperty(exports, "JSONOutput", { enumerable: true, get: function (
 Object.defineProperty(exports, "Serializer", { enumerable: true, get: function () { return serialization_1.Serializer; } });
 Object.defineProperty(exports, "Deserializer", { enumerable: true, get: function () { return serialization_1.Deserializer; } });
 Object.defineProperty(exports, "SerializeEvent", { enumerable: true, get: function () { return serialization_1.SerializeEvent; } });
+exports.Internationalization = __importStar(require("./lib/internationalization/index"));
 const typescript_1 = __importDefault(require("typescript"));
 exports.TypeScript = typescript_1.default;

package/dist/lib/application.d.ts

@@ -2,11 +2,12 @@ import { Converter } from "./converter/index";
 import { Renderer } from "./output/renderer";
 import { Deserializer, Serializer } from "./serialization";
 import type { ProjectReflection } from "./models/index";
-import { Logger, OptionsReader } from "./utils/index";
-import { AbstractComponent, ChildableComponent } from "./utils/component";
+import { Logger, type OptionsReader } from "./utils/index";
+import { type AbstractComponent, ChildableComponent } from "./utils/component";
 import { Options } from "./utils";
 import type { TypeDocOptions } from "./utils/options/declaration";
-import { DocumentationEntryPoint, EntryPointStrategy } from "./utils/entry-point";
+import { type DocumentationEntryPoint, EntryPointStrategy } from "./utils/entry-point";
+import { Internationalization } from "./internationalization/internationalization";
 export declare function createAppForTesting(): Application;
 /**
  * The default TypeDoc main application class.
@@ -42,8 +43,19 @@ export declare class Application extends ChildableComponent<Application, Abstrac
      * The logger that should be used to output messages.
      */
     logger: Logger;
+    /**
+     * Internationalization module which supports translating according to
+     * the `lang` option.
+     */
+    internationalization: Internationalization;
+    /**
+     * Proxy based shortcuts for internationalization keys.
+     */
+    i18n: import("./internationalization/internationalization").TranslationProxy;
     options: Options;
     /** @internal */
+    accessor lang: string;
+    /** @internal */
     accessor skipErrorChecking: boolean;
     /** @internal */
     accessor entryPointStrategy: EntryPointStrategy;

package/dist/lib/application.js

@@ -75,7 +75,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Application = exports.createAppForTesting = void 0;
+exports.Application = void 0;
+exports.createAppForTesting = createAppForTesting;
 const Path = __importStar(require("path"));
 const typescript_1 = __importDefault(require("typescript"));
 const index_1 = require("./converter/index");
@@ -97,6 +98,8 @@ const tsconfig_1 = require("./utils/tsconfig");
 const fs_1 = require("./utils/fs");
 const abstract_1 = require("./models/reflections/abstract");
 const ReflectionSymbolId_1 = require("./models/reflections/ReflectionSymbolId");
+const internationalization_1 = require("./internationalization/internationalization");
+const highlighter_1 = require("./utils/highlighter");
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const packageInfo = require("../../package.json");
 const supportedVersionMajorMinor = packageInfo.peerDependencies.typescript
@@ -107,7 +110,6 @@ function createAppForTesting() {
     // @ts-expect-error private constructor
     return new Application(DETECTOR);
 }
-exports.createAppForTesting = createAppForTesting;
 const DEFAULT_READERS = [
     new index_2.TypeDocReader(),
     new index_2.PackageJsonReader(),
@@ -127,12 +129,15 @@ const DEFAULT_READERS = [
  * Subscribe to these Events to control the application flow or alter the output.
  */
 let Application = (() => {
-    var _Application_skipErrorChecking_accessor_storage, _Application_entryPointStrategy_accessor_storage, _Application_entryPoints_accessor_storage;
+    var _Application_lang_accessor_storage, _Application_skipErrorChecking_accessor_storage, _Application_entryPointStrategy_accessor_storage, _Application_entryPoints_accessor_storage;
     let _classDecorators = [(0, component_1.Component)({ name: "application", internal: true })];
     let _classDescriptor;
     let _classExtraInitializers = [];
     let _classThis;
     let _classSuper = component_1.ChildableComponent;
+    let _lang_decorators;
+    let _lang_initializers = [];
+    let _lang_extraInitializers = [];
     let _skipErrorChecking_decorators;
     let _skipErrorChecking_initializers = [];
     let _skipErrorChecking_extraInitializers = [];
@@ -143,6 +148,9 @@ let Application = (() => {
     let _entryPoints_initializers = [];
     let _entryPoints_extraInitializers = [];
     var Application = _classThis = class extends _classSuper {
+        /** @internal */
+        get lang() { return __classPrivateFieldGet(this, _Application_lang_accessor_storage, "f"); }
+        set lang(value) { __classPrivateFieldSet(this, _Application_lang_accessor_storage, value, "f"); }
         /** @internal */
         get skipErrorChecking() { return __classPrivateFieldGet(this, _Application_skipErrorChecking_accessor_storage, "f"); }
         set skipErrorChecking(value) { __classPrivateFieldSet(this, _Application_skipErrorChecking_accessor_storage, value, "f"); }
@@ -172,18 +180,30 @@ let Application = (() => {
              * The logger that should be used to output messages.
              */
             this.logger = new index_2.ConsoleLogger();
-            this.options = new utils_1.Options();
-            _Application_skipErrorChecking_accessor_storage.set(this, __runInitializers(this, _skipErrorChecking_initializers, void 0));
+            /**
+             * Internationalization module which supports translating according to
+             * the `lang` option.
+             */
+            this.internationalization = new internationalization_1.Internationalization(this);
+            /**
+             * Proxy based shortcuts for internationalization keys.
+             */
+            this.i18n = this.internationalization.proxy;
+            this.options = new utils_1.Options(this.i18n);
+            _Application_lang_accessor_storage.set(this, __runInitializers(this, _lang_initializers, void 0));
+            _Application_skipErrorChecking_accessor_storage.set(this, (__runInitializers(this, _lang_extraInitializers), __runInitializers(this, _skipErrorChecking_initializers, void 0)));
             _Application_entryPointStrategy_accessor_storage.set(this, (__runInitializers(this, _skipErrorChecking_extraInitializers), __runInitializers(this, _entryPointStrategy_initializers, void 0)));
             _Application_entryPoints_accessor_storage.set(this, (__runInitializers(this, _entryPointStrategy_extraInitializers), __runInitializers(this, _entryPoints_initializers, void 0)));
             __runInitializers(this, _entryPoints_extraInitializers);
             this.converter = this.addComponent("converter", index_1.Converter);
             this.renderer = this.addComponent("renderer", renderer_1.Renderer);
+            this.logger.i18n = this.i18n;
         }
         /**
          * Initialize TypeDoc, loading plugins if applicable.
          */
         static async bootstrapWithPlugins(options = {}, readers = DEFAULT_READERS) {
+            await (0, highlighter_1.loadShikiMetadata)();
             const app = new Application(DETECTOR);
             readers.forEach((r) => app.options.addReader(r));
             app.options.reset();
@@ -207,6 +227,7 @@ let Application = (() => {
          * @param readers Option readers to use to discover options from config files.
          */
         static async bootstrap(options = {}, readers = DEFAULT_READERS) {
+            await (0, highlighter_1.loadShikiMetadata)();
             const app = new Application(DETECTOR);
             readers.forEach((r) => app.options.addReader(r));
             await app._bootstrap(options);
@@ -218,10 +239,22 @@ let Application = (() => {
             await this.options.read(this.logger);
             this.setOptions(options);
             this.logger.level = this.options.getValue("logLevel");
+            for (const [lang, locales] of Object.entries(this.options.getValue("locales"))) {
+                this.internationalization.addTranslations(lang, locales);
+            }
             if ((0, general_1.hasBeenLoadedMultipleTimes)()) {
-                this.logger.warn(`TypeDoc has been loaded multiple times. This is commonly caused by plugins which have their own installation of TypeDoc. The loaded paths are:\n\t${(0, general_1.getLoadedPaths)().join("\n\t")}`);
+                this.logger.warn(this.i18n.loaded_multiple_times_0((0, general_1.getLoadedPaths)().join("\n\t")));
             }
             this.trigger(application_events_1.ApplicationEvents.BOOTSTRAP_END, this);
+            if (!this.internationalization.hasTranslations(this.lang)) {
+                // Not internationalized as by definition we don't know what to include here.
+                this.logger.warn(`Options specified "${this.lang}" as the language to use, but TypeDoc does not support it.`);
+                this.logger.info(("The supported languages are:\n\t" +
+                    this.internationalization
+                        .getSupportedLanguages()
+                        .join("\n\t")));
+                this.logger.info("You can define/override local locales with the `locales` option, or contribute them to TypeDoc!");
+            }
         }
         setOptions(options, reportErrors = true) {
             for (const [key, val] of Object.entries(options)) {
@@ -270,7 +303,7 @@ let Application = (() => {
                 return this._convertPackages();
             }
             if (!supportedVersionMajorMinor.some((version) => version == typescript_1.default.versionMajorMinor)) {
-                this.logger.warn(`You are running with an unsupported TypeScript version! If TypeDoc crashes, this is why. TypeDoc supports ${supportedVersionMajorMinor.join(", ")}`);
+                this.logger.warn(this.i18n.unsupported_ts_version_0(supportedVersionMajorMinor.join(", ")));
             }
             const entryPoints = this.getEntryPoints();
             if (!entryPoints) {
@@ -305,21 +338,21 @@ let Application = (() => {
             }
             this.logger.verbose(`Using TypeScript ${this.getTypeScriptVersion()} from ${this.getTypeScriptPath()}`);
             if (!supportedVersionMajorMinor.some((version) => version == typescript_1.default.versionMajorMinor)) {
-                this.logger.warn(`You are running with an unsupported TypeScript version! TypeDoc supports ${supportedVersionMajorMinor.join(", ")}`);
+                this.logger.warn(this.i18n.unsupported_ts_version_0(supportedVersionMajorMinor.join(", ")));
             }
             if (Object.keys(this.options.getCompilerOptions()).length === 0) {
-                this.logger.warn(`No compiler options set. This likely means that TypeDoc did not find your tsconfig.json. Generated documentation will probably be empty.`);
+                this.logger.warn(this.i18n.no_compiler_options_set());
             }
             // Doing this is considerably more complicated, we'd need to manage an array of programs, not convert until all programs
             // have reported in the first time... just error out for now. I'm not convinced anyone will actually notice.
             if (this.options.getFileNames().length === 0) {
-                this.logger.error("The provided tsconfig file looks like a solution style tsconfig, which is not supported in watch mode.");
+                this.logger.error(this.i18n.solution_not_supported_in_watch_mode());
                 return;
             }
             // Support for packages mode is currently unimplemented
             if (this.entryPointStrategy !== entry_point_1.EntryPointStrategy.Resolve &&
                 this.entryPointStrategy !== entry_point_1.EntryPointStrategy.Expand) {
-                this.logger.error("entryPointStrategy must be set to either resolve or expand for watch mode.");
+                this.logger.error(this.i18n.strategy_not_supported_in_watch_mode());
                 return;
             }
             const tsconfigFile = (0, tsconfig_1.findTsConfigFile)(this.options.getValue("tsconfig")) ??
@@ -406,10 +439,10 @@ let Application = (() => {
             out = Path.resolve(out);
             await this.renderer.render(project, out);
             if (this.logger.hasErrors()) {
-                this.logger.error("Documentation could not be generated due to the errors above.");
+                this.logger.error(this.i18n.docs_could_not_be_generated());
             }
             else {
-                this.logger.info(`Documentation generated at ${(0, paths_1.nicePath)(out)}`);
+                this.logger.info(this.i18n.docs_generated_at_0((0, paths_1.nicePath)(out)));
                 this.logger.verbose(`HTML rendering took ${Date.now() - start}ms`);
             }
         }
@@ -425,7 +458,7 @@ let Application = (() => {
             const ser = this.serializer.projectToObject(project, process.cwd());
             const space = this.options.getValue("pretty") ? "\t" : "";
             await (0, index_2.writeFile)(out, JSON.stringify(ser, null, space));
-            this.logger.info(`JSON written to ${(0, paths_1.nicePath)(out)}`);
+            this.logger.info(this.i18n.json_written_to_0((0, paths_1.nicePath)(out)));
             this.logger.verbose(`JSON rendering took ${Date.now() - start}ms`);
         }
         /**
@@ -441,12 +474,12 @@ let Application = (() => {
         }
         async _convertPackages() {
             if (!this.options.isSet("entryPoints")) {
-                this.logger.error("No entry points provided to packages mode, documentation cannot be generated.");
+                this.logger.error(this.i18n.no_entry_points_for_packages());
                 return;
             }
             const packageDirs = (0, entry_point_1.getPackageDirectories)(this.logger, this.options, this.options.getValue("entryPoints"));
             if (packageDirs.length === 0) {
-                this.logger.error("Failed to find any packages, ensure you have provided at least one directory as an entry point containing package.json");
+                this.logger.error(this.i18n.failed_to_find_packages());
                 return;
             }
             const origOptions = this.options;
@@ -461,14 +494,14 @@ let Application = (() => {
                 opts.setValue("validation", { invalidLink: false });
                 if (opts.getValue("entryPointStrategy") ===
                     entry_point_1.EntryPointStrategy.Packages) {
-                    this.logger.error(`Project at ${(0, paths_1.nicePath)(dir)} has entryPointStrategy set to packages, but nested packages are not supported.`);
+                    this.logger.error(this.i18n.nested_packages_unsupported_0((0, paths_1.nicePath)(dir)));
                     continue;
                 }
                 (0, ReflectionSymbolId_1.addInferredDeclarationMapPaths)(opts.getCompilerOptions(), opts.getFileNames());
                 projectsToConvert.push({ dir, options: opts });
             }
             for (const { dir, options } of projectsToConvert) {
-                this.logger.info(`Converting project at ${(0, paths_1.nicePath)(dir)}`);
+                this.logger.info(this.i18n.converting_project_at_0((0, paths_1.nicePath)(dir)));
                 this.options = options;
                 const project = await this.convert();
                 if (project) {
@@ -478,11 +511,11 @@ let Application = (() => {
                 (0, abstract_1.resetReflectionID)();
             }
             this.options = origOptions;
-            this.logger.info(`Merging converted projects`);
             if (projects.length !== packageDirs.length) {
-                this.logger.error("Failed to convert one or more packages, result will not be merged together.");
+                this.logger.error(this.i18n.failed_to_convert_packages());
                 return;
             }
+            this.logger.info(this.i18n.merging_converted_projects());
             const result = this.deserializer.reviveProjects(this.options.getValue("name") || "Documentation", projects);
             this.trigger(application_events_1.ApplicationEvents.REVIVE, result);
             return result;
@@ -490,14 +523,14 @@ let Application = (() => {
         _merge() {
             const start = Date.now();
             if (!this.options.isSet("entryPoints")) {
-                this.logger.error("No entry points provided to merge.");
+                this.logger.error(this.i18n.no_entry_points_to_merge());
                 return;
             }
             const rootDir = (0, fs_1.deriveRootDir)(this.entryPoints);
             const entryPoints = this.entryPoints.flatMap((entry) => {
                 const result = (0, fs_1.glob)(entry, rootDir);
                 if (result.length === 0) {
-                    this.logger.warn(`The entrypoint glob ${(0, paths_1.nicePath)(entry)} did not match any files.`);
+                    this.logger.warn(this.i18n.entrypoint_did_not_match_files_0((0, paths_1.nicePath)(entry)));
                 }
                 else {
                     this.logger.verbose(`Expanded ${(0, paths_1.nicePath)(entry)} to:\n\t${result
@@ -511,7 +544,7 @@ let Application = (() => {
                     return JSON.parse((0, fs_1.readFile)(path));
                 }
                 catch {
-                    this.logger.error(`Failed to parse file at ${(0, paths_1.nicePath)(path)} as json.`);
+                    this.logger.error(this.i18n.failed_to_parse_json_0((0, paths_1.nicePath)(path)));
                     return null;
                 }
             });
@@ -519,19 +552,28 @@ let Application = (() => {
                 return;
             const result = this.deserializer.reviveProjects(this.options.getValue("name"), jsonProjects);
             this.logger.verbose(`Reviving projects took ${Date.now() - start}ms`);
+            // If we only revived one project, the project documents were set for
+            // it when it was created. If we revived more than one project then
+            // it's convenient to be able to add more documents now.
+            if (jsonProjects.length > 1) {
+                this.converter.addProjectDocuments(result);
+            }
             this.trigger(application_events_1.ApplicationEvents.REVIVE, result);
             return result;
         }
     };
+    _Application_lang_accessor_storage = new WeakMap();
     _Application_skipErrorChecking_accessor_storage = new WeakMap();
     _Application_entryPointStrategy_accessor_storage = new WeakMap();
     _Application_entryPoints_accessor_storage = new WeakMap();
     __setFunctionName(_classThis, "Application");
     (() => {
         const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+        _lang_decorators = [(0, utils_1.Option)("lang")];
         _skipErrorChecking_decorators = [(0, utils_1.Option)("skipErrorChecking")];
         _entryPointStrategy_decorators = [(0, utils_1.Option)("entryPointStrategy")];
         _entryPoints_decorators = [(0, utils_1.Option)("entryPoints")];
+        __esDecorate(_classThis, null, _lang_decorators, { kind: "accessor", name: "lang", static: false, private: false, access: { has: obj => "lang" in obj, get: obj => obj.lang, set: (obj, value) => { obj.lang = value; } }, metadata: _metadata }, _lang_initializers, _lang_extraInitializers);
         __esDecorate(_classThis, null, _skipErrorChecking_decorators, { kind: "accessor", name: "skipErrorChecking", static: false, private: false, access: { has: obj => "skipErrorChecking" in obj, get: obj => obj.skipErrorChecking, set: (obj, value) => { obj.skipErrorChecking = value; } }, metadata: _metadata }, _skipErrorChecking_initializers, _skipErrorChecking_extraInitializers);
         __esDecorate(_classThis, null, _entryPointStrategy_decorators, { kind: "accessor", name: "entryPointStrategy", static: false, private: false, access: { has: obj => "entryPointStrategy" in obj, get: obj => obj.entryPointStrategy, set: (obj, value) => { obj.entryPointStrategy = value; } }, metadata: _metadata }, _entryPointStrategy_initializers, _entryPointStrategy_extraInitializers);
         __esDecorate(_classThis, null, _entryPoints_decorators, { kind: "accessor", name: "entryPoints", static: false, private: false, access: { has: obj => "entryPoints" in obj, get: obj => obj.entryPoints, set: (obj, value) => { obj.entryPoints = value; } }, metadata: _metadata }, _entryPoints_initializers, _entryPoints_extraInitializers);

package/dist/lib/cli.js

@@ -67,7 +67,7 @@ async function run(app) {
         return ExitCodes.Ok;
     }
     if (app.options.getValue("help")) {
-        console.log(app.options.getHelp());
+        console.log(app.options.getHelp(app.i18n));
         return ExitCodes.Ok;
     }
     if (app.options.getValue("showConfig")) {

package/dist/lib/converter/comments/blockLexer.d.ts

@@ -1,3 +1,3 @@
 import ts from "typescript";
-import { Token } from "./lexer";
+import { type Token } from "./lexer";
 export declare function lexBlockComment(file: string, pos?: number, end?: number, jsDoc?: ts.JSDoc | undefined, checker?: ts.TypeChecker | undefined): Generator<Token, undefined, undefined>;

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

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lexBlockComment = void 0;
+exports.lexBlockComment = lexBlockComment;
 const typescript_1 = __importDefault(require("typescript"));
 const lexer_1 = require("./lexer");
 const ReflectionSymbolId_1 = require("../../models/reflections/ReflectionSymbolId");
@@ -33,7 +33,6 @@ function* lexBlockComment(file, pos = 0, end = file.length, jsDoc = undefined, c
     }
     return;
 }
-exports.lexBlockComment = lexBlockComment;
 function getLinkTags(jsDoc) {
     const result = [];
     if (jsDoc?.comment && typeof jsDoc.comment !== "string") {

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

@@ -7,7 +7,14 @@
  * @module
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseDeclarationReference = exports.parseMeaning = exports.parseComponentPath = exports.parseComponent = exports.parseSymbolReference = exports.parseModuleSource = exports.parseString = exports.MeaningKeywords = void 0;
+exports.MeaningKeywords = void 0;
+exports.parseString = parseString;
+exports.parseModuleSource = parseModuleSource;
+exports.parseSymbolReference = parseSymbolReference;
+exports.parseComponent = parseComponent;
+exports.parseComponentPath = parseComponentPath;
+exports.parseMeaning = parseMeaning;
+exports.parseDeclarationReference = parseDeclarationReference;
 exports.MeaningKeywords = [
     "class", // SymbolFlags.Class
     "interface", // SymbolFlags.Interface
@@ -144,7 +151,6 @@ function parseString(source, pos, end) {
         result += source[pos++];
     }
 }
-exports.parseString = parseString;
 // ModuleSource:: String | ModuleSourceCharacters
 function parseModuleSource(source, pos, end) {
     if (pos >= end)
@@ -161,7 +167,6 @@ function parseModuleSource(source, pos, end) {
         return;
     return [source.substring(pos, lookahead), lookahead];
 }
-exports.parseModuleSource = parseModuleSource;
 // SymbolReference:
 //     ComponentPath Meaning?
 //     Meaning
@@ -174,7 +179,6 @@ function parseSymbolReference(source, pos, end) {
         return [{ path: path?.[0], meaning: meaning?.[0] }, pos];
     }
 }
-exports.parseSymbolReference = parseSymbolReference;
 // Component::
 //     String
 //     ComponentCharacters
@@ -196,7 +200,6 @@ function parseComponent(source, pos, end) {
         return;
     return [source.substring(pos, lookahead), lookahead];
 }
-exports.parseComponent = parseComponent;
 // ComponentPath:
 //     Component
 //     ComponentPath `.` Component                      // Navigate via 'exports' of |ComponentPath|
@@ -221,7 +224,6 @@ function parseComponentPath(source, pos, end) {
     }
     return [components, pos];
 }
-exports.parseComponentPath = parseComponentPath;
 // The TSDoc specification permits the first four branches of Meaning. TypeDoc adds the UserLabel
 // branch so that the @label tag can be used with this form of declaration references.
 // Meaning:
@@ -281,7 +283,6 @@ function parseMeaning(source, pos, end) {
         return [{ keyword }, pos];
     }
 }
-exports.parseMeaning = parseMeaning;
 // // NOTE: The following grammar is incorrect as |SymbolReference| and |ModuleSource| have an
 // //       ambiguous parse. The correct solution is to use a cover grammar to parse
 // //       |SymbolReference| until we hit a `!` and then reinterpret the grammar.
@@ -326,4 +327,3 @@ function parseDeclarationReference(source, pos, end) {
         pos,
     ];
 }
-exports.parseDeclarationReference = parseDeclarationReference;

package/dist/lib/converter/comments/declarationReferenceResolver.d.ts

@@ -1,3 +1,3 @@
-import { Reflection } from "../../models";
+import { type Reflection } from "../../models";
 import type { DeclarationReference } from "./declarationReference";
 export declare function resolveDeclarationReference(reflection: Reflection, ref: DeclarationReference): Reflection | undefined;

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveDeclarationReference = void 0;
+exports.resolveDeclarationReference = resolveDeclarationReference;
 const assert_1 = require("assert");
 const models_1 = require("../../models");
 const utils_1 = require("../../utils");
@@ -48,7 +48,7 @@ function resolveDeclarationReference(reflection, ref) {
         }
         else if (high[0] !== reflection) {
             if (reflection.parent instanceof models_1.ContainerReflection) {
-                high.push(...(reflection.parent.children?.filter((c) => c.name === reflection.name) || []));
+                high.push(...(reflection.parent.childrenIncludingDocuments?.filter((c) => c.name === reflection.name) || []));
             }
             else {
                 high.push(reflection);
@@ -79,7 +79,6 @@ function resolveDeclarationReference(reflection, ref) {
     }
     return high[0] || low[0];
 }
-exports.resolveDeclarationReference = resolveDeclarationReference;
 function filterMapByMeaning(reflections, meaning) {
     return (0, utils_1.filterMap)(reflections, (refl) => {
         const kwResolved = resolveKeyword(refl, meaning.keyword) || [];
@@ -144,8 +143,8 @@ function resolveKeyword(refl, kw) {
         case "call":
             return refl.signatures;
         case "index":
-            if (refl.indexSignature) {
-                return [refl.indexSignature];
+            if (refl.indexSignatures) {
+                return refl.indexSignatures;
             }
             break;
         case "complex":
@@ -169,7 +168,8 @@ function resolveKeyword(refl, kw) {
 function resolveSymbolReferencePart(refl, path) {
     let high = [];
     let low = [];
-    if (!(refl instanceof models_1.ContainerReflection) || !refl.children) {
+    if (!(refl instanceof models_1.ContainerReflection) ||
+        !refl.childrenIncludingDocuments) {
         return { high, low };
     }
     switch (path.navigation) {
@@ -178,25 +178,26 @@ function resolveSymbolReferencePart(refl, path) {
         // so that resolution doesn't behave very poorly with projects using JSDoc style resolution.
         // Also is more consistent with how TypeScript resolves link tags.
         case ".":
-            high = refl.children.filter((r) => r.name === path.path &&
+            high = refl.childrenIncludingDocuments.filter((r) => r.name === path.path &&
                 (r.kindOf(models_1.ReflectionKind.SomeExport) || r.flags.isStatic));
-            low = refl.children.filter((r) => r.name === path.path &&
+            low = refl.childrenIncludingDocuments.filter((r) => r.name === path.path &&
                 (!r.kindOf(models_1.ReflectionKind.SomeExport) || !r.flags.isStatic));
             break;
         // Resolve via "members", interface children, class instance properties/accessors/methods,
         // enum members, type literal properties
         case "#":
-            high = refl.children.filter((r) => {
-                return (r.name === path.path &&
-                    r.kindOf(models_1.ReflectionKind.SomeMember) &&
-                    !r.flags.isStatic);
-            });
+            high =
+                refl.children?.filter((r) => {
+                    return (r.name === path.path &&
+                        r.kindOf(models_1.ReflectionKind.SomeMember) &&
+                        !r.flags.isStatic);
+                }) || [];
             break;
         // Resolve via "locals"... treat this as a stricter `.` which only supports traversing
         // module/namespace exports since TypeDoc doesn't support documenting locals.
         case "~":
             if (refl.kindOf(models_1.ReflectionKind.SomeModule | models_1.ReflectionKind.Project)) {
-                high = refl.children.filter((r) => r.name === path.path);
+                high = refl.children?.filter((r) => r.name === path.path) || [];
             }
             break;
     }

package/dist/lib/converter/comments/discovery.d.ts

@@ -1,17 +1,17 @@
 import ts from "typescript";
 import { ReflectionKind } from "../../models";
-import { Logger } from "../../utils";
+import { type Logger } from "../../utils";
 import { CommentStyle } from "../../utils/options/declaration";
 export interface DiscoveredComment {
     file: ts.SourceFile;
     ranges: ts.CommentRange[];
     jsDoc: ts.JSDoc | undefined;
 }
-export declare function discoverFileComment(node: ts.SourceFile, commentStyle: CommentStyle): {
+export declare function discoverFileComments(node: ts.SourceFile, commentStyle: CommentStyle): {
     file: ts.SourceFile;
     ranges: ts.CommentRange[];
     jsDoc: ts.JSDoc | undefined;
-} | undefined;
+}[];
 export declare function discoverNodeComment(node: ts.Node, commentStyle: CommentStyle): DiscoveredComment | undefined;
 export declare function discoverComment(symbol: ts.Symbol, kind: ReflectionKind, logger: Logger, commentStyle: CommentStyle): DiscoveredComment | undefined;
 export declare function discoverSignatureComment(declaration: ts.SignatureDeclaration | ts.JSDocSignature, commentStyle: CommentStyle): DiscoveredComment | undefined;