typedoc 0.26.0-beta.5 → 0.26.1

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export { Application } from "./lib/application";
-export { EventDispatcher, Event } from "./lib/utils/events";
+export { Application, type ApplicationEvents } from "./lib/application";
+export { EventDispatcher } from "./lib/utils/events";
 export { resetReflectionID } from "./lib/models/reflections/abstract";
 /**
  * All symbols documented under the Models namespace are also available in the root import.
@@ -17,13 +17,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 { Converter, Context, type CommentParserConfig, type DeclarationReference, type SymbolReference, type ComponentPath, type Meaning, type MeaningKeyword, type ExternalResolveResult, type ExternalSymbolResolver, type ConverterEvents, } from "./lib/converter";
 export { Renderer, DefaultTheme, DefaultThemeRenderContext, Slugger, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, IndexEvent, } from "./lib/output";
-export type { RenderTemplate, RendererHooks, NavigationElement, } from "./lib/output";
+export type { RenderTemplate, RendererHooks, NavigationElement, RendererEvents, } from "./lib/output";
 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 { JSONOutput, Serializer, type SerializerEvents, 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,12 +29,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+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.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");
 Object.defineProperty(exports, "EventDispatcher", { enumerable: true, get: function () { return events_1.EventDispatcher; } });
-Object.defineProperty(exports, "Event", { enumerable: true, get: function () { return events_1.Event; } });
 var abstract_1 = require("./lib/models/reflections/abstract");
 Object.defineProperty(exports, "resetReflectionID", { enumerable: true, get: function () { return abstract_1.resetReflectionID; } });
 /**

package/dist/lib/application-events.d.ts

@@ -1,5 +1,5 @@
 export declare const ApplicationEvents: {
-    BOOTSTRAP_END: string;
-    REVIVE: string;
-    VALIDATE_PROJECT: string;
+    readonly BOOTSTRAP_END: "bootstrapEnd";
+    readonly REVIVE: "reviveProject";
+    readonly VALIDATE_PROJECT: "validateProject";
 };

package/dist/lib/application.d.ts

@@ -10,6 +10,11 @@ import { type DocumentationEntryPoint, EntryPointStrategy } from "./utils/entry-
 import { Internationalization } from "./internationalization/internationalization";
 import { FileRegistry } from "./models/FileRegistry";
 export declare function createAppForTesting(): Application;
+export interface ApplicationEvents {
+    bootstrapEnd: [Application];
+    reviveProject: [ProjectReflection];
+    validateProject: [ProjectReflection];
+}
 /**
  * The default TypeDoc main application class.
  *
@@ -28,7 +33,7 @@ export declare function createAppForTesting(): Application;
  * Access to an Application instance can be retrieved with {@link Application.bootstrap} or
  * {@link Application.bootstrapWithPlugins}. It can not be constructed manually.
  */
