asciidoctor 2.2.4-rc.1 → 2.2.6

package/README.md

@@ -47,13 +47,13 @@ In the spirit of [free software](https://www.gnu.org/philosophy/free-sw.html), _
 If you discover errors or omissions in the source code, documentation, or website content, please don't hesitate to submit an issue or open a pull request with a fix.
 New contributors are always welcome!
 
-The [Contributing](https://github.com/asciidoctor/asciidoctor.js/blob/master/CONTRIBUTING.adoc) guide provides information on how to contribute.
+The [Contributing](https://github.com/asciidoctor/asciidoctor.js/blob/main/CONTRIBUTING.adoc) guide provides information on how to contribute.
 
-If you want to write code, the [Contributing Code](https://github.com/asciidoctor/asciidoctor.js/blob/master/CONTRIBUTING-CODE.adoc) guide will help you to get started quickly.
+If you want to write code, the [Contributing Code](https://github.com/asciidoctor/asciidoctor.js/blob/main/CONTRIBUTING-CODE.adoc) guide will help you to get started quickly.
 
 ## Copyright
 
 Copyright (C) 2019 Dan Allen, Guillaume Grossetie, Anthonny Quérouil and the Asciidoctor Project.
 Free use of this software is granted under the terms of the MIT License.
 
-See the [LICENSE](https://github.com/asciidoctor/asciidoctor.js/blob/master/LICENSE) file for details.
+See the [LICENSE](https://github.com/asciidoctor/asciidoctor.js/blob/main/LICENSE) file for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "asciidoctor",
-  "version": "2.2.4-rc.1",
+  "version": "2.2.6",
   "description": "A JavaScript AsciiDoc processor, cross-compiled from the Ruby-based AsciiDoc implementation, Asciidoctor, using Opal",
   "main": "index.js",
   "types": "types",
@@ -46,10 +46,10 @@
   },
   "homepage": "https://github.com/asciidoctor/asciidoctor.js",
   "dependencies": {
-    "@asciidoctor/cli": "3.4.0",
-    "@asciidoctor/core": "2.2.4-rc.1"
+    "@asciidoctor/cli": "3.5.0",
+    "@asciidoctor/core": "2.2.6"
   },
   "devDependencies": {
-    "pkg": "^4.4.7"
+    "pkg": "5.2.1"
   }
 }

package/types/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-// TypeScript Version: 2.9
+// TypeScript Version: 3.7
 export namespace Asciidoctor {
   import Author = Document.Author;
   import Title = Document.Title;
@@ -439,7 +439,7 @@ export namespace Asciidoctor {
      * @param to - an optional output (by default stdout)
      * @param subject - an optional subject (usually the file name)
      */
-    printReport(to: undefined | Writer | BasicLogger | RubyLogger, subject: string): void;
+    printReport(to?: Writer | BasicLogger | RubyLogger, subject?: string): void;
   }
 
   namespace Document {
@@ -1958,7 +1958,7 @@ export namespace Asciidoctor {
     /**
      * Get the {Converter} instance being used to convert the current {Document}.
      */
-    getConverter(): object;
+    getConverter(): AbstractConverter;
 
     /**
      * Get the activated {Extensions.Registry} associated with this document.
@@ -2006,7 +2006,7 @@ export namespace Asciidoctor {
      *
      * If a caption has already been assigned to this block, do nothing.
      *
-     * The parts of a complete caption are: <prefix> <number>. <title>
+     * The parts of a complete caption are: `<prefix> <number>. <title>`
      * This partial caption represents the part the precedes the title.
      *
      * @param value - the String caption to assign to this block or nil to use document attribute.
@@ -2272,7 +2272,7 @@ export namespace Asciidoctor {
      * Create a new Inline element.
      * @returns a new Inline element
      */
-    static create(parent: AbstractBlock, context: string, text?: string, opts?: any): Inline;
+    static create(parent: AbstractBlock, context: string, text?: string, opts?: Record<string, unknown>): Inline;
 
     /**
      * Get the converted content for this inline node.
@@ -2670,21 +2670,21 @@ export namespace Asciidoctor {
      *
      * @returns An Array of Strings representing the substitution operation or nothing if no subs are found.
      */
-    resolveSubstitutions(subs: string, type?: string, defaults?: string[], subject?: string): string[] | void;
+    resolveSubstitutions(subs: string, type?: string, defaults?: string[], subject?: string): string[] | undefined;
 
     /**
      * Call {@link AbstractNode#resolveSubstitutions} for the 'block' type.
      *
      * @see {@link AbstractNode#resolveSubstitutions}
      */
-    resolveBlockSubstitutions(subs: string, defaults?: string[], subject?: string): string[] | void;
+    resolveBlockSubstitutions(subs: string, defaults?: string[], subject?: string): string[] | undefined;
 
     /**
      * Call {@link AbstractNode#resolveSubstitutions} for the 'inline' type with the subject set as passthrough macro.
      *
      * @see {@link AbstractNode#resolveSubstitutions}
      */
-    resolvePassSubstitutions(subs: string): string[] | void;
+    resolvePassSubstitutions(subs: string): string[] | undefined;
 
     /**
      * Apply the specified substitutions to the text.
@@ -2744,7 +2744,7 @@ export namespace Asciidoctor {
      *
      * @returns a Boolean indicating whether the attribute exists and, if a truthy comparison value is specified, whether the value of the attribute matches the comparison value.
      */
-    isAttribute(name: string, expectedValue?: any, fallbackName?: string): void;
+    isAttribute(name: string, expectedValue?: any, fallbackName?: string): boolean;
 
     /**
      * Assign the value to the attribute name for the current node.
@@ -3053,7 +3053,26 @@ export namespace Asciidoctor {
     function create(): Html5Converter;
   }
 
-  class Converter {
+  interface AbstractConverter {
+    /**
+     * Converts an {AbstractNode} using the given transform.
+     * This method must be implemented by a concrete converter class.
+     *
+     * @param node - The concrete instance of AbstractNode to convert.
+     * @param [transform] - An optional String transform that hints at which transformation should be applied to this node.
+     * If a transform is not given, the transform is often derived from the value of the {AbstractNode#getNodeName} property. (optional, default: undefined)
+     * @param [opts]- An optional JSON of options hints about how to convert the node. (optional, default: undefined)
+     *
+     * @returns the {String} result.
+     */
+    convert(node: AbstractNode, transform?: string, opts?: unknown): string;
+  }
+
+  interface ConverterConstructor {
+    new(backend?: string, opts?: unknown): AbstractConverter;
+  }
+
+  class Converter implements AbstractConverter {
     /**
      * Converts an {AbstractNode} using the given transform.
      * This method must be implemented by a concrete converter class.
@@ -3082,7 +3101,7 @@ export namespace Asciidoctor {
      * @param opts - a JSON of options to pass to the converter (default: {})
      * @returns a {Converter} instance for converting nodes in an Asciidoctor AST.
      */
-    function create(backend: string, opts?: any): Converter;
+    function create(backend: string, opts?: unknown): Converter;
   }
 
   /**
@@ -3100,7 +3119,7 @@ export namespace Asciidoctor {
      * @param converter - The {Converter} instance to register
      * @param backends- A {string} {Array} of backend names that this converter should be registered to handle (optional, default: ['*'])
      */
-    register(converter: any, backends?: string[]): void;
+    register(converter: AbstractConverter | ConverterConstructor, backends?: string[]): void;
 
     /**
      * Retrieves the singleton instance of the converter factory.