typedoc 0.25.0 → 0.25.2

package/dist/lib/cli.js

@@ -31,6 +31,7 @@ const ExitCodes = {
     ValidationError: 4,
     OutputError: 5,
     ExceptionThrown: 6,
+    Watching: 7,
 };
 const td = __importStar(require("typedoc"));
 void main();
@@ -46,8 +47,10 @@ async function main() {
             new td.ArgumentsReader(300),
         ]);
         const exitCode = await run(app);
-        app.logger.verbose(`Full run took ${Date.now() - start}ms`);
-        process.exit(exitCode);
+        if (exitCode !== ExitCodes.Watching) {
+            app.logger.verbose(`Full run took ${Date.now() - start}ms`);
+            process.exit(exitCode);
+        }
     }
     catch (error) {
         console.error("TypeDoc exiting with unexpected error:");
@@ -88,7 +91,7 @@ async function run(app) {
                 await app.generateJson(project, json);
             }
         });
-        return ExitCodes.Ok;
+        return ExitCodes.Watching;
     }
     const project = await app.convert();
     if (!project) {

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

@@ -28,8 +28,14 @@ const variablePropertyKinds = [
 // the JSDoc converter because we only want part of the comment when
 // getting them.
 const wantedKinds = {
-    [models_1.ReflectionKind.Project]: [typescript_1.default.SyntaxKind.SourceFile],
-    [models_1.ReflectionKind.Module]: [typescript_1.default.SyntaxKind.SourceFile],
+    [models_1.ReflectionKind.Project]: [
+        typescript_1.default.SyntaxKind.SourceFile,
+        typescript_1.default.SyntaxKind.ModuleDeclaration,
+    ],
+    [models_1.ReflectionKind.Module]: [
+        typescript_1.default.SyntaxKind.SourceFile,
+        typescript_1.default.SyntaxKind.ModuleDeclaration,
+    ],
     [models_1.ReflectionKind.Namespace]: [
         typescript_1.default.SyntaxKind.ModuleDeclaration,
         typescript_1.default.SyntaxKind.SourceFile,

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

@@ -74,7 +74,15 @@ function getComment(symbol, kind, config, logger, commentStyle, checker) {
         declarations.every((d) => jsDocCommentKinds.includes(d.kind))) {
         return getJsDocComment(declarations[0], config, logger, checker);
     }
-    const comment = getCommentImpl((0, discovery_1.discoverComment)(symbol, kind, logger, commentStyle), config, logger, declarations.some(typescript_1.default.isSourceFile), checker);
+    const isModule = declarations.some((decl) => {
+        if (typescript_1.default.isSourceFile(decl))
+            return true;
+        if (typescript_1.default.isModuleDeclaration(decl) && typescript_1.default.isStringLiteral(decl.name)) {
+            return true;
+        }
+        return false;
+    });
+    const comment = getCommentImpl((0, discovery_1.discoverComment)(symbol, kind, logger, commentStyle), config, logger, isModule, checker);
     if (!comment && kind === models_1.ReflectionKind.Property) {
         return getConstructorParamPropertyComment(symbol, config, logger, commentStyle, checker);
     }

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

@@ -6,6 +6,7 @@ const models_1 = require("../../models");
 const utils_1 = require("../../utils");
 const paths_1 = require("../../utils/paths");
 const lexer_1 = require("./lexer");
+const tagName_1 = require("./tagName");
 function makeLookaheadGenerator(gen) {
     let trackHistory = false;
     const history = [];
@@ -78,17 +79,10 @@ function postProcessComment(comment, warning) {
         if (HAS_USER_IDENTIFIER.includes(tag.tag) && tag.content.length) {
             const first = tag.content[0];
             if (first.kind === "text") {
-                let end = first.text.search(/\s/);
-                if (end === -1)
-                    end = first.text.length;
-                tag.name = first.text.substring(0, end);
-                if (tag.name.startsWith("[") && tag.name.endsWith("]")) {
-                    tag.name = tag.name.slice(1, tag.name.indexOf("="));
-                }
-                first.text = first.text.substring(end);
-                const endOfTrivia = first.text.search(/[^\-\s]/);
-                if (endOfTrivia !== -1) {
-                    first.text = first.text.substring(endOfTrivia);
+                const { name, newText } = (0, tagName_1.extractTagName)(first.text);
+                tag.name = name;
+                if (newText) {
+                    first.text = newText;
                 }
                 else {
                     // Remove this token, no real text in it.

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

@@ -0,0 +1,8 @@
+/**
+ * Determines the name of the parameter/template/property from the tag content
+ * when processing `@param x`
+ */
+export declare function extractTagName(text: string): {
+    name: string;
+    newText: string;
+};

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

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractTagName = void 0;
+/**
+ * Determines the name of the parameter/template/property from the tag content
+ * when processing `@param x`
+ */
+function extractTagName(text) {
+    let pos = skipWs(text, 0);
+    // Extract the "name" part of the comment, this might also include a default
+    // value if bracketed.
+    let nameStart = pos;
+    let bracketDepth = 0;
+    let stringChar = "";
+    while (pos < text.length && (bracketDepth > 0 || /\S/.test(text[pos]))) {
+        if (stringChar) {
+            if (text[pos] == stringChar) {
+                stringChar = "";
+                ++pos;
+            }
+            else if (text[pos] == "\\") {
+                pos += 2;
+            }
+            else {
+                ++pos;
+            }
+        }
+        else {
+            if ("\"'`".includes(text[pos])) {
+                stringChar = text[pos];
+            }
+            else if (text[pos] == "[") {
+                ++bracketDepth;
+            }
+            else if (text[pos] == "]") {
+                --bracketDepth;
+            }
+            ++pos;
+        }
+    }
+    let nameEnd = pos;
+    if (text[nameStart] === "[") {
+        nameStart = skipWs(text, nameStart + 1);
+        nameEnd = skipWith(text, nameStart, /[^\s=\]]/);
+    }
+    // Skip any whitespace & an optional dash before the description
+    pos = skipWith(text, pos, /[\s-]/);
+    return {
+        name: text.substring(nameStart, nameEnd),
+        newText: text.substring(pos),
+    };
+}
+exports.extractTagName = extractTagName;
+function skipWs(text, pos) {
+    return skipWith(text, pos, /\s/);
+}
+function skipWith(text, pos, reg) {
+    while (pos < text.length && reg.test(text[pos])) {
+        ++pos;
+    }
+    return pos;
+}

package/dist/lib/converter/context.js

@@ -138,9 +138,8 @@ class Context {
         this.converter.trigger(converter_events_1.ConverterEvents.CREATE_DECLARATION, this, reflection);
     }
     addChild(reflection) {
-        var _a;
         if (this.scope instanceof index_1.ContainerReflection) {
-            (_a = this.scope).children ?? (_a.children = []);
+            this.scope.children ??= [];
             this.scope.children.push(reflection);
         }
     }

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

@@ -15,29 +15,29 @@ import type { DeclarationReference } from "./comments/declarationReference";
  */
 export declare class Converter extends ChildableComponent<Application, ConverterComponent> {
     /** @internal */
-    externalPattern: string[];
+    accessor externalPattern: string[];
     private externalPatternCache?;
     private excludeCache?;
     /** @internal */
-    excludeExternals: boolean;
+    accessor excludeExternals: boolean;
     /** @internal */
-    excludeNotDocumented: boolean;
+    accessor excludeNotDocumented: boolean;
     /** @internal */
-    excludePrivate: boolean;
+    accessor excludePrivate: boolean;
     /** @internal */
-    excludeProtected: boolean;
+    accessor excludeProtected: boolean;
     /** @internal */
-    excludeReferences: boolean;
+    accessor excludeReferences: boolean;
     /** @internal */
-    commentStyle: CommentStyle;
+    accessor commentStyle: CommentStyle;
     /** @internal */
-    validation: ValidationOptions;
+    accessor validation: ValidationOptions;
     /** @internal */
-    externalSymbolLinkMappings: Record<string, Record<string, string>>;
+    accessor externalSymbolLinkMappings: Record<string, Record<string, string>>;
     /** @internal */
-    useTsLinkResolution: boolean;
+    accessor useTsLinkResolution: boolean;
     /** @internal */
-    preserveLinkText: boolean;
+    accessor preserveLinkText: boolean;
     private _config?;
     private _externalSymbolResolvers;
     get config(): CommentParserConfig;