@asciidoctor/core 4.0.0-alpha.6 → 4.0.1

package/types/logging.d.ts

@@ -95,22 +95,66 @@ export namespace Logger {
     export { BasicFormatter };
     export namespace AutoFormattingMessage {
         /**
-         * Attach auto-formatting to any plain object carrying { text, source_location }.
-         * @param {{text: string, source_location?: string}} obj
+         * Attach auto-formatting to any plain object carrying
+         * { text, source_location, include_location }.
+         *
+         * The location(s) are rendered only by inspect()/toString() (used when a
+         * stderr Logger formats the line); the structured `source_location` /
+         * `include_location` remain on the object so a MemoryLogger can record them
+         * on the resulting LogMessage without duplicating them inside `text`.
+         * @param {{text: string, source_location?: any, include_location?: any}} obj
          * @returns {typeof obj} The same object with inspect() and toString() added.
          */
         function attach(obj: {
             text: string;
-            source_location?: string;
+            source_location?: any;
+            include_location?: any;
         }): typeof obj;
     }
 }
+/** Wrapper stored by MemoryLogger; provides getSeverity/getText/getSourceLocation. */
+export class LogMessage {
+    /**
+     * @param {string} severity - Severity label, e.g. 'ERROR'.
+     * @param {string|{text: string, source_location?: import('./reader.js').Cursor}|null} message
+     */
+    constructor(severity: string, message: string | {
+        text: string;
+        source_location?: import("./reader.js").Cursor;
+    } | null);
+    message: string | {
+        text: string;
+        source_location?: import("./reader.js").Cursor;
+    };
+    /** @type {string} */
+    severity: string;
+    /** @type {string} */
+    text: string;
+    /** @type {import('./reader.js').Cursor|null} */
+    sourceLocation: import("./reader.js").Cursor | null;
+    /**
+     * @returns {string} The severity label, e.g. 'ERROR'.
+     */
+    getSeverity(): string;
+    /**
+     * @returns {string} The message text.
+     */
+    getText(): string;
+    /**
+     * @returns {import('./reader.js').Cursor|undefined} The source location, if any.
+     */
+    getSourceLocation(): import("./reader.js").Cursor | undefined;
+}
 /** In-memory logger that stores all log messages for later inspection. */
 export class MemoryLogger {
     static create(): MemoryLogger;
     level: number;
-    messages: any[];
-    getMessages(): any[];
+    /** @type {LogMessage[]} */
+    messages: LogMessage[];
+    /**
+     * @returns {LogMessage[]} The log messages recorded so far, in order.
+     */
+    getMessages(): LogMessage[];
     getMaxSeverity(): number;
     add(severity: any, message?: any, progname?: any): boolean;
     debug(msg: any, pn: any): boolean;

package/types/reader.d.ts

@@ -123,13 +123,13 @@ export class Reader {
     createLogMessage(text: any, context?: {}): any;
     get logger(): any;
     /** @param {string} msg @param {{ sourceLocation?: any, includeLocation?: any }} [opts] */
-    _logWarn(msg: string, { sourceLocation, includeLocation }?: {
+    _logWarn(msg: string, opts?: {
         sourceLocation?: any;
         includeLocation?: any;
     }): void;
     _logError(msg: any, opts?: {}): void;
     /** @param {string} msg @param {{ sourceLocation?: any }} [opts] */
-    _logInfo(msg: string, { sourceLocation }?: {
+    _logInfo(msg: string, opts?: {
         sourceLocation?: any;
     }): void;
 }

package/types/substitutors.d.ts

@@ -4,9 +4,9 @@ export namespace Substitutors {
      *
      * @param {string|string[]} text - The text to process; must not be null.
      * @param {string[]} [subs=NORMAL_SUBS] - The substitutions to perform.
-     * @returns {string|string[]} Text with substitutions applied.
+     * @returns {Promise<string|string[]>} Text with substitutions applied.
      */
-    function applySubs(text: string | string[], subs?: string[]): string | string[];
+    function applySubs(text: string | string[], subs?: string[]): Promise<string | string[]>;
     /** Apply normal substitutions (alias for applySubs with default args). */
     function applyNormalSubs(text: any): Promise<string | string[]>;
     /** Apply substitutions for header metadata and attribute assignments.
@@ -32,9 +32,9 @@ export namespace Substitutors {
      * Substitute quoted text (emphasis, strong, monospaced, etc.)
      *
      * @param {string} text
-     * @returns {string}
+     * @returns {Promise<string>}
      */
-    function subQuotes(text: string): string;
+    function subQuotes(text: string): Promise<string>;
     /**
      * Substitute attribute references in the specified text.
      *
@@ -54,39 +54,39 @@ export namespace Substitutors {
      * Substitute inline macros (links, images, etc.)
      *
      * @param {string} text
-     * @returns {string}
+     * @returns {Promise<string>}
      */
-    function subMacros(text: string): string;
+    function subMacros(text: string): Promise<string>;
     /**
      * Substitute post replacements (hard line breaks).
      *
      * @param {string} text
-     * @returns {string}
+     * @returns {Promise<string>}
      */
-    function subPostReplacements(text: string): string;
+    function subPostReplacements(text: string): Promise<string>;
     /**
      * Apply verbatim substitutions on source.
      *
      * @param {string} source
      * @param {boolean} processCallouts
-     * @returns {string}
+     * @returns {Promise<string>}
      */
-    function subSource(source: string, processCallouts: boolean): string;
+    function subSource(source: string, processCallouts: boolean): Promise<string>;
     /**
      * Substitute callout source references.
      *
      * @param {string} text
-     * @returns {string}
+     * @returns {Promise<string>}
      */
-    function subCallouts(text: string): string;
+    function subCallouts(text: string): Promise<string>;
     /**
      * Highlight (colorize) the source code using a syntax highlighter.
      *
      * @param {string} source
      * @param {boolean} processCallouts
-     * @returns {string}
+     * @returns {Promise<string>}
      */
-    function highlightSource(source: string, processCallouts: boolean): string;
+    function highlightSource(source: string, processCallouts: boolean): Promise<string>;
     /**
      * Resolve line numbers to highlight from a test string.
      *
@@ -107,9 +107,9 @@ export namespace Substitutors {
      * Restore passthrough text by reinserting into placeholder positions.
      *
      * @param {string} text
-     * @returns {string}
+     * @returns {Promise<string>}
      */
-    function restorePassthroughs(text: string): string;
+    function restorePassthroughs(text: string): Promise<string>;
     /**
      * Resolve the list of comma-delimited subs against the possible options.
      *
@@ -143,9 +143,9 @@ export namespace Substitutors {
      * @param {string} attrlist
      * @param {string[]} [posattrs=[]]
      * @param {Object} [opts={}]
-     * @returns {Object}
+     * @returns {Promise<Object>}
      */
-    function parseAttributes(attrlist: string, posattrs?: string[], opts?: any): any;
+    function parseAttributes(attrlist: string, posattrs?: string[], opts?: any): Promise<any>;
     function extractAttributesFromText(text: any, defaultText?: any): Promise<any[]>;
     function extractCallouts(source: any): any[];
     function restoreCallouts(source: any, calloutMarks: any, sourceOffset?: any): Promise<string>;