micromark-util-combine-extensions - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

index.d.ts.map

+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":"AAaA;;;;;;;GAOG;AACH,8CALW,aAAa,CAAC,SAAS,CAAC,GAEtB,mBAAmB,CAa/B;AA+DD;;;;;;;GAOG;AACH,sDALW,aAAa,CAAC,aAAa,CAAC,GAE1B,aAAa,CAazB;+BA1GS,sBAAsB;yCAAtB,sBAAsB;mCAAtB,sBAAsB"}

index.d.ts

 /**
  * Combine multiple syntax extensions into one.
  *
- * @param {Array<Extension>} extensions
+ * @param {ReadonlyArray<Extension>} extensions
  *   List of syntax extensions.
@@ -9,20 +9,15 @@ * @returns {NormalizedExtension}
  */
-export function combineExtensions(
-  extensions: Array<Extension>
-): NormalizedExtension
+export function combineExtensions(extensions: ReadonlyArray<Extension>): NormalizedExtension;
 /**
  * Combine multiple HTML extensions into one.
  *
- * @param {Array<HtmlExtension>} htmlExtensions
+ * @param {ReadonlyArray<HtmlExtension>} htmlExtensions
  *   List of HTML extensions.
  * @returns {HtmlExtension}
- *   A single combined HTML extension.
+ *   Single combined HTML extension.
  */
-export function combineHtmlExtensions(
-  htmlExtensions: Array<HtmlExtension>
-): HtmlExtension
-export type Extension = import('micromark-util-types').Extension
-export type Handles = import('micromark-util-types').Handles
-export type HtmlExtension = import('micromark-util-types').HtmlExtension
-export type NormalizedExtension =
-  import('micromark-util-types').NormalizedExtension
+export function combineHtmlExtensions(htmlExtensions: ReadonlyArray<HtmlExtension>): HtmlExtension;
+import type { Extension } from 'micromark-util-types';
+import type { NormalizedExtension } from 'micromark-util-types';
+import type { HtmlExtension } from 'micromark-util-types';
+//# sourceMappingURL=index.d.ts.map

index.js

 /**
- * @typedef {import('micromark-util-types').Extension} Extension
- * @typedef {import('micromark-util-types').Handles} Handles
- * @typedef {import('micromark-util-types').HtmlExtension} HtmlExtension
- * @typedef {import('micromark-util-types').NormalizedExtension} NormalizedExtension
+ * @import {
+ *   Extension,
+ *   Handles,
+ *   HtmlExtension,
+ *   NormalizedExtension
+ * } from 'micromark-util-types'
  */
@@ -15,3 +17,3 @@
  *
- * @param {Array<Extension>} extensions
+ * @param {ReadonlyArray<Extension>} extensions
  *   List of syntax extensions.
@@ -41,2 +43,3 @@ * @returns {NormalizedExtension}
  * @returns {undefined}
+ *   Nothing.
  */
@@ -75,4 +78,7 @@ function syntaxExtension(all, extension) {
  * @param {Array<unknown>} existing
+ *   List of constructs to merge into.
  * @param {Array<unknown>} list
+ *   List of constructs to merge.
  * @returns {undefined}
+ *   Nothing.
  */
@@ -95,6 +101,6 @@ function constructs(existing, list) {
  *
- * @param {Array<HtmlExtension>} htmlExtensions
+ * @param {ReadonlyArray<HtmlExtension>} htmlExtensions
  *   List of HTML extensions.
  * @returns {HtmlExtension}
- *   A single combined HTML extension.
+ *   Single combined HTML extension.
  */
@@ -121,2 +127,3 @@ export function combineHtmlExtensions(htmlExtensions) {
  * @returns {undefined}
+ *   Nothing.
  */
@@ -123,0 +130,0 @@ function htmlExtension(all, extension) {

package.json

 {
   "name": "micromark-util-combine-extensions",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "micromark utility to combine syntax or html extensions",
@@ -33,2 +33,3 @@ "license": "MIT",
   "files": [
+    "index.d.ts.map",
     "index.d.ts",
@@ -42,3 +43,12 @@ "index.js"
   },
-  "xo": false
+  "xo": {
+    "envs": [
+      "shared-node-browser"
+    ],
+    "prettier": true,
+    "rules": {
+      "guard-for-in": "off",
+      "unicorn/prefer-code-point": "off"
+    }
+  }
 }

readme.md

@@ -15,14 +15,14 @@ # micromark-util-combine-extensions
 
-*   [What is this?](#what-is-this)
-*   [When should I use this?](#when-should-i-use-this)
-*   [Install](#install)
-*   [Use](#use)
-*   [API](#api)
-    *   [`combineExtensions(extensions)`](#combineextensionsextensions)
-    *   [`combineHtmlExtensions(htmlExtensions)`](#combinehtmlextensionshtmlextensions)
-*   [Types](#types)
-*   [Compatibility](#compatibility)
-*   [Security](#security)
-*   [Contribute](#contribute)
-*   [License](#license)
+* [What is this?](#what-is-this)
+* [When should I use this?](#when-should-i-use-this)
+* [Install](#install)
+* [Use](#use)
+* [API](#api)
+  * [`combineExtensions(extensions)`](#combineextensionsextensions)
+  * [`combineHtmlExtensions(htmlExtensions)`](#combinehtmlextensionshtmlextensions)
+* [Types](#types)
+* [Compatibility](#compatibility)
+* [Security](#security)
+* [Contribute](#contribute)
+* [License](#license)
 
@@ -86,4 +86,4 @@ ## What is this?
 
-*   `extensions` (`Array<Extension>`)
-    — list of syntax extensions
+* `extensions` (`Array<Extension>`)
+  — list of syntax extensions
 
@@ -100,4 +100,4 @@ ###### Returns
 
-*   `htmlExtensions` (`Array<HtmlExtension>`)
-    — list of HTML extensions
+* `htmlExtensions` (`Array<HtmlExtension>`)
+  — list of HTML extensions
 
@@ -121,4 +121,4 @@ ###### Returns
 This means we try to keep the current release line,
-`micromark-util-combine-extensions@^2`, compatible with Node.js 16.
-This package works with `micromark@^3`.
+`micromark-util-combine-extensions@2`, compatible with Node.js 16.
+This package works with `micromark@3`.
 
@@ -125,0 +125,0 @@ ## Security

No alert changes

Improved metrics

Total package byte prevSize

12387

13.02%

Number of package files

6

50%

Lines of code

147

0.68%

No dependency changes