typedoc 0.27.1 → 0.27.2

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

@@ -1,3 +1,3 @@
-import type * as ts from "typescript";
+import type ts from "typescript";
 import { type Token } from "./lexer.js";
 export declare function lexLineComments(file: string, ranges: ts.CommentRange[]): Generator<Token, undefined, undefined>;

package/dist/lib/models/reflections/declaration.d.ts

@@ -1,4 +1,4 @@
-import type * as ts from "typescript";
+import type ts from "typescript";
 import { type ReferenceType, type SomeType } from "../types.js";
 import { type TraverseCallback } from "./abstract.js";
 import { ContainerReflection } from "./container.js";

package/dist/lib/models/reflections/project.d.ts

@@ -1,4 +1,4 @@
-import type * as ts from "typescript";
+import type ts from "typescript";
 import { type Reflection } from "./abstract.js";
 import { ContainerReflection } from "./container.js";
 import type { DeclarationReflection } from "./declaration.js";

package/dist/lib/models/types.d.ts

@@ -1,4 +1,4 @@
-import * as ts from "typescript";
+import ts from "typescript";
 import type { Context } from "../converter/index.js";
 import type { Reflection } from "./reflections/abstract.js";
 import type { DeclarationReflection } from "./reflections/declaration.js";

package/dist/lib/models/types.js

@@ -1,4 +1,4 @@
-import * as ts from "typescript";
+import ts from "typescript";
 import { getQualifiedName } from "../utils/tsutils.js";
 import { ReflectionSymbolId } from "./reflections/ReflectionSymbolId.js";
 import { findPackageForPath } from "../utils/fs.js";

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

@@ -1,24 +1,18 @@
+/**
+ * Defaults values for TypeDoc options
+ * @module
+ */
 import type { BundledLanguage } from "@gerrit0/mini-shiki";
 import type { EnumKeys } from "../enum.js";
 import type { ReflectionKind } from "../../models/index.js";
-/**
- * Default values for TypeDoc options. This object should not be modified.
- *
- * @privateRemarks
- * These are declared here, rather than within the option declaration, so that
- * they can be exposed as a part of the public API. The unfortunate type declaration
- * is to control the type which appears in the generated documentation.
- */
-export declare const OptionDefaults: {
-    excludeNotDocumentedKinds: readonly EnumKeys<typeof ReflectionKind>[];
-    excludeTags: readonly `@${string}`[];
-    blockTags: readonly `@${string}`[];
-    inlineTags: readonly `@${string}`[];
-    modifierTags: readonly `@${string}`[];
-    cascadedModifierTags: readonly `@${string}`[];
-    notRenderedTags: readonly `@${string}`[];
-    highlightLanguages: readonly BundledLanguage[];
-    sort: readonly string[];
-    kindSortOrder: readonly EnumKeys<typeof ReflectionKind>[];
-    requiredToBeDocumented: readonly EnumKeys<typeof ReflectionKind>[];
-};
+export declare const excludeNotDocumentedKinds: readonly EnumKeys<typeof ReflectionKind>[];
+export declare const excludeTags: readonly `@${string}`[];
+export declare const blockTags: readonly `@${string}`[];
+export declare const inlineTags: readonly `@${string}`[];
+export declare const modifierTags: readonly `@${string}`[];
+export declare const cascadedModifierTags: readonly `@${string}`[];
+export declare const notRenderedTags: readonly `@${string}`[];
+export declare const highlightLanguages: readonly BundledLanguage[];
+export declare const sort: readonly string[];
+export declare const kindSortOrder: readonly EnumKeys<typeof ReflectionKind>[];
+export declare const requiredToBeDocumented: readonly EnumKeys<typeof ReflectionKind>[];

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

@@ -1,100 +1,98 @@
 import * as TagDefaults from "./tsdoc-defaults.js";
