Add support for passing footnote options

Author: wooorm

.gitignore

@@ -5,3 +5,4 @@
 coverage/
 node_modules/
 yarn.lock
+!/index.d.ts

index.d.ts

@@ -0,0 +1,12 @@
+import type {ToMarkdownOptions as FootnoteOptions} from 'mdast-util-gfm-footnote'
+import type {Options as TableOptions} from 'mdast-util-gfm-table'
+
+/**
+ * Configuration for `gfmToMarkdown` from `mdast-util-gfm`.
+ *
+ * Currently supports options for `mdast-util-gfm-footnote` and
+ * `mdast-util-gfm-table`.
+ */
+export interface Options extends FootnoteOptions, TableOptions {}
+
+export {gfmFromMarkdown, gfmToMarkdown} from './lib/index.js'

index.js

@@ -1,5 +1,2 @@
-/**
- * @typedef {import('./lib/index.js').Options} Options
- */
-
+// Note: types exposed from `index.d.ts`.
 export {gfmFromMarkdown, gfmToMarkdown} from './lib/index.js'

lib/index.js

@@ -1,13 +1,9 @@
 /**
  * @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
+ * @typedef {import('mdast-util-gfm').Options} Options
  * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
  */
 
-/**
- * @typedef {import('mdast-util-gfm-table').Options} Options
- *   Configuration.
- */
-
 import {
   gfmAutolinkLiteralFromMarkdown,
   gfmAutolinkLiteralToMarkdown
@@ -49,7 +45,7 @@ export function gfmFromMarkdown() {
  * literals, footnotes, strikethrough, tables, tasklists).
  *
  * @param {Options | null | undefined} [options]
- *   Configuration.
+ *   Configuration (optional).
  * @returns {ToMarkdownExtension}
  *   Extension for `mdast-util-to-markdown` to enable GFM (autolink literals,
  *   footnotes, strikethrough, tables, tasklists).
@@ -58,7 +54,7 @@ export function gfmToMarkdown(options) {
   return {
     extensions: [
       gfmAutolinkLiteralToMarkdown(),
-      gfmFootnoteToMarkdown(),
+      gfmFootnoteToMarkdown(options),
       gfmStrikethroughToMarkdown(),
       gfmTableToMarkdown(options),
       gfmTaskListItemToMarkdown()

package.json

@@ -90,6 +90,29 @@
   "version": "3.0.0",
   "xo": {
     "overrides": [
+      {
+        "files": [
+          "**/*.d.ts"
+        ],
+        "rules": {
+          "@typescript-eslint/array-type": [
+            "error",
+            {
+              "default": "generic"
+            }
+          ],
+          "@typescript-eslint/ban-types": [
+            "error",
+            {
+              "extendDefaults": true
+            }
+          ],
+          "@typescript-eslint/consistent-type-definitions": [
+            "error",
+            "interface"
+          ]
+        }
+      },
       {
         "files": "test/**/*.js",
         "rules": {

readme.md

@@ -346,13 +346,15 @@ Configuration (TypeScript type).
 
 ###### Fields
 
+* `firstLineBlank` (`boolean`, default: `false`)
+  — use a blank line for the first line of footnote definitions
+* `stringLength` (`((value: string) => number)`, default: `s => s.length`)
+  — function to detect the length of table cell content, used when aligning
+  the delimiters between cells
 * `tableCellPadding` (`boolean`, default: `true`)
   — whether to add a space of padding between delimiters and cells
 * `tablePipeAlign` (`boolean`, default: `true`)
   — whether to align the delimiters
-* `stringLength` (`((value: string) => number)`, default: `s => s.length`)
-  — function to detect the length of table cell content, used when aligning
-  the delimiters between cells
 
 ## HTML
 

test/index.js

@@ -93,3 +93,49 @@ test('markdown -> mdast', async function (t) {
     )
   }
 })
+
+test('mdast -> markdown', async function (t) {
+  await t.test('should support table options', async function () {
+    assert.equal(
+      toMarkdown(
+        {
+          type: 'table',
+          children: [
+            {
+              type: 'tableRow',
+              children: [
+                {type: 'tableCell', children: [{type: 'text', value: 'aaa'}]},
+                {type: 'tableCell', children: [{type: 'text', value: 'b'}]}
+              ]
+            },
+            {
+              type: 'tableRow',
+              children: [
+                {type: 'tableCell', children: [{type: 'text', value: 'c'}]},
+                {type: 'tableCell', children: [{type: 'text', value: 'ddd'}]}
+              ]
+            }
+          ]
+        },
+        {extensions: [gfmToMarkdown({tablePipeAlign: false})]}
+      ),
+      '| aaa | b |\n| - | - |\n| c | ddd |\n'
+    )
+  })
+
+  await t.test('should support footnote options', async function () {
+    assert.equal(
+      toMarkdown(
+        {
+          type: 'footnoteDefinition',
+          identifier: 'a',
+          children: [
+            {type: 'paragraph', children: [{type: 'text', value: 'b'}]}
+          ]
+        },
+        {extensions: [gfmToMarkdown({firstLineBlank: true})]}
+      ),
+      '[^a]:\n    b\n'
+    )
+  })
+})

tsconfig.json

@@ -11,5 +11,5 @@
     "target": "es2022"
   },
   "exclude": ["coverage/", "node_modules/"],
-  "include": ["**/*.js"]
+  "include": ["**/*.js", "index.d.ts"]
 }