typedoc 0.27.9 → 0.28.0-beta.1

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

@@ -1,38 +1,38 @@
-import { resolve, join, dirname } from "path";
+import { dirname, join, resolve } from "path";
 import ts from "typescript";
 import { isFile } from "../../fs.js";
 import { ok } from "assert";
-import { additionalProperties, isTagString, optional, validate, } from "../../validation.js";
+import { i18n, unique, Validation } from "#utils";
 import { nicePath, normalizePath } from "../../paths.js";
 import { createRequire } from "module";
-import { tsdocBlockTags, tsdocInlineTags, tsdocModifierTags, } from "../tsdoc-defaults.js";
-import { unique } from "../../array.js";
-import { findTsConfigFile, getTypeDocOptionsFromTsConfig, readTsConfig, } from "../../tsconfig.js";
+import { tsdocBlockTags, tsdocInlineTags, tsdocModifierTags } from "../tsdoc-defaults.js";
+import { findTsConfigFile, getTypeDocOptionsFromTsConfig, readTsConfig } from "../../tsconfig.js";
+import { diagnostics } from "../../loggers.js";
 function isSupportForTags(obj) {
-    return (validate({}, obj) &&
+    return (Validation.validate({}, obj) &&
         Object.entries(obj).every(([key, val]) => {
             return (/^@[a-zA-Z][a-zA-Z0-9]*$/.test(key) && typeof val === "boolean");
         }));
 }
 const tsDocSchema = {
-    $schema: optional(String),
-    extends: optional([Array, String]),
-    noStandardTags: optional(Boolean),
-    tagDefinitions: optional([
+    $schema: Validation.optional(String),
+    extends: Validation.optional([Array, String]),
+    noStandardTags: Validation.optional(Boolean),
+    tagDefinitions: Validation.optional([
         Array,
         {
-            tagName: isTagString,
+            tagName: Validation.isTagString,
             syntaxKind: ["inline", "block", "modifier"],
-            allowMultiple: optional(Boolean),
-            [additionalProperties]: false,
+            allowMultiple: Validation.optional(Boolean),
+            [Validation.additionalProperties]: false,
         },
     ]),
-    supportForTags: optional(isSupportForTags),
+    supportForTags: Validation.optional(isSupportForTags),
     // The official parser has code to support for these two, but
     // the schema doesn't allow them... just silently ignore them for now.
-    supportedHtmlElements: optional({}),
-    reportUnsupportedHtmlElements: optional(Boolean),
-    [additionalProperties]: false,
+    supportedHtmlElements: Validation.optional({}),
+    reportUnsupportedHtmlElements: Validation.optional(Boolean),
+    [Validation.additionalProperties]: false,
 };
 export class TSConfigReader {
     /**
@@ -48,7 +48,7 @@ export 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(logger.i18n.tsconfig_file_0_does_not_exist(nicePath(file)));
+                logger.error(i18n.tsconfig_file_0_does_not_exist(nicePath(file)));
             }
             return;
         }
@@ -59,17 +59,17 @@ export class TSConfigReader {
         if (!parsed) {
             return;
         }
-        logger.diagnostics(parsed.errors);
+        diagnostics(logger, parsed.errors);
         if (parsed.errors.length) {
             return;
         }
         const typedocOptions = getTypeDocOptionsFromTsConfig(fileToRead);
         if (typedocOptions.options) {
-            logger.error(logger.i18n.tsconfig_file_specifies_options_file());
+            logger.error(i18n.tsconfig_file_specifies_options_file());
             delete typedocOptions.options;
         }
         if (typedocOptions.tsconfig) {
-            logger.error(logger.i18n.tsconfig_file_specifies_tsconfig_file());
+            logger.error(i18n.tsconfig_file_specifies_tsconfig_file());
             delete typedocOptions.tsconfig;
         }
         container.setCompilerOptions(parsed.fileNames, parsed.options, parsed.projectReferences);
@@ -92,7 +92,7 @@ export class TSConfigReader {
         }
         const overwritten = ["blockTags", "inlineTags", "modifierTags"].filter((opt) => container.isSet(opt));
         if (overwritten.length) {
-            logger.warn(logger.i18n.tags_0_defined_in_typedoc_json_overwritten_by_tsdoc_json(overwritten.join(", ")));
+            logger.warn(i18n.tags_0_defined_in_typedoc_json_overwritten_by_tsdoc_json(overwritten.join(", ")));
         }
         const config = this.readTsDoc(logger, tsdoc);
         if (!config)
@@ -124,17 +124,17 @@ export class TSConfigReader {
     }
     readTsDoc(logger, path) {
         if (this.seenTsdocPaths.has(path)) {
-            logger.error(logger.i18n.circular_reference_extends_0(nicePath(path)));
+            logger.error(i18n.circular_reference_extends_0(nicePath(path)));
             return;
         }
         this.seenTsdocPaths.add(path);
         const { config, error } = ts.readConfigFile(normalizePath(path), ts.sys.readFile);
         if (error) {
-            logger.error(logger.i18n.failed_read_tsdoc_json_0(nicePath(path)));
+            logger.error(i18n.failed_read_tsdoc_json_0(nicePath(path)));
             return;
         }
-        if (!validate(tsDocSchema, config)) {
-            logger.error(logger.i18n.invalid_tsdoc_json_0(nicePath(path)));
+        if (!Validation.validate(tsDocSchema, config)) {
+            logger.error(i18n.invalid_tsdoc_json_0(nicePath(path)));
             return;
         }
         const workingConfig = {};
@@ -146,7 +146,7 @@ export class TSConfigReader {
                     resolvedPath = resolver.resolve(extendedPath);
                 }
                 catch {
-                    logger.error(logger.i18n.failed_resolve_0_to_file_in_1(extendedPath, nicePath(path)));
+                    logger.error(i18n.failed_resolve_0_to_file_in_1(extendedPath, nicePath(path)));
                     return;
                 }
                 const parentConfig = this.readTsDoc(logger, resolvedPath);

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

@@ -1,6 +1,6 @@
 import type { OptionsReader } from "../options.js";
-import type { Logger } from "../../loggers.js";
 import type { Options } from "../options.js";
+import { type Logger } from "#utils";
 /**
  * Obtains option values from typedoc.json
  */

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

@@ -1,4 +1,4 @@
-import { join, dirname, resolve } from "path";
+import { dirname, join, resolve } from "path";
 import * as FS from "fs";
 import ts from "typescript";
 import { ok } from "assert";
@@ -6,11 +6,10 @@ import { nicePath, normalizePath } from "../../paths.js";
 import { isFile } from "../../fs.js";
 import { createRequire } from "module";
 import { pathToFileURL } from "url";
+import { i18n } from "#utils";
 /**
  * Obtains option values from typedoc.json
  */
-// Changes need to happen here at some point. I think we should follow ESLint's new config
-// system eventually: https://eslint.org/blog/2022/08/new-config-system-part-1/
 export class TypeDocReader {
     /**
      * Should run before the tsconfig reader so that it can specify a tsconfig file to read.
@@ -26,7 +25,7 @@ export class TypeDocReader {
         const file = this.findTypedocFile(path, usedFile);
         if (!file) {
             if (container.isSet("options")) {
-                logger.error(logger.i18n.options_file_0_does_not_exist(nicePath(path)));
+                logger.error(i18n.options_file_0_does_not_exist(nicePath(path)));
             }
             return;
         }
@@ -41,7 +40,7 @@ export class TypeDocReader {
      */
     async readFile(file, container, logger, seen) {
         if (seen.has(file)) {
-            logger.error(logger.i18n.circular_reference_extends_0(nicePath(file)));
+            logger.error(i18n.circular_reference_extends_0(nicePath(file)));
             return;
         }
         seen.add(file);
@@ -49,7 +48,7 @@ export class TypeDocReader {
         if (file.endsWith(".json") || file.endsWith(".jsonc")) {
             const readResult = ts.readConfigFile(normalizePath(file), (path) => FS.readFileSync(path, "utf-8"));
             if (readResult.error) {
-                logger.error(logger.i18n.failed_read_options_file_0(nicePath(file)));
+                logger.error(i18n.failed_read_options_file_0(nicePath(file)));
                 return;
             }
             else {
@@ -64,13 +63,13 @@ export class TypeDocReader {
                 fileContent = await (await import(esmPath)).default;
             }
             catch (error) {
-                logger.error(logger.i18n.failed_read_options_file_0(nicePath(file)));
+                logger.error(i18n.failed_read_options_file_0(nicePath(file)));
                 logger.error(String(error instanceof Error ? error.message : error));
                 return;
             }
         }
         if (typeof fileContent !== "object" || !fileContent) {
-            logger.error(logger.i18n.failed_read_options_file_0(nicePath(file)));
+            logger.error(i18n.failed_read_options_file_0(nicePath(file)));
             return;
         }
         // clone option object to avoid of property changes in re-calling this file
@@ -85,7 +84,7 @@ export class TypeDocReader {
                     resolvedParent = resolver.resolve(extendedFile);
                 }
                 catch {
-                    logger.error(logger.i18n.failed_resolve_0_to_file_in_1(extendedFile, nicePath(file)));
+                    logger.error(i18n.failed_resolve_0_to_file_in_1(extendedFile, nicePath(file)));
                     continue;
                 }
                 await this.readFile(resolvedParent, container, logger, seen);