typedoc 0.24.0-beta.3 → 0.24.0-beta.5

package/dist/lib/serialization/schema.d.ts

@@ -166,22 +166,23 @@ export interface Comment extends Partial<S<M.Comment, "blockTags" | "label">> {
 export interface CommentTag extends S<M.CommentTag, "tag" | "name"> {
     content: CommentDisplayPart[];
 }
-/**
- * If `target` is a number, it is a reflection ID. If a string, it is a URL.
- * `target` will only be set for `@link`, `@linkcode`, and `@linkplain` tags.
- */
 export type CommentDisplayPart = {
     kind: "text";
     text: string;
 } | {
     kind: "code";
     text: string;
-} | {
+} | InlineTagDisplayPart;
+/**
+ * If `target` is a number, it is a reflection ID. If a string, it is a URL.
+ * `target` will only be set for `@link`, `@linkcode`, and `@linkplain` tags.
+ */
+export interface InlineTagDisplayPart {
     kind: "inline-tag";
     tag: `@${string}`;
     text: string;
-    target?: string | number;
-};
+    target?: string | number | ReflectionSymbolId;
+}
 export interface SourceReference extends S<M.SourceReference, "fileName" | "line" | "character" | "url"> {
 }
 export {};

package/dist/lib/serialization/serializer.js

@@ -41,7 +41,6 @@ class Serializer extends utils_1.EventDispatcher {
         return project;
     }
 }
-exports.Serializer = Serializer;
 /**
  * Triggered when the {@link Serializer} begins transforming a project.
  * @event EVENT_BEGIN
@@ -52,3 +51,4 @@ Serializer.EVENT_BEGIN = "begin";
  * @event EVENT_END
  */
 Serializer.EVENT_END = "end";
+exports.Serializer = Serializer;

package/dist/lib/utils/component.js

@@ -49,9 +49,9 @@ class ComponentEvent extends events_1.Event {
         this.component = component;
     }
 }
-exports.ComponentEvent = ComponentEvent;
 ComponentEvent.ADDED = "componentAdded";
 ComponentEvent.REMOVED = "componentRemoved";
