typedoc 0.25.13 → 0.26.0-beta.1

package/dist/lib/utils/options/declaration.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultValue = exports.convert = exports.ParameterType = exports.ParameterHint = exports.CommentStyle = exports.EmitStrategy = void 0;
+exports.ParameterType = exports.ParameterHint = exports.CommentStyle = exports.EmitStrategy = void 0;
+exports.convert = convert;
+exports.getDefaultValue = getDefaultValue;
 const path_1 = require("path");
 /** @enum */
 exports.EmitStrategy = {
@@ -57,28 +59,28 @@ var ParameterType;
     ParameterType[ParameterType["Flags"] = 11] = "Flags";
 })(ParameterType || (exports.ParameterType = ParameterType = {}));
 const converters = {
-    [ParameterType.String](value, option) {
+    [ParameterType.String](value, option, i18n) {
         const stringValue = value == null ? "" : String(value);
-        option.validate?.(stringValue);
+        option.validate?.(stringValue, i18n);
         return stringValue;
     },
-    [ParameterType.Path](value, option, configPath) {
+    [ParameterType.Path](value, option, i18n, configPath) {
         const stringValue = value == null ? "" : (0, path_1.resolve)(configPath, String(value));
-        option.validate?.(stringValue);
+        option.validate?.(stringValue, i18n);
         return stringValue;
     },
-    [ParameterType.Number](value, option) {
+    [ParameterType.Number](value, option, i18n) {
         const numValue = parseInt(String(value), 10) || 0;
         if (!valueIsWithinBounds(numValue, option.minValue, option.maxValue)) {
-            throw new Error(getBoundsError(option.name, option.minValue, option.maxValue));
+            throw new Error(getBoundsError(option.name, i18n, option.minValue, option.maxValue));
         }
-        option.validate?.(numValue);
+        option.validate?.(numValue, i18n);
         return numValue;
     },
     [ParameterType.Boolean](value) {
         return !!value;
     },
-    [ParameterType.Array](value, option) {
+    [ParameterType.Array](value, option, i18n) {
         let strArrValue = new Array();
         if (Array.isArray(value)) {
             strArrValue = value.map(String);
@@ -86,10 +88,10 @@ const converters = {
         else if (typeof value === "string") {
             strArrValue = [value];
         }
-        option.validate?.(strArrValue);
+        option.validate?.(strArrValue, i18n);
         return strArrValue;
     },
-    [ParameterType.PathArray](value, option, configPath) {
+    [ParameterType.PathArray](value, option, i18n, configPath) {
         let strArrValue = new Array();
         if (Array.isArray(value)) {
             strArrValue = value.map(String);
@@ -98,10 +100,10 @@ const converters = {
             strArrValue = [value];
         }
         strArrValue = strArrValue.map((path) => (0, path_1.resolve)(configPath, path));
-        option.validate?.(strArrValue);
+        option.validate?.(strArrValue, i18n);
         return strArrValue;
     },
-    [ParameterType.ModuleArray](value, option, configPath) {
+    [ParameterType.ModuleArray](value, option, i18n, configPath) {
         let strArrValue = new Array();
         if (Array.isArray(value)) {
             strArrValue = value.map(String);
@@ -110,10 +112,10 @@ const converters = {
             strArrValue = [value];
         }
         strArrValue = resolveModulePaths(strArrValue, configPath);
-        option.validate?.(strArrValue);
+        option.validate?.(strArrValue, i18n);
         return strArrValue;
     },
-    [ParameterType.GlobArray](value, option, configPath) {
+    [ParameterType.GlobArray](value, option, i18n, configPath) {
         let strArrValue = new Array();
         if (Array.isArray(value)) {
             strArrValue = value.map(String);
@@ -122,10 +124,10 @@ const converters = {
             strArrValue = [value];
         }
         strArrValue = resolveGlobPaths(strArrValue, configPath);
-        option.validate?.(strArrValue);
+        option.validate?.(strArrValue, i18n);
         return strArrValue;
     },
-    [ParameterType.Map](value, option) {
+    [ParameterType.Map](value, option, i18n) {
         const key = String(value);
         if (option.map instanceof Map) {
             if (option.map.has(key)) {
@@ -144,29 +146,29 @@ const converters = {
         else if (Object.values(option.map).includes(value)) {
             return value;
         }
-        throw new Error(option.mapError ?? getMapError(option.map, option.name));
+        throw new Error(getMapError(option.map, i18n, option.name));
     },
-    [ParameterType.Mixed](value, option) {
-        option.validate?.(value);
+    [ParameterType.Mixed](value, option, i18n) {
+        option.validate?.(value, i18n);
         return value;
     },
-    [ParameterType.Object](value, option, _configPath, oldValue) {
-        option.validate?.(value);
+    [ParameterType.Object](value, option, i18n, _configPath, oldValue) {
+        option.validate?.(value, i18n);
         if (typeof oldValue !== "undefined")
             value = { ...oldValue, ...value };
         return value;
     },
-    [ParameterType.Flags](value, option) {
+    [ParameterType.Flags](value, option, i18n) {
         if (typeof value === "boolean") {
             value = Object.fromEntries(Object.keys(option.defaults).map((key) => [key, value]));
         }
         if (typeof value !== "object" || value == null) {
-            throw new Error(`Expected an object with flag values for ${option.name} or true/false`);
+            throw new Error(i18n.expected_object_with_flag_values_for_0(option.name));
         }
         const obj = { ...value };
         for (const key of Object.keys(obj)) {
             if (!Object.prototype.hasOwnProperty.call(option.defaults, key)) {
-                throw new Error(`The flag '${key}' is not valid for ${option.name}, expected one of: ${Object.keys(option.defaults).join(", ")}`);
+                throw new Error(i18n.flag_0_is_not_valid_for_1_expected_2(key, option.name, Object.keys(option.defaults).join(", ")));
             }
             if (typeof obj[key] !== "boolean") {
                 // Explicit null/undefined, switch to default.
@@ -174,7 +176,7 @@ const converters = {
                     obj[key] = option.defaults[key];
                 }
                 else {
-                    throw new Error(`Flag values for ${option.name} must be a boolean.`);
+                    throw new Error(i18n.flag_values_for_0_must_be_booleans(option.name));
                 }
             }
         }
@@ -189,11 +191,10 @@ const converters = {
  * @param option The option for which the value should be converted.
  * @returns The result of the conversion. Might be the value or an error.
  */
-function convert(value, option, configPath, oldValue) {
+function convert(value, option, i18n, configPath, oldValue) {
     const _converters = converters;
-    return _converters[option.type ?? ParameterType.String](value, option, configPath, oldValue);
+    return _converters[option.type ?? ParameterType.String](value, option, i18n, configPath, oldValue);
 }
-exports.convert = convert;
 const defaultGetters = {
     [ParameterType.String](option) {
         return option.defaultValue ?? "";
@@ -242,7 +243,6 @@ function getDefaultValue(option) {
     const getters = defaultGetters;
     return getters[option.type ?? ParameterType.String](option);
 }
-exports.getDefaultValue = getDefaultValue;
 function resolveGlobPaths(globs, configPath) {
     return globs.map((path) => {
         const start = path.match(/^[!#]+/)?.[0] ?? "";
@@ -270,7 +270,7 @@ function isTsNumericEnum(map) {
  * @param name The name of the option.
  * @returns The error message.
  */
-function getMapError(map, name) {
+function getMapError(map, i18n, name) {
     let keys = map instanceof Map ? [...map.keys()] : Object.keys(map);
     // If the map is a TS numeric enum we need to filter out the numeric keys.
     // TS numeric enums have the property that every key maps to a value, which maps back to that key.
@@ -278,7 +278,7 @@ function getMapError(map, name) {
         // This works because TS enum keys may not be numeric.
         keys = keys.filter((key) => Number.isNaN(parseInt(key, 10)));
     }
-    return `${name} must be one of ${keys.join(", ")}`;
+    return i18n.option_0_must_be_one_of_1(name, keys.join(", "));
 }
 /**
  * Returns an error message for a value that is out of bounds of the given min and/or max values.
@@ -287,15 +287,15 @@ function getMapError(map, name) {
  * @param maxValue The upper bound of the range of allowed values.
  * @returns The error message.
  */
-function getBoundsError(name, minValue, maxValue) {
+function getBoundsError(name, i18n, minValue, maxValue) {
     if (isFiniteNumber(minValue) && isFiniteNumber(maxValue)) {
-        return `${name} must be between ${minValue} and ${maxValue}`;
+        return i18n.option_0_must_be_between_1_and_2(name, String(minValue), String(maxValue));
     }
     else if (isFiniteNumber(minValue)) {
-        return `${name} must be >= ${minValue}`;
+        return i18n.option_0_must_be_equal_to_or_greater_than_1(name, String(minValue));
     }
     else {
-        return `${name} must be <= ${maxValue}`;
+        return i18n.option_0_must_be_less_than_or_equal_to_1(name, String(maxValue));
     }
 }
 /**

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

@@ -1,7 +1,8 @@
 import type { Options } from "./options";
+import type { TranslationProxy } from "../../internationalization/internationalization";
 export interface ParameterHelp {
     names: string[];
     helps: string[];
     margin: number;
 }
-export declare function getOptionsHelp(options: Options): string;
+export declare function getOptionsHelp(options: Options, i18n: TranslationProxy): string;

package/dist/lib/utils/options/help.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOptionsHelp = void 0;
+exports.getOptionsHelp = getOptionsHelp;
 const declaration_1 = require("./declaration");
 const highlighter_1 = require("../highlighter");
-const shiki_1 = require("shiki");
 function hasHint(parameter) {
     return ((parameter.type ?? declaration_1.ParameterType.String) === declaration_1.ParameterType.String &&
         "hint" in parameter);
@@ -14,7 +13,7 @@ function hasHint(parameter) {
  * @param scope  The scope of the parameters whose help should be returned.
  * @returns The columns and lines for the help of the requested parameters.
  */
-function getParameterHelp(options) {
+function getParameterHelp(options, i18n) {
     const parameters = options.getDeclarations();
     parameters.sort((a, b) => a.name.localeCompare(b.name, undefined, { sensitivity: "base" }));
     const names = [];
@@ -29,14 +28,16 @@ function getParameterHelp(options) {
             name += " " + declaration_1.ParameterHint[parameter.hint].toUpperCase();
         }
         names.push(name);
-        helps.push(parameter.help);
+        helps.push(typeof parameter.help === "string"
+            ? parameter.help
+            : parameter.help(i18n));
         margin = Math.max(name.length, margin);
     }
     return { names, helps, margin };
 }
 function toEvenColumns(values, maxLineWidth) {
     const columnWidth = values.reduce((acc, val) => Math.max(acc, val.length), 0) + 2;
-    const numColumns = Math.max(1, Math.min(maxLineWidth / columnWidth));
+    const numColumns = Math.max(1, Math.floor(maxLineWidth / columnWidth));
     let line = "";
     const out = [];
     for (let i = 0; i < values.length; ++i) {
@@ -51,16 +52,15 @@ function toEvenColumns(values, maxLineWidth) {
     }
     return out;
 }
-function getOptionsHelp(options) {
-    const output = ["Usage:", "  typedoc path/to/entry.ts", "", "Options:"];
-    const columns = getParameterHelp(options);
+function getOptionsHelp(options, i18n) {
+    const output = ["typedoc path/to/entry.ts", "", "Options:"];
+    const columns = getParameterHelp(options, i18n);
     for (let i = 0; i < columns.names.length; i++) {
         const usage = columns.names[i];
         const description = columns.helps[i];
         output.push(usage.padEnd(columns.margin + 2) + description);
     }
     output.push("", "Supported highlighting languages:", ...toEvenColumns((0, highlighter_1.getSupportedLanguages)(), 80));
-    output.push("", "Supported highlighting themes:", ...toEvenColumns(shiki_1.BUNDLED_THEMES, 80));
+    output.push("", "Supported highlighting themes:", ...toEvenColumns((0, highlighter_1.getSupportedThemes)(), 80));
     return output.join("\n");
 }
-exports.getOptionsHelp = getOptionsHelp;

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

@@ -1,4 +1,4 @@
-export { Options, Option, BindOption } from "./options";
+export { Options, Option } from "./options";
 export type { OptionsReader } from "./options";
 export { ArgumentsReader, PackageJsonReader, TypeDocReader, TSConfigReader, } from "./readers";
 export { CommentStyle, EmitStrategy, ParameterType, ParameterHint, } from "./declaration";

package/dist/lib/utils/options/index.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ParameterHint = exports.ParameterType = exports.EmitStrategy = exports.CommentStyle = exports.TSConfigReader = exports.TypeDocReader = exports.PackageJsonReader = exports.ArgumentsReader = exports.BindOption = exports.Option = exports.Options = void 0;
+exports.ParameterHint = exports.ParameterType = exports.EmitStrategy = exports.CommentStyle = exports.TSConfigReader = exports.TypeDocReader = exports.PackageJsonReader = exports.ArgumentsReader = exports.Option = exports.Options = void 0;
 var options_1 = require("./options");
 Object.defineProperty(exports, "Options", { enumerable: true, get: function () { return options_1.Options; } });
 Object.defineProperty(exports, "Option", { enumerable: true, get: function () { return options_1.Option; } });
-Object.defineProperty(exports, "BindOption", { enumerable: true, get: function () { return options_1.BindOption; } });
 var readers_1 = require("./readers");
 Object.defineProperty(exports, "ArgumentsReader", { enumerable: true, get: function () { return readers_1.ArgumentsReader; } });
 Object.defineProperty(exports, "PackageJsonReader", { enumerable: true, get: function () { return readers_1.PackageJsonReader; } });

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

@@ -2,7 +2,8 @@ import type * as ts from "typescript";
 import type { NeverIfInternal } from "..";
 import type { Application } from "../../..";
 import type { Logger } from "../loggers";
-import { DeclarationOption, KeyToDeclaration, TypeDocOptionMap, TypeDocOptions, TypeDocOptionValues } from "./declaration";
+import { type DeclarationOption, type KeyToDeclaration, type TypeDocOptionMap, type TypeDocOptions, type TypeDocOptionValues } from "./declaration";
+import type { TranslationProxy } from "../../internationalization/internationalization";
 /**
  * Describes an option reader that discovers user configuration and converts it to the
  * TypeDoc format.
@@ -68,11 +69,12 @@ export declare class Options {
     private _compilerOptions;
     private _fileNames;
     private _projectReferences;
+    private _i18n;
     /**
      * In packages mode, the directory of the package being converted.
      */
     packageDir?: string;
-    constructor();
+    constructor(i18n: TranslationProxy);
     /**
      * Clones the options, intended for use in packages mode.
      */
@@ -183,7 +185,7 @@ export declare class Options {
     /**
      * Get the help message to be displayed to the user if `--help` is passed.
      */
-    getHelp(): string;
+    getHelp(i18n: TranslationProxy): string;
 }
 /**
  * Binds an option to an accessor. Does not register the option.
@@ -202,34 +204,3 @@ export declare function Option<K extends keyof TypeDocOptionMap>(name: K): (_: u
     }): TypeDocOptionValues[K];
     set(_value: never): never;
 };
-/**
- * Binds an option to the given property. Does not register the option.
- *
- * Note: This is a legacy experimental decorator, and will not work with TS 5.0 decorators
- *
- * @since v0.16.3
- * @deprecated Will be removed in 0.26, use {@link Option | `@Option`} instead.
- */
-export declare function BindOption<K extends keyof TypeDocOptionMap>(name: K): <IK extends PropertyKey>(target: ({
-    application: Application;
-} | {
-    options: Options;
-}) & {
-    [K2 in IK]: TypeDocOptionValues[K];
-}, key: IK) => void;
-/**
- * Binds an option to the given property. Does not register the option.
- *
- * Note: This is a legacy experimental decorator, and will not work with TS 5.0 decorators
- *
- * @since v0.16.3
- * @deprecated Will be removed in 0.26, use {@link Option | `@Option`} instead
- *
- * @privateRemarks
- * This overload is intended for plugin use only with looser type checks. Do not use internally.
- */
-export declare function BindOption(name: NeverIfInternal<string>): (target: {
-    application: Application;
-} | {
-    options: Options;
-}, key: PropertyKey) => void;

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BindOption = exports.Option = exports.Options = void 0;
+exports.Options = void 0;
+exports.Option = Option;
 const declaration_1 = require("./declaration");
 const array_1 = require("../array");
 const declaration_2 = require("./declaration");
@@ -28,7 +29,7 @@ const optionSnapshots = new WeakMap();
  *    files.
  */
 class Options {
-    constructor() {
+    constructor(i18n) {
         this._readers = [];
         this._declarations = new Map();
         this._values = {};
@@ -36,17 +37,21 @@ class Options {
         this._compilerOptions = {};
         this._fileNames = [];
         this._projectReferences = [];
+        this._i18n = i18n;
         (0, sources_1.addTypeDocOptions)(this);
     }
     /**
      * Clones the options, intended for use in packages mode.
      */
     copyForPackage(packageDir) {
-        const options = new Options();
+        const options = new Options(this._i18n);
         options.packageDir = packageDir;
         options._readers = this._readers.filter((reader) => reader.supportsPackages);
         options._declarations = new Map(this._declarations);
         options.reset();
+        for (const [key, val] of Object.entries(this.getValue("packageOptions"))) {
+            options.setValue(key, val, packageDir);
+        }
         return options;
     }
     /**
@@ -152,7 +157,7 @@ class Options {
         const declaration = this.getDeclaration(name);
         if (!declaration) {
             const nearNames = this.getSimilarOptions(name);
-            throw new Error(`Unknown option '${name}', you may have meant:\n\t${nearNames.join("\n\t")}`);
+            throw new Error(this._i18n.unknown_option_0_you_may_have_meant_1(name, nearNames.join("\n\t")));
         }
         return this._values[declaration.name];
     }
@@ -163,12 +168,12 @@ class Options {
         const declaration = this.getDeclaration(name);
         if (!declaration) {
             const nearNames = this.getSimilarOptions(name);
-            throw new Error(`Tried to set an option (${name}) that was not declared. You may have meant:\n\t${nearNames.join("\n\t")}`);
+            throw new Error(this._i18n.unknown_option_0_you_may_have_meant_1(name, nearNames.join("\n\t")));
         }
         let oldValue = this._values[declaration.name];
         if (typeof oldValue === "undefined")
             oldValue = (0, declaration_2.getDefaultValue)(declaration);
-        const converted = (0, declaration_2.convert)(value, declaration, configPath ?? process.cwd(), oldValue);
+        const converted = (0, declaration_2.convert)(value, declaration, this._i18n, configPath ?? process.cwd(), oldValue);
         if (declaration.type === declaration_1.ParameterType.Flags) {
             Object.assign(this._values[declaration.name], converted);
         }
@@ -246,8 +251,8 @@ class Options {
     /**
      * Get the help message to be displayed to the user if `--help` is passed.
      */
-    getHelp() {
-        return (0, help_1.getOptionsHelp)(this);
+    getHelp(i18n) {
+        return (0, help_1.getOptionsHelp)(this, i18n);
     }
 }
 exports.Options = Options;
@@ -270,21 +275,6 @@ function Option(name) {
         };
     };
 }
-exports.Option = Option;
-function BindOption(name) {
-    return function (target, key) {
-        Object.defineProperty(target, key, {
-            get() {
-                const options = "options" in this ? this.options : this.application.options;
-                const value = options.getValue(name);
-                return value;
-            },
-            enumerable: true,
-            configurable: true,
-        });
-    };
-}
-exports.BindOption = BindOption;
 // Based on https://en.wikipedia.org/wiki/Levenshtein_distance#Iterative_with_two_matrix_rows
 // Slightly modified for improved match results for options
 function editDistance(s, t) {

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

@@ -40,7 +40,7 @@ class ArgumentsReader {
                 : options.getDeclaration("entryPoints");
             if (decl) {
                 if (decl.configFileOnly) {
-                    logger.error(`The '${decl.name}' option can only be specified via a config file.`);
+                    logger.error(logger.i18n.option_0_can_only_be_specified_by_config_file(decl.name));
                     continue;
                 }
                 if (seen.has(decl.name) && ARRAY_OPTION_TYPES.has(decl.type)) {
@@ -61,7 +61,7 @@ class ArgumentsReader {
                 else {
                     if (index === this.args.length) {
                         // Only boolean values have optional values.
-                        logger.warn(`--${decl.name} expected a value, but none was given as an argument`);
+                        logger.warn(logger.i18n.option_0_expected_a_value_but_none_provided(decl.name));
                     }
                     trySet(decl.name, this.args[index]);
                 }
@@ -87,9 +87,7 @@ class ArgumentsReader {
                     continue;
                 }
             }
-            logger.error(`Unknown option: ${name}, you may have meant:\n\t${options
-                .getSimilarOptions(name)
-                .join("\n\t")}`);
+            logger.error(logger.i18n.unknown_option_0_may_have_meant_1(name, options.getSimilarOptions(name).join("\n\t")));
             index++;
         }
     }

package/dist/lib/utils/options/readers/package-json.js

@@ -20,7 +20,7 @@ class PackageJsonReader {
         }
         const { file, content } = result;
         if ("typedoc" in content) {
-            logger.warn(`The 'typedoc' key in ${(0, paths_1.nicePath)(file)} was used by the legacy-packages entryPointStrategy and will be ignored.`);
+            logger.warn(logger.i18n.typedoc_key_in_0_ignored((0, paths_1.nicePath)(file)));
         }
         const optsKey = "typedocOptions";
         if (!(optsKey in content)) {
@@ -28,7 +28,7 @@ class PackageJsonReader {
         }
         const opts = content[optsKey];
         if (opts === null || typeof opts !== "object") {
-            logger.error(`Failed to parse the "typedocOptions" field in ${(0, paths_1.nicePath)(file)}, ensure it exists and contains an object.`);
+            logger.error(logger.i18n.typedoc_options_must_be_object_in_0((0, paths_1.nicePath)(file)));
             return;
         }
         for (const [opt, val] of Object.entries(opts)) {

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

@@ -56,7 +56,7 @@ class TSConfigReader {
         if (!fileToRead) {
             // If the user didn't give us this option, we shouldn't complain about not being able to find it.
             if (container.isSet("tsconfig")) {
-                logger.error(`The tsconfig file ${(0, paths_1.nicePath)(file)} does not exist`);
+                logger.error(logger.i18n.tsconfig_file_0_does_not_exist((0, paths_1.nicePath)(file)));
             }
             return;
         }
@@ -73,14 +73,11 @@ class TSConfigReader {
         }
         const typedocOptions = (0, tsconfig_1.getTypeDocOptionsFromTsConfig)(fileToRead);
         if (typedocOptions.options) {
-            logger.error([
-                "typedocOptions in tsconfig file specifies an option file to read but the option",
-                "file has already been read. This is likely a misconfiguration.",
-            ].join(" "));
+            logger.error(logger.i18n.tsconfig_file_specifies_options_file());
             delete typedocOptions.options;
         }
         if (typedocOptions.tsconfig) {
-            logger.error("typedocOptions in tsconfig file may not specify a tsconfig file to read");
+            logger.error(logger.i18n.tsconfig_file_specifies_tsconfig_file());
             delete typedocOptions.tsconfig;
         }
         container.setCompilerOptions(parsed.fileNames, parsed.options, parsed.projectReferences);
@@ -103,8 +100,7 @@ class TSConfigReader {
         }
         const overwritten = ["blockTags", "inlineTags", "modifierTags"].filter((opt) => container.isSet(opt));
         if (overwritten.length) {
-            logger.warn(`The ${overwritten.join(", ")} defined in typedoc.json will ` +
-                "be overwritten by configuration in tsdoc.json.");
+            logger.warn(logger.i18n.tags_0_defined_in_typedoc_json_overwritten_by_tsdoc_json(overwritten.join(", ")));
         }
         const config = this.readTsDoc(logger, tsdoc);
         if (!config)
@@ -136,17 +132,17 @@ class TSConfigReader {
     }
     readTsDoc(logger, path) {
         if (this.seenTsdocPaths.has(path)) {
-            logger.error(`Circular reference encountered for "extends" field of ${(0, paths_1.nicePath)(path)}`);
+            logger.error(logger.i18n.circular_reference_extends_0((0, paths_1.nicePath)(path)));
             return;
         }
         this.seenTsdocPaths.add(path);
         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)}.`);
+            logger.error(logger.i18n.failed_read_tsdoc_json_0((0, paths_1.nicePath)(path)));
             return;
         }
         if (!(0, validation_1.validate)(tsDocSchema, config)) {
-            logger.error(`The file ${(0, paths_1.nicePath)(path)} is not a valid tsdoc.json file.`);
+            logger.error(logger.i18n.invalid_tsdoc_json_0((0, paths_1.nicePath)(path)));
             return;
         }
         const workingConfig = {};
@@ -158,7 +154,7 @@ class TSConfigReader {
                     resolvedPath = resolver.resolve(extendedPath);
                 }
                 catch {
-                    logger.error(`Failed to resolve ${extendedPath} to a file in ${(0, paths_1.nicePath)(path)}`);
+                    logger.error(logger.i18n.failed_resolve_0_to_file_in_1(extendedPath, (0, paths_1.nicePath)(path)));
                     return;
                 }
                 const parentConfig = this.readTsDoc(logger, resolvedPath);

package/dist/lib/utils/options/readers/typedoc.d.ts

@@ -30,7 +30,7 @@ export declare class TypeDocReader implements OptionsReader {
      *
      * @param  path Path to the typedoc.(js|json) file. If path is a directory
      *   typedoc file will be attempted to be found at the root of this path
-     * @return the typedoc.(js|json) file path or undefined
+     * @returns the typedoc.(js|json) file path or undefined
      */
     private findTypedocFile;
 }

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

@@ -58,7 +58,7 @@ class TypeDocReader {
         const file = this.findTypedocFile(path);
         if (!file) {
             if (container.isSet("options")) {
-                logger.error(`The options file ${(0, paths_1.nicePath)(path)} does not exist.`);
+                logger.error(logger.i18n.options_file_0_does_not_exist((0, paths_1.nicePath)(path)));
             }
             return;
         }
@@ -73,7 +73,7 @@ class TypeDocReader {
      */
     async readFile(file, container, logger, seen) {
         if (seen.has(file)) {
-            logger.error(`Tried to load the options file ${(0, paths_1.nicePath)(file)} multiple times.`);
+            logger.error(logger.i18n.circular_reference_extends_0((0, paths_1.nicePath)(file)));
             return;
         }
         seen.add(file);
@@ -81,7 +81,7 @@ class TypeDocReader {
         if (file.endsWith(".json")) {
             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.`);
+                logger.error(logger.i18n.failed_read_options_file_0((0, paths_1.nicePath)(file)));
                 return;
             }
             else {
@@ -107,12 +107,13 @@ class TypeDocReader {
                 }
             }
             catch (error) {
-                logger.error(`Failed to read ${(0, paths_1.nicePath)(file)}: ${error instanceof Error ? error.message : error}`);
+                logger.error(logger.i18n.failed_read_options_file_0((0, paths_1.nicePath)(file)));
+                logger.error(String(error instanceof Error ? error.message : error));
                 return;
             }
         }
         if (typeof fileContent !== "object" || !fileContent) {
-            logger.error(`The root value of ${(0, paths_1.nicePath)(file)} is not an object.`);
+            logger.error(logger.i18n.failed_read_options_file_0((0, paths_1.nicePath)(file)));
             return;
         }
         // clone option object to avoid of property changes in re-calling this file
@@ -127,7 +128,7 @@ class TypeDocReader {
                     resolvedParent = resolver.resolve(extendedFile);
                 }
                 catch {
-                    logger.error(`Failed to resolve ${extendedFile} to a file in ${(0, paths_1.nicePath)(file)}`);
+                    logger.error(logger.i18n.failed_resolve_0_to_file_in_1(extendedFile, (0, paths_1.nicePath)(file)));
                     continue;
                 }
                 await this.readFile(resolvedParent, container, logger, seen);
@@ -149,7 +150,7 @@ class TypeDocReader {
      *
      * @param  path Path to the typedoc.(js|json) file. If path is a directory
      *   typedoc file will be attempted to be found at the root of this path
-     * @return the typedoc.(js|json) file path or undefined
+     * @returns the typedoc.(js|json) file path or undefined
      */
     findTypedocFile(path) {
         path = (0, path_1.resolve)(path);