micromark-extension-gfm - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

package.json

 {
   "name": "micromark-extension-gfm",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "micromark extension to support GFM (GitHub Flavored Markdown)",
@@ -52,2 +52,3 @@ "license": "MIT",
     "c8": "^7.0.0",
+    "create-gfm-fixtures": "^1.0.0",
     "hast-util-select": "^5.0.0",
@@ -58,3 +59,5 @@ "hast-util-to-text": "^3.0.0",
     "prettier": "^2.0.0",
+    "rehype": "^12.0.0",
     "rehype-parse": "^8.0.0",
+    "rehype-sort-attributes": "^4.0.0",
     "remark-cli": "^10.0.0",
@@ -67,3 +70,3 @@ "remark-preset-wooorm": "^9.0.0",
     "unified": "^10.0.0",
-    "xo": "^0.45.0"
+    "xo": "^0.47.0"
   },
@@ -86,3 +89,13 @@ "scripts": {
   "xo": {
-    "prettier": true
+    "prettier": true,
+    "overrides": [
+      {
+        "files": [
+          "{test,script}/**/*.js"
+        ],
+        "rules": {
+          "no-await-in-loop": "off"
+        }
+      }
+    ]
   },
@@ -89,0 +102,0 @@ "remarkConfig": {

readme.md

@@ -11,36 +11,56 @@ # micromark-extension-gfm
 
-**[micromark][]** extension to support GitHub flavored markdown.
-This extension matches either the [GFM][] spec or github.com (default).
+**[micromark][]** extension to support GitHub flavored markdown ([GFM][]).
 
-This package provides the low-level modules for integrating with the micromark
-tokenizer and the micromark HTML compiler.
+## Contents
 
+*   [What is this?](#what-is-this)
+*   [When to use this](#when-to-use-this)
+*   [Install](#install)
+*   [Use](#use)
+*   [API](#api)
+    *   [`gfm(options?)`](#gfmoptions)
+    *   [`gfmHtml(htmlOptions?)`](#gfmhtmlhtmloptions)
+*   [Types](#types)
+*   [Compatibility](#compatibility)
+*   [Security](#security)
+*   [Related](#related)
+*   [Contribute](#contribute)
+*   [License](#license)
+
+## What is this?
+
+This package is a micromark extension to add support for all GFM features:
+autolink literals, footnotes, strikethrough, tables, tagfilter, and tasklists.
+
 ## When to use this
 
-If you’re using [`micromark`][micromark] or
-[`mdast-util-from-markdown`][from-markdown], use this package.
-Alternatively, if you’re using **[remark][]**, use [`remark-gfm`][remark-gfm].
+You probably should use this package if you use micromark and want to enable
+GFM.
+When working with syntax trees, you’d want to combine this package with
+[`mdast-util-gfm`][mdast-util-gfm].
 
-If you don’t need all of GFM, the extensions can be used separately:
+You can also use the underlying features separately:
 
-*   [`micromark/micromark-extension-gfm-autolink-literal`](https://github.com/micromark/micromark-extension-gfm-autolink-literal)
+*   [`micromark/micromark-extension-gfm-autolink-literal`][gfm-autolink-literal]
     — support GFM [autolink literals][]
-*   [`micromark/micromark-extension-gfm-footnote`](https://github.com/micromark/micromark-extension-gfm-footnote)
+*   [`micromark/micromark-extension-gfm-footnote`][gfm-footnote]
     — support GFM footnotes
-*   [`micromark/micromark-extension-gfm-strikethrough`](https://github.com/micromark/micromark-extension-gfm-strikethrough)
+*   [`micromark/micromark-extension-gfm-strikethrough`][gfm-strikethrough]
     — support GFM [strikethrough][]
-*   [`micromark/micromark-extension-gfm-table`](https://github.com/micromark/micromark-extension-gfm-table)
+*   [`micromark/micromark-extension-gfm-table`][gfm-table]
     — support GFM [tables][]
-*   [`micromark/micromark-extension-gfm-tagfilter`](https://github.com/micromark/micromark-extension-gfm-tagfilter)
+*   [`micromark/micromark-extension-gfm-tagfilter`][gfm-tagfilter]
     — support GFM [tagfilter][]
-*   [`micromark/micromark-extension-gfm-task-list-item`](https://github.com/micromark/micromark-extension-gfm-task-list-item)
+*   [`micromark/micromark-extension-gfm-task-list-item`][gfm-task-list-item]
     — support GFM [tasklists][]
 
+These tools are all rather low-level.
+In most cases, you’d instead want to use [`remark-gfm`][remark-gfm] with
+[remark][].
+
 ## Install
 
-This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):
-Node 12+ is needed to use it and it must be `import`ed instead of `require`d.
+This package is [ESM only][esm].
+In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]:
 
-[npm][]:
-
 ```sh
@@ -50,5 +70,19 @@ npm install micromark-extension-gfm
 
+In Deno with [Skypack][]:
+
+```js
+import {gfm, gfmHtml} from 'https://cdn.skypack.dev/micromark-extension-gfm@2?dts'
+```
+
+In browsers with [Skypack][]:
+
+```html
+<script type="module">
+  import {gfm, gfmHtml} from 'https://cdn.skypack.dev/micromark-extension-gfm@2?min'
+</script>
+```
+
 ## Use
 
-Say we have the following file, `example.md`:
+Say we have the following file `example.md`:
 
@@ -87,3 +121,3 @@ ```markdown
 
-And our module, `example.js`, looks as follows:
+And our module `example.js` looks as follows:
 
@@ -129,4 +163,4 @@ ```js
 <ul>
-<li><input disabled="" type="checkbox"> to do</li>
-<li><input checked="" disabled="" type="checkbox"> done</li>
+<li><input type="checkbox" disabled="" /> to do</li>
+<li><input type="checkbox" disabled="" checked="" /> done</li>
 </ul>
@@ -147,42 +181,85 @@ <section data-footnotes="" class="footnotes"><h2 id="footnote-label" class="sr-only">Footnotes</h2>
 
+This extensions supports the endorsed [`development` condition][dev].
+Run `node --conditions development module.js` to get instrumented dev code.
+Without this condition, production code is loaded.
+
 ### `gfm(options?)`
 
-### `gfmHtml`
+A function that can be called to get an extension for micromark to parse GFM
+(can be passed in `extensions`).
 
-Support [GFM][] or markdown on github.com.
-`gfm` is a function that can be called with options and returns an extension for
-micromark to parse GFM (can be passed in `extensions`).
-`gfmHtml` is a function that can be called and returns an extension for
-micromark to compile as elements (can be passed in `htmlExtensions`).
-
 ##### `options`
 
+Configuration (optional).
+
 ###### `options.singleTilde`
 
+Whether to support strikethrough with a single tilde (`boolean`, default:
+`true`).
+Single tildes work on github.com, but are technically prohibited by GFM.
 Passed as [`singleTilde`][single-tilde] in
-[`micromark-extension-gfm-strikethrough`][mm-strikethrough].
+[`micromark-extension-gfm-strikethrough`][gfm-strikethrough].
 
+### `gfmHtml(htmlOptions?)`
+
+A function that can be called to get an extension to compile GFM to HTML (can be
+passed in `htmlExtensions`).
+
+##### `htmlOptions`
+
+Configuration (optional).
+
+###### `htmlOptions.clobberPrefix`
+
+Prefix to use before the `id` attribute to prevent it from *clobbering*
+attributes (`string`, default: `'user-content-'`).
+Passed as [`clobberPrefix`][clobber-prefix] in
+[`micromark-extension-gfm-footnote`][gfm-footnote].
+
+###### `htmlOptions.label`
+
+Label to use for the footnotes section (`string`, default: `'Footnotes'`).
+Passed as [`label`][label] in
+[`micromark-extension-gfm-footnote`][gfm-footnote].
+
+###### `htmlOptions.backLabel`
+
+Label to use from backreferences back to their footnote call (`string`, default:
+`'Back to content'`).
+Passed as [`backLabel`][backlabel] in
+[`micromark-extension-gfm-footnote`][gfm-footnote].
+
+## Types
+
+This package is fully typed with [TypeScript][].
+It exports additional `Options` and `HtmlOptions` types that model their
+respective interfaces.
+
+## Compatibility
+
+This package is at least compatible with all maintained versions of Node.js.
+As of now, that is Node.js 12.20+, 14.14+, and 16.0+.
+It also works in Deno and modern browsers.
+
+## Security
+
+This package is safe by default.
+
 ## Related
 
-*   [`remarkjs/remark`][remark]
-    — markdown processor powered by plugins
-*   [`syntax-tree/mdast-util-gfm`](https://github.com/syntax-tree/mdast-util-gfm)
-    — mdast utility to support GFM
-*   [`syntax-tree/mdast-util-from-markdown`][from-markdown]
-    — mdast parser using `micromark` to create mdast from markdown
-*   [`syntax-tree/mdast-util-to-markdown`][to-markdown]
-    — mdast serializer to create markdown from mdast
-*   [`micromark/micromark`][micromark]
-    — the smallest commonmark-compliant markdown parser that exists
-*   [`micromark/micromark-extension-gfm-autolink-literal`](https://github.com/micromark/micromark-extension-gfm-autolink-literal)
+*   [`syntax-tree/mdast-util-gfm`][mdast-util-gfm]
+    — support GFM in mdast
+*   [`remarkjs/remark-gfm`][remark-gfm]
+    — support GFM in remark
+*   [`micromark/micromark-extension-gfm-autolink-literal`][gfm-autolink-literal]
     — support GFM [autolink literals][]
-*   [`micromark/micromark-extension-gfm-footnote`](https://github.com/micromark/micromark-extension-gfm-footnote)
+*   [`micromark/micromark-extension-gfm-footnote`][gfm-footnote]
     — support GFM footnotes
-*   [`micromark/micromark-extension-gfm-strikethrough`](https://github.com/micromark/micromark-extension-gfm-strikethrough)
+*   [`micromark/micromark-extension-gfm-strikethrough`][gfm-strikethrough]
     — support GFM [strikethrough][]
-*   [`micromark/micromark-extension-gfm-table`](https://github.com/micromark/micromark-extension-gfm-table)
+*   [`micromark/micromark-extension-gfm-table`][gfm-table]
     — support GFM [tables][]
-*   [`micromark/micromark-extension-gfm-tagfilter`](https://github.com/micromark/micromark-extension-gfm-tagfilter)
+*   [`micromark/micromark-extension-gfm-tagfilter`][gfm-tagfilter]
     — support GFM [tagfilter][]
-*   [`micromark/micromark-extension-gfm-task-list-item`](https://github.com/micromark/micromark-extension-gfm-task-list-item)
+*   [`micromark/micromark-extension-gfm-task-list-item`][gfm-task-list-item]
     — support GFM [tasklists][]
@@ -234,2 +311,4 @@
 
+[skypack]: https://www.skypack.dev
+
 [license]: license
@@ -245,8 +324,10 @@
 
-[micromark]: https://github.com/micromark/micromark
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
 
-[from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown
+[dev]: https://nodejs.org/api/packages.html#packages_resolving_user_conditions
 
-[to-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown
+[typescript]: https://www.typescriptlang.org
 
+[micromark]: https://github.com/micromark/micromark
+
 [remark]: https://github.com/remarkjs/remark
@@ -270,2 +351,20 @@
 
-[mm-strikethrough]: https://github.com/micromark/micromark-extension-gfm-strikethrough
+[clobber-prefix]: https://github.com/micromark/micromark-extension-gfm-footnote#htmloptionsclobberprefix
+
+[label]: https://github.com/micromark/micromark-extension-gfm-footnote#htmloptionslabel
+
+[backlabel]: https://github.com/micromark/micromark-extension-gfm-footnote#htmloptionsbacklabel
+
+[gfm-strikethrough]: https://github.com/micromark/micromark-extension-gfm-strikethrough
+
+[gfm-autolink-literal]: https://github.com/micromark/micromark-extension-gfm-autolink-literal
+
+[gfm-footnote]: https://github.com/micromark/micromark-extension-gfm-footnote
+
+[gfm-table]: https://github.com/micromark/micromark-extension-gfm-table
+
+[gfm-tagfilter]: https://github.com/micromark/micromark-extension-gfm-tagfilter
+
+[gfm-task-list-item]: https://github.com/micromark/micromark-extension-gfm-task-list-item
+
+[mdast-util-gfm]: https://github.com/syntax-tree/mdast-util-gfm

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

16865

increased by15.55%

Number of lines in readme file

363

increased by37.5%

Worsened metrics

Dev dependency count

20

increased by17.65%

No dependency changes