@asciidoctor/core 2.2.4-rc.1 → 2.2.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asciidoctor/core",
-  "version": "2.2.4-rc.1",
+  "version": "2.2.6",
   "description": "Asciidoctor - the core library",
   "main": "dist/node/asciidoctor.js",
   "browser": "dist/browser/asciidoctor.js",
@@ -20,7 +20,7 @@
     "test:graalvm": "node tasks/graalvm.js",
     "test:node": "mocha spec/*/*.spec.js",
     "test:browser": "node spec/browser/run.js",
-    "test:types": "rm -f types/tests.js && dtslint types && tsc --build types/tsconfig.json && node types/tests.js",
+    "test:types": "rm -f types/tests.js && eslint types --ext .ts && tsc --build types/tsconfig.json && node types/tests.js",
     "test": "node tasks/test/unsupported-features.js && npm run test:node && npm run test:browser && npm run test:types",
     "build": "node tasks/build.js && npm run test && npm run lint",
     "build:quick": "node tasks/build.js && npm run test:node && npm run code:lint",
@@ -31,7 +31,7 @@
     "clean:js": "node tasks/clean.js js",
     "dist": "cross-env MINIFY=1 node tasks/dist.js",
     "lint": "npm run code:lint && npm run docs:lint",
-    "code:lint": "standard src/**/*.js spec/**/*.js tasks/**/*.js benchmark/**/*.js",
+    "code:lint": "eslint 'src/**/*.js' 'spec/**/*.js' 'spec/**/*.js' 'tasks/**/*.js' 'benchmark/**/*.js'",
     "package": "cross-env MINIFY=1 COPY_DIST=1 node tasks/build.js && cross-env MINIFY=1 npm run test",
     "examples": "node tasks/examples.js",
     "server": "node tasks/server.js",
@@ -71,36 +71,33 @@
     "unxhr": "1.0.1"
   },
   "devDependencies": {
-    "@types/node": "^13.9.2",
-    "@types/nunjucks": "^3.1.3",
+    "@types/node": "17.0.10",
+    "@types/nunjucks": "3.2.1",
+    "@typescript-eslint/eslint-plugin": "5.9.1",
+    "@typescript-eslint/parser": "5.9.1",
     "bestikk-download": "1.0.0",
     "bestikk-fs": "1.0.0",
     "bestikk-log": "0.1.0",
     "bestikk-uglify": "3.0.0",
-    "chai": "4.2.0",
-    "cross-env": "6.0.3",
+    "chai": "4.3.4",
+    "cross-env": "7.0.3",
     "dirty-chai": "2.0.1",
-    "documentation": "12.3.0",
-    "dot": "^1.1.3",
-    "dtslint": "latest",
-    "ejs": "^3.0.1",
-    "eslint": "6.8.0",
-    "handlebars": "^4.7.6",
-    "http-server": "0.12.3",
-    "mocha": "7.1.2",
+    "documentation": "13.2.5",
+    "dot": "1.1.3",
+    "ejs": "3.1.6",
+    "eslint": "8.7.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.25.4",
+    "handlebars": "4.7.7",
+    "http-server": "14.1.0",
+    "mocha": "9.1.4",
     "module-alias": "2.2.2",
-    "nunjucks": "^3.2.1",
+    "nunjucks": "3.2.3",
     "opal-compiler": "1.0.13",
-    "pug": "^2.0.4",
-    "puppeteer": "3.1.0",
-    "sinon": "8.1.1",
-    "standard": "14.3.4",
-    "typescript": "^4.1.2"
-  },
-  "standard": {
-    "ignore": [
-      "src/template-*.js"
-    ]
+    "pug": "3.0.2",
+    "puppeteer": "13.1.1",
+    "sinon": "12.0.1",
+    "typescript": "4.5.4"
   },
   "_moduleAliases": {
     "@asciidoctor/core": "build/asciidoctor-node.js"

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.