-/**
- * Default values for TypeDoc options. This object should not be modified.
- *
- * @privateRemarks
- * These are declared here, rather than within the option declaration, so that
- * they can be exposed as a part of the public API. The unfortunate type declaration
- * is to control the type which appears in the generated documentation.
- */
-export const OptionDefaults = {
-    excludeNotDocumentedKinds: [
-        "Module",
-        "Namespace",
-        "Enum",
-        // Not including enum member here by default
-        "Variable",
-        "Function",
-        "Class",
-        "Interface",
-        "Constructor",
-        "Property",
-        "Method",
-        "CallSignature",
-        "IndexSignature",
-        "ConstructorSignature",
-        "Accessor",
-        "GetSignature",
-        "SetSignature",
-        "TypeAlias",
-        "Reference",
-    ],
-    excludeTags: [
-        "@override",
-        "@virtual",
-        "@privateRemarks",
-        "@satisfies",
-        "@overload",
-        "@inline",
-    ],
-    blockTags: TagDefaults.blockTags,
-    inlineTags: TagDefaults.inlineTags,
-    modifierTags: TagDefaults.modifierTags,
-    cascadedModifierTags: ["@alpha", "@beta", "@experimental"],
-    notRenderedTags: [
-        "@showCategories",
-        "@showGroups",
-        "@hideCategories",
-        "@hideGroups",
-        "@expand",
-        "@summary",
-        "@group",
-        "@groupDescription",
-        "@category",
-        "@categoryDescription",
-    ],
-    highlightLanguages: [
-        "bash",
-        "console",
-        "css",
-        "html",
-        "javascript",
-        "json",
-        "jsonc",
-        "json5",
-        "yaml",
-        "tsx",
-        "typescript",
-    ],
-    sort: ["kind", "instance-first", "alphabetical-ignoring-documents"],
-    kindSortOrder: [
-        "Document",
-        "Project",
-        "Module",
-        "Namespace",
-        "Enum",
-        "EnumMember",
-        "Class",
-        "Interface",
-        "TypeAlias",
-        "Constructor",
-        "Property",
-        "Variable",
-        "Function",
-        "Accessor",
-        "Method",
-        "Reference",
-    ],
-    requiredToBeDocumented: [
-        "Enum",
-        "EnumMember",
-        "Variable",
-        "Function",
-        "Class",
-        "Interface",
-        "Property",
-        "Method",
-        "Accessor",
-        "TypeAlias",
-    ],
-};
+export const excludeNotDocumentedKinds = [
+    "Module",
+    "Namespace",
+    "Enum",
+    // Not including enum member here by default
+    "Variable",
+    "Function",
+    "Class",
+    "Interface",
+    "Constructor",
+    "Property",
+    "Method",
+    "CallSignature",
+    "IndexSignature",
+    "ConstructorSignature",
+    "Accessor",
+    "GetSignature",
+    "SetSignature",
+    "TypeAlias",
+    "Reference",
+];
+export const excludeTags = [
+    "@override",
+    "@virtual",
+    "@privateRemarks",
+    "@satisfies",
+    "@overload",
+    "@inline",
+];
+export const blockTags = TagDefaults.blockTags;
+export const inlineTags = TagDefaults.inlineTags;
+export const modifierTags = TagDefaults.modifierTags;
+export const cascadedModifierTags = [
+    "@alpha",
+    "@beta",
+    "@experimental",
+];
+export const notRenderedTags = [
+    "@showCategories",
+    "@showGroups",
+    "@hideCategories",
+    "@hideGroups",
+    "@expand",
+    "@summary",
+    "@group",
+    "@groupDescription",
+    "@category",
+    "@categoryDescription",
+];
+export const highlightLanguages = [
+    "bash",
+    "console",
+    "css",
+    "html",
+    "javascript",
+    "json",
+    "jsonc",
+    "json5",
+    "yaml",
+    "tsx",
+    "typescript",
+];
+export const sort = [
+    "kind",
+    "instance-first",
+    "alphabetical-ignoring-documents",
+];
+export const kindSortOrder = [
+    "Document",
+    "Project",
+    "Module",
+    "Namespace",
+    "Enum",
+    "EnumMember",
+    "Class",
+    "Interface",
+    "TypeAlias",
+    "Constructor",
+    "Property",
+    "Variable",
+    "Function",
+    "Accessor",
+    "Method",
+    "Reference",
+];
+export const requiredToBeDocumented = [
+    "Enum",
+    "EnumMember",
+    "Variable",
+    "Function",
+    "Class",
+    "Interface",
+    "Property",
+    "Method",
+    "Accessor",
+    "TypeAlias",
+];

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

@@ -3,4 +3,4 @@ export type { OptionsReader } from "./options.js";
 export { ArgumentsReader, PackageJsonReader, TypeDocReader, TSConfigReader, } from "./readers/index.js";
 export { CommentStyle, EmitStrategy, ParameterType, ParameterHint, } from "./declaration.js";
 export type { TypeDocOptions, TypeDocOptionMap, ValidationOptions, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, ObjectDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, TypeDocOptionValues, ParameterTypeToOptionTypeMap, ManuallyValidatedOption, JsDocCompatibility, OutputSpecification, } from "./declaration.js";
-export { OptionDefaults } from "./defaults.js";
+export * as OptionDefaults from "./defaults.js";

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

@@ -1,4 +1,4 @@
 export { Options, Option } from "./options.js";
 export { ArgumentsReader, PackageJsonReader, TypeDocReader, TSConfigReader, } from "./readers/index.js";
 export { CommentStyle, EmitStrategy, ParameterType, ParameterHint, } from "./declaration.js";
-export { OptionDefaults } from "./defaults.js";
+export * as OptionDefaults from "./defaults.js";

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

@@ -1,4 +1,4 @@
-import type * as ts from "typescript";
+import type ts from "typescript";
 import type { NeverIfInternal } from "../index.js";
 import type { Application } from "../../../index.js";
 import type { Logger } from "../loggers.js";

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

@@ -1,6 +1,6 @@
 import { LogLevel } from "../../loggers.js";
 import { ParameterType, ParameterHint, EmitStrategy, CommentStyle, } from "../declaration.js";
-import { OptionDefaults } from "../defaults.js";
+import * as OptionDefaults from "../defaults.js";
 import { SORT_STRATEGIES } from "../../sort.js";
 import { EntryPointStrategy } from "../../entry-point.js";
 import { ReflectionKind } from "../../../models/reflections/kind.js";

package/dist/lib/utils/sort.js

@@ -3,7 +3,7 @@
  * @module
  */
 import { ReflectionKind } from "../models/reflections/kind.js";
-import { OptionDefaults } from "./options/defaults.js";
+import * as OptionDefaults from "./options/defaults.js";
 export const SORT_STRATEGIES = [
     "source-order",
     "alphabetical",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.27.1",
+  "version": "0.27.2",
   "homepage": "https://typedoc.org",
   "type": "module",
   "exports": {
@@ -25,7 +25,7 @@
     "node": ">= 18"
   },
   "dependencies": {
-    "@gerrit0/mini-shiki": "^1.23.2",
+    "@gerrit0/mini-shiki": "^1.24.0",
     "lunr": "^2.3.9",
     "markdown-it": "^14.1.0",
     "minimatch": "^9.0.5",