+exports.ComponentEvent = ComponentEvent;
 /**
  * Component base class.  Has an owner (unless it's the application root component),
  * can dispatch events to its children, and has access to the root Application component.

package/dist/lib/utils/entry-point.js

@@ -311,9 +311,9 @@ function getEntryPointsForLegacyPackages(logger, packageGlobPaths, options) {
             logger.error(`Entry point "${packageEntryPoint}" does not appear to be built by/included in the tsconfig found at "${tsconfigFile}"`);
             return;
         }
+        const packageName = packageJson["name"];
         results.push({
-            displayName: typedocPackageConfig?.displayName ??
-                packageJson["name"],
+            displayName: typedocPackageConfig?.displayName ?? packageName,
             version: includeVersion
                 ? packageJson["version"]
                 : void 0,

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

@@ -93,12 +93,14 @@ export interface TypeDocOptionMap {
     githubPages: boolean;
     gaID: string;
     hideGenerator: boolean;
+    cacheBust: boolean;
     searchInComments: boolean;
     cleanOutputDir: boolean;
     titleLink: string;
     navigationLinks: ManuallyValidatedOption<Record<string, string>>;
     sidebarLinks: ManuallyValidatedOption<Record<string, string>>;
     commentStyle: typeof CommentStyle;
+    useTsLinkResolution: boolean;
     blockTags: `@${string}`[];
     inlineTags: `@${string}`[];
     modifierTags: `@${string}`[];
@@ -125,6 +127,7 @@ export interface TypeDocOptionMap {
     plugin: string[];
     logLevel: typeof LogLevel;
     treatWarningsAsErrors: boolean;
+    treatValidationWarningsAsErrors: boolean;
     intentionallyNotExported: string[];
     validation: ValidationOptions;
     requiredToBeDocumented: ReflectionKind.KindString[];

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

@@ -291,7 +291,13 @@ function addTypeDocOptions(options) {
         name: "excludeTags",
         help: "Remove the listed block/modifier tags from doc comments.",
         type: declaration_1.ParameterType.Array,
-        defaultValue: ["@override", "@virtual", "@privateRemarks"],
+        defaultValue: [
+            "@override",
+            "@virtual",
+            "@privateRemarks",
+            "@satisfies",
+            "@overload",
+        ],
         validate(value) {
             if (!Validation.validate([Array, Validation.isTagString], value)) {
                 throw new Error(`excludeTags must be an array of valid tag names.`);
@@ -341,6 +347,11 @@ function addTypeDocOptions(options) {
         help: "Do not print the TypeDoc link at the end of the page.",
         type: declaration_1.ParameterType.Boolean,
     });
+    options.addDeclaration({
+        name: "cacheBust",
+        help: "Include the generation time in links to static assets.",
+        type: declaration_1.ParameterType.Boolean,
+    });
     options.addDeclaration({
         name: "searchInComments",
         help: "If set, the search index will also include comments. This will greatly increase the size of the search index.",
@@ -395,6 +406,12 @@ function addTypeDocOptions(options) {
         map: declaration_1.CommentStyle,
         defaultValue: declaration_1.CommentStyle.JSDoc,
     });
+    options.addDeclaration({
+        name: "useTsLinkResolution",
+        help: "Use TypeScript's link resolution when determining where @link tags point. This only applies to JSDoc style comments.",
+        type: declaration_1.ParameterType.Boolean,
+        defaultValue: true,
+    });
     options.addDeclaration({
         name: "blockTags",
         help: "Block tags which TypeDoc should recognize when parsing comments.",
@@ -582,7 +599,12 @@ function addTypeDocOptions(options) {
     });
     options.addDeclaration({
         name: "treatWarningsAsErrors",
-        help: "If set, warnings will be treated as errors.",
+        help: "If set, all warnings will be treated as errors.",
+        type: declaration_1.ParameterType.Boolean,
+    });
+    options.addDeclaration({
+        name: "treatValidationWarningsAsErrors",
+        help: "If set, warnings emitted during validation will be treated as errors. This option cannot be used to disable treatWarningsAsErrors for validation warnings.",
         type: declaration_1.ParameterType.Boolean,
     });
     options.addDeclaration({

package/dist/lib/utils/options/tsdoc-defaults.d.ts

@@ -1,6 +1,6 @@
 export declare const tsdocBlockTags: readonly ["@deprecated", "@param", "@remarks", "@returns", "@throws", "@privateRemarks", "@defaultValue", "@typeParam"];
-export declare const blockTags: readonly ["@deprecated", "@param", "@remarks", "@returns", "@throws", "@privateRemarks", "@defaultValue", "@typeParam", "@module", "@inheritDoc", "@group", "@category", "@template", "@type", "@typedef", "@callback", "@prop", "@property"];
+export declare const blockTags: readonly ["@deprecated", "@param", "@remarks", "@returns", "@throws", "@privateRemarks", "@defaultValue", "@typeParam", "@module", "@inheritDoc", "@group", "@category", "@template", "@type", "@typedef", "@callback", "@prop", "@property", "@satisfies"];
 export declare const tsdocInlineTags: readonly ["@link", "@inheritDoc", "@label"];
 export declare const inlineTags: string[];
 export declare const tsdocModifierTags: readonly ["@public", "@private", "@protected", "@internal", "@readonly", "@packageDocumentation", "@eventProperty", "@alpha", "@beta", "@experimental", "@sealed", "@override", "@virtual"];
-export declare const modifierTags: readonly ["@public", "@private", "@protected", "@internal", "@readonly", "@packageDocumentation", "@eventProperty", "@alpha", "@beta", "@experimental", "@sealed", "@override", "@virtual", "@hidden", "@ignore", "@enum", "@event"];
+export declare const modifierTags: readonly ["@public", "@private", "@protected", "@internal", "@readonly", "@packageDocumentation", "@eventProperty", "@alpha", "@beta", "@experimental", "@sealed", "@override", "@virtual", "@hidden", "@ignore", "@enum", "@event", "@overload", "@namespace", "@interface"];

package/dist/lib/utils/options/tsdoc-defaults.js

@@ -26,6 +26,7 @@ exports.blockTags = [
     "@callback",
     "@prop",
     "@property",
+    "@satisfies",
 ];
 exports.tsdocInlineTags = ["@link", "@inheritDoc", "@label"];
 exports.inlineTags = [...exports.tsdocInlineTags, "@linkcode", "@linkplain"];
@@ -50,4 +51,7 @@ exports.modifierTags = [
     "@ignore",
     "@enum",
     "@event",
+    "@overload",
+    "@namespace",
+    "@interface",
 ];

package/dist/lib/utils/package-manifest.js

@@ -44,13 +44,13 @@ function extractTypedocConfigFromPackageManifest(logger, packageJsonPath) {
         return undefined;
     }
     if (hasOwnProperty(packageJson, "typedoc") &&
-        typeof packageJson.typedoc == "object" &&
-        packageJson.typedoc) {
-        if (!(0, validation_1.validate)(typedocPackageManifestConfigSchema, packageJson.typedoc)) {
+        typeof packageJson["typedoc"] == "object" &&
+        packageJson["typedoc"]) {
+        if (!(0, validation_1.validate)(typedocPackageManifestConfigSchema, packageJson["typedoc"])) {
             logger.error(`Typedoc config extracted from package manifest file ${packageJsonPath} is not valid`);
             return undefined;
         }
-        return packageJson.typedoc;
+        return packageJson["typedoc"];
     }
     return undefined;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.24.0-beta.3",
+  "version": "0.24.0-beta.5",
   "homepage": "https://typedoc.org",
   "exports": {
     ".": "./dist/index.js",
@@ -30,24 +30,24 @@
     "shiki": "^0.14.1"
   },
   "peerDependencies": {
-    "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x"
+    "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x"
   },
   "devDependencies": {
     "@types/lunr": "^2.3.4",
     "@types/marked": "^4.0.8",
     "@types/mocha": "^10.0.1",
     "@types/node": "14",
-    "@typescript-eslint/eslint-plugin": "^5.51.0",
-    "@typescript-eslint/parser": "^5.51.0",
+    "@typescript-eslint/eslint-plugin": "^5.55.0",
+    "@typescript-eslint/parser": "^5.55.0",
     "@typestrong/fs-fixture-builder": "github:TypeStrong/fs-fixture-builder#8abd1494280116ff5318dde2c50ad01e1663790c",
-    "c8": "^7.12.0",
-    "esbuild": "^0.17.7",
-    "eslint": "^8.34.0",
+    "c8": "^7.13.0",
+    "esbuild": "^0.17.12",
+    "eslint": "^8.36.0",
     "mocha": "^10.2.0",
     "prettier": "2.8.4",
     "puppeteer": "^13.5.2",
     "ts-node": "^10.9.1",
-    "typescript": "4.9.5"
+    "typescript": "5.0.2"
   },
   "files": [
     "/bin",

package/static/style.css

@@ -483,10 +483,9 @@ blockquote {
     .has-menu .col-menu {
         visibility: visible;
         transform: translate(0, 0);
-        display: grid;
-        align-items: center;
-        grid-template-rows: auto 1fr;
-        grid-gap: 1.5rem;
+        display: flex;
+        flex-direction: column;
+        gap: 1.5rem;
         max-height: 100vh;
         padding: 1rem 2rem;
     }
@@ -911,7 +910,7 @@ a.tsd-index-link {
     margin-right: 0.8rem;
 }
 
-@media (min-width: 1024px) {
+@media (min-width: 1025px) {
     .col-content {
         margin: 2rem auto;
     }

package/tsdoc.json

@@ -66,6 +66,30 @@
             "tagName": "@linkplain",
             "syntaxKind": "block",
             "allowMultiple": true
+        },
+        {
+            "tagName": "@private",
+            "syntaxKind": "modifier"
+        },
+        {
+            "tagName": "@protected",
+            "syntaxKind": "modifier"
+        },
+        {
+            "tagName": "@satisfies",
+            "syntaxKind": "block"
+        },
+        {
+            "tagName": "@overload",
+            "syntaxKind": "modifier"
+        },
+        {
+            "tagName": "@namespace",
+            "syntaxKind": "modifier"
+        },
+        {
+            "tagName": "@interface",
+            "syntaxKind": "modifier"
         }
     ]
 }