mdast-util-gfm - npm Package Compare versions

Comparing version 1.0.0 to 2.0.0

index.d.ts

 /**
+ * @returns {Array.<FromMarkdownExtension>}
+ */
+export function gfmFromMarkdown(): Array<FromMarkdownExtension>
+/**
  * @param {Options} [options]
@@ -8,8 +12,4 @@ * @returns {ToMarkdownExtension}
 ): ToMarkdownExtension
-/**
- * @type {Array.<FromMarkdownExtension>}
- */
-export const gfmFromMarkdown: Array<FromMarkdownExtension>
 export type FromMarkdownExtension = import('mdast-util-from-markdown').Extension
 export type ToMarkdownExtension = import('mdast-util-to-markdown').Options
 export type Options = import('mdast-util-gfm-table').Options

index.js

@@ -13,2 +13,6 @@ /**
 import {
+  gfmFootnoteFromMarkdown,
+  gfmFootnoteToMarkdown
+} from 'mdast-util-gfm-footnote'
+import {
   gfmStrikethroughFromMarkdown,
@@ -24,10 +28,13 @@ gfmStrikethroughToMarkdown
 /**
- * @type {Array.<FromMarkdownExtension>}
+ * @returns {Array.<FromMarkdownExtension>}
  */
-export const gfmFromMarkdown = [
-  gfmAutolinkLiteralFromMarkdown,
-  gfmStrikethroughFromMarkdown,
-  gfmTableFromMarkdown,
-  gfmTaskListItemFromMarkdown
-]
+export function gfmFromMarkdown() {
+  return [
+    gfmAutolinkLiteralFromMarkdown,
+    gfmFootnoteFromMarkdown(),
+    gfmStrikethroughFromMarkdown,
+    gfmTableFromMarkdown,
+    gfmTaskListItemFromMarkdown
+  ]
+}
 
@@ -42,2 +49,3 @@ /**
       gfmAutolinkLiteralToMarkdown,
+      gfmFootnoteToMarkdown(),
       gfmStrikethroughToMarkdown,
@@ -44,0 +52,0 @@ gfmTableToMarkdown(options),

package.json

 {
   "name": "mdast-util-gfm",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "mdast extension to parse and serialize GFM (GitHub Flavored Markdown)",
@@ -43,2 +43,3 @@ "license": "MIT",
     "mdast-util-gfm-autolink-literal": "^1.0.0",
+    "mdast-util-gfm-footnote": "^1.0.0",
     "mdast-util-gfm-strikethrough": "^1.0.0",
@@ -56,7 +57,7 @@ "mdast-util-gfm-table": "^1.0.0",
     "mdast-util-to-markdown": "^1.0.0",
-    "micromark-extension-gfm": "^1.0.0",
-    "node-fetch": "^2.0.0",
+    "micromark-extension-gfm": "^2.0.0",
+    "node-fetch": "^3.0.0",
     "prettier": "^2.0.0",
-    "remark-cli": "^9.0.0",
-    "remark-preset-wooorm": "^8.0.0",
+    "remark-cli": "^10.0.0",
+    "remark-preset-wooorm": "^9.0.0",
     "rimraf": "^3.0.0",
@@ -66,3 +67,3 @@ "tape": "^5.0.0",
     "typescript": "^4.0.0",
-    "xo": "^0.39.0"
+    "xo": "^0.45.0"
   },
@@ -69,0 +70,0 @@ "scripts": {

readme.md

@@ -28,2 +28,4 @@ # mdast-util-gfm
     — support GFM autolink literals
+*   [`syntax-tree/mdast-util-gfm-footnote`](https://github.com/syntax-tree/mdast-util-gfm-footnote)
+    — support GFM footnotes
 *   [`syntax-tree/mdast-util-gfm-strikethrough`](https://github.com/syntax-tree/mdast-util-gfm-strikethrough)
@@ -58,2 +60,8 @@ — support GFM strikethrough
 
+## Footnote
+
+A note[^1]
+
+[^1]: Big note.
+
 ## Strikethrough
@@ -87,3 +95,3 @@
   extensions: [gfm()],
-  mdastExtensions: [gfmFromMarkdown]
+  mdastExtensions: [gfmFromMarkdown()]
 })
@@ -136,3 +144,19 @@
     },
+    {type: 'heading', depth: 2, children: [{type: 'text', value: 'Footnote'}]},
     {
+      type: 'paragraph',
+      children: [
+        {type: 'text', value: 'A note'},
+        {type: 'footnoteReference', identifier: '1', label: '1'}
+      ]
+    },
+    {
+      type: 'footnoteDefinition',
+      identifier: '1',
+      label: '1',
+      children: [
+        {type: 'paragraph', children: [{type: 'text', value: 'Big note.'}]}
+      ]
+    },
+    {
       type: 'heading',
@@ -209,2 +233,8 @@ depth: 2,
 
+## Footnote
+
+A note[^1]
+
+[^1]: Big note.
+
 ## Strikethrough
@@ -227,7 +257,7 @@
 
-This package exports the following identifier: `gfmFromMarkdown`,
+This package exports the following identifiers: `gfmFromMarkdown`,
 `gfmToMarkdown`.
 There is no default export.
 
-### `gfmFromMarkdown`
+### `gfmFromMarkdown()`
 
@@ -237,4 +267,4 @@ ### `gfmToMarkdown(options?)`
 Support GFM.
-The exports of `fromMarkdown` is an extension for
-[`mdast-util-from-markdown`][from-markdown].
+The export of `fromMarkdown` is a function that can be called and returns an
+extension for [`mdast-util-from-markdown`][from-markdown].
 The export of `toMarkdown` is a function that can be called with options and
@@ -241,0 +271,0 @@ returns an extension for [`mdast-util-to-markdown`][to-markdown].

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

14778

increased by6.75%

Lines of code

64

increased by14.29%

Number of lines in readme file

354

increased by9.26%

Worsened metrics

Dependency count

5

increased by25%

Dependency changes

• + Addedmdast-util-gfm-footnote@^1.0.0

• + Addedmdast-util-gfm-footnote@1.0.2(transitive)