-export declare class Application extends ChildableComponent<Application, AbstractComponent<Application>> {
+export declare class Application extends ChildableComponent<Application, AbstractComponent<Application, {}>, ApplicationEvents> {
     /**
      * The converter used to create the declaration reflections.
      */
@@ -76,17 +81,17 @@ export declare class Application extends ChildableComponent<Application, Abstrac
      * Emitted after plugins have been loaded and options have been read, but before they have been frozen.
      * The listener will be given an instance of {@link Application}.
      */
-    static readonly EVENT_BOOTSTRAP_END: string;
+    static readonly EVENT_BOOTSTRAP_END: "bootstrapEnd";
     /**
      * Emitted after a project has been deserialized from JSON.
      * The listener will be given an instance of {@link ProjectReflection}.
      */
-    static readonly EVENT_PROJECT_REVIVE: string;
+    static readonly EVENT_PROJECT_REVIVE: "reviveProject";
     /**
      * Emitted when validation is being run.
      * The listener will be given an instance of {@link ProjectReflection}.
      */
-    static readonly EVENT_VALIDATE_PROJECT: string;
+    static readonly EVENT_VALIDATE_PROJECT: "validateProject";
     /**
      * Create a new TypeDoc application instance.
      */

package/dist/lib/application.js

@@ -204,8 +204,8 @@ let Application = (() => {
             _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.converter = new index_1.Converter(this);
+            this.renderer = new renderer_1.Renderer(this);
             this.logger.i18n = this.i18n;
         }
         /**
@@ -496,6 +496,7 @@ let Application = (() => {
                 this.logger.error(this.i18n.failed_to_find_packages());
                 return;
             }
+            const origFiles = this.files;
             const origOptions = this.options;
             const projects = [];
             const projectsToConvert = [];
@@ -526,14 +527,23 @@ let Application = (() => {
             for (const { dir, options } of projectsToConvert) {
                 this.logger.info(this.i18n.converting_project_at_0((0, paths_1.nicePath)(dir)));
                 this.options = options;
-                const project = await this.convert();
+                this.files = new FileRegistry_1.ValidatingFileRegistry();
+                let project = await this.convert();
                 if (project) {
                     this.validate(project);
-                    projects.push(this.serializer.projectToObject(project, process.cwd()));
+                    const serialized = this.serializer.projectToObject(project, process.cwd());
+                    projects.push(serialized);
                 }
+                // When debugging memory issues, it's useful to set these
+                // here so that a breakpoint on resetReflectionID below
+                // gets the memory as it ought to be with all TS objects released.
+                project = undefined;
+                this.files = undefined;
+                // global.gc!();
                 (0, abstract_1.resetReflectionID)();
             }
             this.options = origOptions;
+            this.files = origFiles;
             if (projects.length !== packageDirs.length) {
                 this.logger.error(this.i18n.failed_to_convert_packages());
                 return;

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

@@ -99,12 +99,14 @@ function parseCommentString(tokens, config, file, logger, files) {
             inheritDocTag: true,
         },
     };
+    const reentry = new textParser_1.TextParserReentryState();
     const content = [];
     const lexer = makeLookaheadGenerator(tokens);
     let atNewLine = false;
     while (!lexer.done()) {
         let consume = true;
         const next = lexer.peek();
+        reentry.checkState(next);
         switch (next.kind) {
             case lexer_1.TokenSyntaxKind.TypeAnnotation:
                 // Shouldn't have been produced by our lexer
@@ -114,7 +116,7 @@ function parseCommentString(tokens, config, file, logger, files) {
             case lexer_1.TokenSyntaxKind.Text:
             case lexer_1.TokenSyntaxKind.Tag:
             case lexer_1.TokenSyntaxKind.CloseBrace:
-                (0, textParser_1.textContent)(file.fileName, next, logger.i18n, (msg, token) => logger.warn(msg, token.pos, file), content, files, atNewLine);
+                (0, textParser_1.textContent)(file.fileName, next, logger.i18n, (msg, token) => logger.warn(msg, token.pos, file), content, files, atNewLine, reentry);
                 break;
             case lexer_1.TokenSyntaxKind.Code:
                 content.push({ kind: "code", text: next.text });
@@ -257,7 +259,7 @@ function defaultBlockContent(comment, lexer, config, i18n, warning, files) {
     const content = blockContent(comment, lexer, config, i18n, () => { }, tempRegistry);
     const end = lexer.done() || lexer.peek();
     lexer.release();
-    if (content.some((part) => part.kind === "code")) {
+    if (content.some((part) => part.kind === "code" || part.kind === "inline-tag")) {
         return blockContent(comment, lexer, config, i18n, warning, files);
     }
     const tokens = [];
@@ -367,8 +369,10 @@ function exampleBlock(comment, lexer, config, i18n, warning, files) {
 function blockContent(comment, lexer, config, i18n, warning, files) {
     const content = [];
     let atNewLine = true;
+    const reentry = new textParser_1.TextParserReentryState();
     loop: while (!lexer.done()) {
         const next = lexer.peek();
+        reentry.checkState(next);
         let consume = true;
         switch (next.kind) {
             case lexer_1.TokenSyntaxKind.NewLine:
@@ -376,7 +380,7 @@ function blockContent(comment, lexer, config, i18n, warning, files) {
                 break;
             case lexer_1.TokenSyntaxKind.Text:
                 (0, textParser_1.textContent)(comment.sourcePath, next, i18n, warning, 
-                /*out*/ content, files, atNewLine);
+                /*out*/ content, files, atNewLine, reentry);
                 break;
             case lexer_1.TokenSyntaxKind.Code:
                 content.push({ kind: "code", text: next.text });

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

@@ -9,8 +9,19 @@ import type { TranslationProxy, TranslatedString } from "../../internationalizat
 import type { CommentDisplayPart } from "../../models";
 import type { FileRegistry } from "../../models/FileRegistry";
 import { type Token } from "./lexer";
+/**
+ * This is incredibly unfortunate. The comment lexer owns the responsibility
+ * for splitting up text into text/code, this is totally fine for HTML links
+ * but for markdown links, ``[`code`](./link)`` is valid, so we need to keep
+ * track of state across calls to {@link textContent}.
+ */
+export declare class TextParserReentryState {
+    withinLinkLabel: boolean;
+    private lastPartWasNewline;
+    checkState(token: Token): void;
+}
 /**
  * Look for relative links within a piece of text and add them to the {@link FileRegistry}
  * so that they can be correctly resolved during rendering.
  */
-export declare function textContent(sourcePath: string, token: Token, i18n: TranslationProxy, warning: (msg: TranslatedString, token: Token) => void, outContent: CommentDisplayPart[], files: FileRegistry, atNewLine: boolean): void;
+export declare function textContent(sourcePath: string, token: Token, i18n: TranslationProxy, warning: (msg: TranslatedString, token: Token) => void, outContent: CommentDisplayPart[], files: FileRegistry, atNewLine: boolean, reentry: TextParserReentryState): void;

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

@@ -3,21 +3,50 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextParserReentryState = void 0;
 exports.textContent = textContent;
 const html_1 = require("../../utils/html");
 const lexer_1 = require("./lexer");
 const markdown_it_1 = __importDefault(require("markdown-it"));
 const MdHelpers = new markdown_it_1.default().helpers;
+/**
+ * This is incredibly unfortunate. The comment lexer owns the responsibility
+ * for splitting up text into text/code, this is totally fine for HTML links
+ * but for markdown links, ``[`code`](./link)`` is valid, so we need to keep
+ * track of state across calls to {@link textContent}.
+ */
+class TextParserReentryState {
+    constructor() {
+        this.withinLinkLabel = false;
+        this.lastPartWasNewline = false;
+    }
+    checkState(token) {
+        switch (token.kind) {
+            case lexer_1.TokenSyntaxKind.Code:
+                if (/\n\s*\n/.test(token.text)) {
+                    this.withinLinkLabel = false;
+                }
+                break;
+            case lexer_1.TokenSyntaxKind.NewLine:
+                if (this.lastPartWasNewline) {
+                    this.withinLinkLabel = false;
+                }
+                break;
+        }
+        this.lastPartWasNewline = token.kind === lexer_1.TokenSyntaxKind.NewLine;
+    }
+}
+exports.TextParserReentryState = TextParserReentryState;
 /**
  * Look for relative links within a piece of text and add them to the {@link FileRegistry}
  * so that they can be correctly resolved during rendering.
  */
-function textContent(sourcePath, token, i18n, warning, outContent, files, atNewLine) {
+function textContent(sourcePath, token, i18n, warning, outContent, files, atNewLine, reentry) {
     let lastPartEnd = 0;
     const data = {
         sourcePath,
         token,
-        pos: 0,
+        pos: 0, // relative to the token
         i18n,
         warning,
         files: files,
@@ -38,13 +67,14 @@ function textContent(sourcePath, token, i18n, warning, outContent, files, atNewL
         if (!ref.target) {
             warning(i18n.relative_path_0_does_not_exist(token.text.slice(ref.pos, ref.end)), {
                 kind: lexer_1.TokenSyntaxKind.Text,
-                pos: ref.pos,
+                // ref.pos is relative to the token, but this pos is relative to the file.
+                pos: token.pos + ref.pos,
                 text: token.text.slice(ref.pos, ref.end),
             });
         }
     }
     while (data.pos < token.text.length) {
-        const link = checkMarkdownLink(data);
+        const link = checkMarkdownLink(data, reentry);
         if (link) {
             addRef(link);
             continue;
@@ -76,28 +106,44 @@ function textContent(sourcePath, token, i18n, warning, outContent, files, atNewL
  * Reference: https://github.com/markdown-it/markdown-it/blob/14.1.0/lib/rules_inline/image.mjs
  *
  */
-function checkMarkdownLink(data) {
+function checkMarkdownLink(data, reentry) {
     const { token, sourcePath, files } = data;
-    if (token.text[data.pos] === "[") {
-        const labelEnd = findLabelEnd(token.text, data.pos + 1);
-        if (labelEnd !== -1 &&
-            token.text[labelEnd] === "]" &&
-            token.text[labelEnd + 1] === "(") {
-            const link = MdHelpers.parseLinkDestination(token.text, labelEnd + 2, token.text.length);
-            if (link.ok) {
-                // Only make a relative-link display part if it's actually a relative link.
-                // Discard protocol:// links, unix style absolute paths, and windows style absolute paths.
-                if (isRelativeLink(link.str)) {
-                    return {
-                        pos: labelEnd + 2,
-                        end: link.pos,
-                        target: files.register(sourcePath, link.str),
-                    };
-                }
-                // This was a link, skip ahead to ensure we don't happen to parse
-                // something else as a link within the link.
-                data.pos = link.pos - 1;
+    let searchStart;
+    if (reentry.withinLinkLabel) {
+        searchStart = data.pos;
+        reentry.withinLinkLabel = false;
+    }
+    else if (token.text[data.pos] === "[") {
+        searchStart = data.pos + 1;
+    }
+    else {
+        return;
+    }
+    const labelEnd = findLabelEnd(token.text, searchStart);
+    if (labelEnd === -1) {
+        // This markdown link might be split across multiple display parts
+        // [ `text` ](link)
+        // ^^ text
+        //   ^^^^^^ code
+        //         ^^^^^^^^ text
+        reentry.withinLinkLabel = true;
+        return;
+    }
+    if (token.text[labelEnd] === "]" && token.text[labelEnd + 1] === "(") {
+        const link = MdHelpers.parseLinkDestination(token.text, labelEnd + 2, token.text.length);
+        if (link.ok) {
+            // Only make a relative-link display part if it's actually a relative link.
+            // Discard protocol:// links, unix style absolute paths, and windows style absolute paths.
+            if (isRelativeLink(link.str)) {
+                return {
+                    pos: labelEnd + 2,
+                    end: link.pos,
+                    target: files.register(sourcePath, link.str),
+                };
             }
+            // This was a link, skip ahead to ensure we don't happen to parse
+            // something else as a link within the link.
+            data.pos = link.pos - 1;
         }
     }
 }
@@ -175,13 +221,14 @@ function checkAttribute(data, attr) {
     }
 }
 function isRelativeLink(link) {
-    return !/^[a-z]+:\/\/|^\/|^[a-z]:\\/i.test(link);
+    return !/^[a-z]+:\/\/|^\/|^[a-z]:\\|^#/i.test(link);
 }
 function findLabelEnd(text, pos) {
     while (pos < text.length) {
         switch (text[pos]) {
             case "\n":
             case "]":
+            case "[":
                 return pos;
         }
         ++pos;

package/dist/lib/converter/components.d.ts

@@ -1,5 +1,5 @@
 import { Component, AbstractComponent } from "../utils/component";
 import type { Converter } from "./converter";
 export { Component };
-export declare abstract class ConverterComponent extends AbstractComponent<Converter> {
+export declare abstract class ConverterComponent extends AbstractComponent<Converter, {}> {
 }

package/dist/lib/converter/context.d.ts

@@ -71,16 +71,6 @@ export declare class Context {
      * @param symbol  The symbol the given reflection was resolved from.
      */
     registerReflection(reflection: Reflection, symbol: ts.Symbol | undefined): void;
-    /**
-     * Trigger a node reflection event.
-     *
-     * All events are dispatched on the current converter instance.
-     *
-     * @param name  The name of the event that should be triggered.
-     * @param reflection  The triggering reflection.
-     * @param node  The triggering TypeScript node if available.
-     */
-    trigger(name: string, reflection: Reflection, node?: ts.Node): void;
     /** @internal */
     setActiveProgram(program: ts.Program | undefined): void;
     getComment(symbol: ts.Symbol, kind: ReflectionKind): import("../models/index").Comment | undefined;

package/dist/lib/converter/context.js

@@ -169,18 +169,6 @@ class Context {
     registerReflection(reflection, symbol) {
         this.project.registerReflection(reflection, symbol, void 0);
     }
-    /**
-     * Trigger a node reflection event.
-     *
-     * All events are dispatched on the current converter instance.
-     *
-     * @param name  The name of the event that should be triggered.
-     * @param reflection  The triggering reflection.
-     * @param node  The triggering TypeScript node if available.
-     */
-    trigger(name, reflection, node) {
-        this.converter.trigger(name, this, reflection, node);
-    }
     /** @internal */
     setActiveProgram(program) {
         this._program = program;

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

@@ -1,6 +1,6 @@
 import ts from "typescript";
 import type { Application } from "../application";
-import { Comment, type CommentDisplayPart, type ContainerReflection, ProjectReflection, type Reflection, type ReflectionSymbolId, type SomeType } from "../models/index";
+import { Comment, type CommentDisplayPart, type ContainerReflection, type DeclarationReflection, type ParameterReflection, ProjectReflection, type Reflection, type ReflectionSymbolId, type SignatureReflection, type SomeType, type TypeParameterReflection } from "../models/index";
 import { Context } from "./context";
 import { ConverterComponent } from "./components";
 import { ChildableComponent } from "../utils/component";
@@ -11,10 +11,30 @@ import type { CommentStyle, ValidationOptions } from "../utils/options/declarati
 import { type ExternalSymbolResolver, type ExternalResolveResult } from "./comments/linkResolver";
 import { type DeclarationReference } from "./comments/declarationReference";
 import type { FileRegistry } from "../models/FileRegistry";
+export interface ConverterEvents {
+    begin: [Context];
+    end: [Context];
+    createDeclaration: [Context, DeclarationReflection];
+    createSignature: [
+        Context,
+        SignatureReflection,
+        (ts.SignatureDeclaration | ts.IndexSignatureDeclaration | ts.JSDocSignature)?,
+        ts.Signature?
+    ];
+    createParameter: [Context, ParameterReflection, ts.Node?];
+    createTypeParameter: [
+        Context,
+        TypeParameterReflection,
+        ts.TypeParameterDeclaration?
+    ];
+    resolveBegin: [Context];
+    resolveReflection: [Context, Reflection];
+    resolveEnd: [Context];
+}
 /**
  * Compiles source files using TypeScript and converts compiler symbols to reflections.
  */
-export declare class Converter extends ChildableComponent<Application, ConverterComponent> {
+export declare class Converter extends ChildableComponent<Application, ConverterComponent, ConverterEvents> {
     /** @internal */
     accessor externalPattern: string[];
     private externalPatternCache?;

package/dist/lib/converter/converter.js

@@ -329,7 +329,6 @@ let Converter = (() => {
                     ? context.getComment(symbol, context.project.kind)
                     : context.getFileComment(node);
                 this.processDocumentTags(context.project, context.project);
-                context.trigger(Converter.EVENT_CREATE_DECLARATION, context.project);
                 moduleContext = context;
             }
             else {

package/dist/lib/converter/factories/index-signature.js

@@ -27,6 +27,6 @@ function convertIndexSignatures(context, symbol) {
         context.registerReflection(index, indexSymbol);
         context.scope.indexSignatures ||= [];
         context.scope.indexSignatures.push(index);
-        context.trigger(converter_events_1.ConverterEvents.CREATE_SIGNATURE, index, indexDeclaration);
+        context.converter.trigger(converter_events_1.ConverterEvents.CREATE_SIGNATURE, context, index, indexDeclaration);
     }
 }

package/dist/lib/converter/factories/signature.js

@@ -111,7 +111,7 @@ function convertParameters(context, sigRef, parameters, parameterNodes) {
         }
         paramRefl.comment ||= context.getComment(param, paramRefl.kind);
         context.registerReflection(paramRefl, param);
-        context.trigger(converter_events_1.ConverterEvents.CREATE_PARAMETER, paramRefl);
+        context.converter.trigger(converter_events_1.ConverterEvents.CREATE_PARAMETER, context, paramRefl);
         let type;
         if (declaration) {
             type = context.checker.getTypeOfSymbolAtLocation(param, declaration);
@@ -164,7 +164,7 @@ function convertParameterNodes(context, sigRef, parameters) {
             paramRefl.comment = context.getJsDocComment(param);
         }
         context.registerReflection(paramRefl, context.getSymbolAtLocation(param));
-        context.trigger(converter_events_1.ConverterEvents.CREATE_PARAMETER, paramRefl);
+        context.converter.trigger(converter_events_1.ConverterEvents.CREATE_PARAMETER, context, paramRefl);
         paramRefl.type = context.converter.convertType(context.withScope(paramRefl), typescript_1.default.isParameter(param) ? param.type : param.typeExpression?.type);
         const isOptional = typescript_1.default.isParameter(param)
             ? !!param.questionToken
@@ -221,7 +221,7 @@ function convertTypeParameters(context, parent, parameters) {
             paramRefl.flags.setFlag(models_1.ReflectionFlag.Const, true);
         }
         context.registerReflection(paramRefl, param.getSymbol());
-        context.trigger(converter_events_1.ConverterEvents.CREATE_TYPE_PARAMETER, paramRefl);
+        context.converter.trigger(converter_events_1.ConverterEvents.CREATE_TYPE_PARAMETER, context, paramRefl);
         return paramRefl;
     });
 }
@@ -244,7 +244,7 @@ function createTypeParamReflection(param, context) {
     if (typescript_1.default.isJSDocTemplateTag(param.parent)) {
         paramRefl.comment = context.getJsDocComment(param.parent);
     }
-    context.trigger(converter_events_1.ConverterEvents.CREATE_TYPE_PARAMETER, paramRefl, param);
+    context.converter.trigger(converter_events_1.ConverterEvents.CREATE_TYPE_PARAMETER, context, paramRefl, param);
     return paramRefl;
 }
 function convertTemplateParameterNodes(context, nodes) {
@@ -266,7 +266,7 @@ function convertTemplateParameterNodes(context, nodes) {
             if (typescript_1.default.isJSDocTemplateTag(param.parent)) {
                 paramRefl.comment = context.getJsDocComment(param.parent);
             }
-            context.trigger(converter_events_1.ConverterEvents.CREATE_TYPE_PARAMETER, paramRefl, param);
+            context.converter.trigger(converter_events_1.ConverterEvents.CREATE_TYPE_PARAMETER, context, paramRefl, param);
             return paramRefl;
         });
     });

package/dist/lib/converter/index.d.ts

@@ -1,5 +1,5 @@
 export { Context } from "./context";
-export { Converter } from "./converter";
+export { Converter, type ConverterEvents } from "./converter";
 export type { CommentParserConfig } from "./comments/index";
 export { convertDefaultValue, convertExpression } from "./convert-expression";
 export type { DeclarationReference, SymbolReference, ComponentPath, Meaning, MeaningKeyword, } from "./comments/declarationReference";

package/dist/lib/converter/jsdoc.js

@@ -61,7 +61,7 @@ function convertJsDocSignature(context, node) {
     }
     const reflection = new models_1.DeclarationReflection("__type", models_1.ReflectionKind.TypeLiteral, context.scope);
     context.registerReflection(reflection, symbol);
-    context.trigger(converter_events_1.ConverterEvents.CREATE_DECLARATION, reflection);
+    context.converter.trigger(converter_events_1.ConverterEvents.CREATE_DECLARATION, context, reflection);
     const signature = new models_1.SignatureReflection("__type", models_1.ReflectionKind.CallSignature, reflection);
     context.project.registerSymbolId(signature, new ReflectionSymbolId_1.ReflectionSymbolId(symbol, node));
     context.registerReflection(signature, void 0);

package/dist/lib/converter/plugins/CategoryPlugin.js

@@ -100,10 +100,8 @@ let CategoryPlugin = (() => {
          * Create a new CategoryPlugin instance.
          */
         initialize() {
-            this.listenTo(this.owner, {
-                [converter_1.Converter.EVENT_BEGIN]: this.onBegin,
-                [converter_1.Converter.EVENT_RESOLVE_END]: this.onEndResolve,
-            }, undefined, -200);
+            this.owner.on(converter_1.Converter.EVENT_BEGIN, this.onBegin.bind(this), -200);
+            this.owner.on(converter_1.Converter.EVENT_RESOLVE_END, this.onEndResolve.bind(this), -200);
         }
         /**
          * Triggered when the converter begins converting a project.

package/dist/lib/converter/plugins/CommentPlugin.js

@@ -215,15 +215,13 @@ let CommentPlugin = (() => {
          * Create a new CommentPlugin instance.
          */
         initialize() {
-            this.listenTo(this.owner, {
-                [converter_1.Converter.EVENT_CREATE_DECLARATION]: this.onDeclaration,
-                [converter_1.Converter.EVENT_CREATE_SIGNATURE]: this.onDeclaration,
-                [converter_1.Converter.EVENT_CREATE_TYPE_PARAMETER]: this.onCreateTypeParameter,
-                [converter_1.Converter.EVENT_RESOLVE_BEGIN]: this.onBeginResolve,
-                [converter_1.Converter.EVENT_RESOLVE]: this.onResolve,
-                [converter_1.Converter.EVENT_END]: () => {
-                    this._excludeKinds = undefined;
-                },
+            this.owner.on(converter_1.Converter.EVENT_CREATE_DECLARATION, this.onDeclaration.bind(this));
+            this.owner.on(converter_1.Converter.EVENT_CREATE_SIGNATURE, this.onDeclaration.bind(this));
+            this.owner.on(converter_1.Converter.EVENT_CREATE_TYPE_PARAMETER, this.onCreateTypeParameter.bind(this));
+            this.owner.on(converter_1.Converter.EVENT_RESOLVE_BEGIN, this.onBeginResolve.bind(this));
+            this.owner.on(converter_1.Converter.EVENT_RESOLVE, this.onResolve.bind(this));
+            this.owner.on(converter_1.Converter.EVENT_END, () => {
+                this._excludeKinds = undefined;
             });
         }
         /**
@@ -273,8 +271,7 @@ let CommentPlugin = (() => {
                 comment.removeModifier("@event");
                 comment.removeModifier("@eventProperty");
             }
-            if (reflection.kindOf(models_1.ReflectionKind.Module | models_1.ReflectionKind.Namespace) ||
-                reflection.kind === models_1.ReflectionKind.Project) {
+            if (reflection.kindOf(models_1.ReflectionKind.Project | models_1.ReflectionKind.SomeModule)) {
                 comment.removeTags("@module");
                 comment.removeModifier("@packageDocumentation");
             }
@@ -340,6 +337,10 @@ let CommentPlugin = (() => {
          * @param context  The context object describing the current state the converter is in.
          */
         onBeginResolve(context) {
+            if (context.project.comment) {
+                this.applyModifiers(context.project, context.project.comment);
+                this.removeExcludedTags(context.project.comment);
+            }
             const project = context.project;
             const reflections = Object.values(project.reflections);
             // Remove hidden reflections

package/dist/lib/converter/plugins/GroupPlugin.js

@@ -116,16 +116,14 @@ let GroupPlugin = (() => {
          * Create a new GroupPlugin instance.
          */
         initialize() {
-            this.listenTo(this.owner, {
-                [converter_1.Converter.EVENT_RESOLVE_BEGIN]: () => {
-                    this.sortFunction = (0, sort_1.getSortFunction)(this.application.options);
-                    GroupPlugin.WEIGHTS = this.groupOrder;
-                    if (GroupPlugin.WEIGHTS.length === 0) {
-                        GroupPlugin.WEIGHTS = defaultGroupOrder.map((kind) => this.application.internationalization.kindPluralString(kind));
-                    }
-                },
-                [converter_1.Converter.EVENT_RESOLVE_END]: this.onEndResolve,
-            }, undefined, -100);
+            this.owner.on(converter_1.Converter.EVENT_RESOLVE_BEGIN, () => {
+                this.sortFunction = (0, sort_1.getSortFunction)(this.application.options);
+                GroupPlugin.WEIGHTS = this.groupOrder;
+                if (GroupPlugin.WEIGHTS.length === 0) {
+                    GroupPlugin.WEIGHTS = defaultGroupOrder.map((kind) => this.application.internationalization.kindPluralString(kind));
+                }
+            }, -100);
+            this.owner.on(converter_1.Converter.EVENT_RESOLVE_END, this.onEndResolve.bind(this), -100);
         }
         /**
          * Triggered when the converter has finished resolving a project.

package/dist/lib/converter/plugins/ImplementsPlugin.js

@@ -70,10 +70,10 @@ let ImplementsPlugin = (() => {
          * Create a new ImplementsPlugin instance.
          */
         initialize() {
-            this.listenTo(this.owner, converter_1.Converter.EVENT_RESOLVE_END, this.onResolveEnd);
-            this.listenTo(this.owner, converter_1.Converter.EVENT_CREATE_DECLARATION, this.onDeclaration, -1000);
-            this.listenTo(this.owner, converter_1.Converter.EVENT_CREATE_SIGNATURE, this.onSignature, 1000);
-            this.listenTo(this.application, application_events_1.ApplicationEvents.REVIVE, this.resolve);
+            this.owner.on(converter_1.Converter.EVENT_RESOLVE_END, this.onResolveEnd.bind(this));
+            this.owner.on(converter_1.Converter.EVENT_CREATE_DECLARATION, this.onDeclaration.bind(this), -1000);
+            this.owner.on(converter_1.Converter.EVENT_CREATE_SIGNATURE, this.onSignature.bind(this), 1000);
+            this.application.on(application_events_1.ApplicationEvents.REVIVE, this.resolve.bind(this));
         }
         /**
          * Mark all members of the given class to be the implementation of the matching interface member.