Update @types/mdast, mdast utilities

Author: wooorm

lib/index.js

@@ -12,8 +12,8 @@
  *
  * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
  * @typedef {import('mdast-util-to-markdown').Handle} ToMarkdownHandle
- * @typedef {import('mdast-util-to-markdown').Context} ToMarkdownContext
- * @typedef {import('mdast-util-to-markdown').SafeOptions} SafeOptions
+ * @typedef {import('mdast-util-to-markdown').State} State
+ * @typedef {import('mdast-util-to-markdown').Info} Info
  */
 
 /**
@@ -28,12 +28,10 @@
  *   the delimiters between cells
  */
 
-import {containerPhrasing} from 'mdast-util-to-markdown/lib/util/container-phrasing.js'
-import {inlineCode} from 'mdast-util-to-markdown/lib/handle/inline-code.js'
 import {markdownTable} from 'markdown-table'
+import {defaultHandlers} from 'mdast-util-to-markdown'
 
 // To do: next major: use `state` and `state` utilities from `mdast-util-to-markdown`.
-// To do: next major: use `defaultHandlers.inlineCode`.
 // To do: next major: expose functions.
 
 /**
@@ -73,7 +71,7 @@ function enterTable(token) {
     },
     token
   )
-  this.setData('inTable', true)
+  this.data.inTable = true
 }
 
 /**
@@ -82,7 +80,7 @@ function enterTable(token) {
  */
 function exitTable(token) {
   this.exit(token)
-  this.setData('inTable')
+  this.data.inTable = undefined
 }
 
 /**
@@ -118,7 +116,7 @@ function enterCell(token) {
 function exitCodeText(token) {
   let value = this.resume()
 
-  if (this.getData('inTable')) {
+  if (this.data.inTable) {
     value = value.replace(/\\([\\|])/g, replace)
   }
 
@@ -213,7 +211,7 @@ export function gfmTableToMarkdown(options) {
   function handleTableCell(node, _, context, safeOptions) {
     const exit = context.enter('tableCell')
     const subexit = context.enter('phrasing')
-    const value = containerPhrasing(node, context, {
+    const value = context.containerPhrasing(node, {
       ...safeOptions,
       before: around,
       after: around
@@ -241,8 +239,8 @@ export function gfmTableToMarkdown(options) {
 
   /**
    * @param {Table} node
-   * @param {ToMarkdownContext} context
-   * @param {SafeOptions} safeOptions
+   * @param {State} context
+   * @param {Info} safeOptions
    */
   function handleTableAsData(node, context, safeOptions) {
     const children = node.children
@@ -266,8 +264,8 @@ export function gfmTableToMarkdown(options) {
 
   /**
    * @param {TableRow} node
-   * @param {ToMarkdownContext} context
-   * @param {SafeOptions} safeOptions
+   * @param {State} context
+   * @param {Info} safeOptions
    */
   function handleTableRowAsData(node, context, safeOptions) {
     const children = node.children
@@ -298,7 +296,7 @@ export function gfmTableToMarkdown(options) {
    * @param {InlineCode} node
    */
   function inlineCodeWithTable(node, parent, context) {
-    let value = inlineCode(node, parent, context)
+    let value = defaultHandlers.inlineCode(node, parent, context)
 
     if (context.stack.includes('tableCell')) {
       value = value.replace(/\|/g, '\\$&')

package.json

@@ -38,22 +38,22 @@
     "index.js"
   ],
   "dependencies": {
-    "@types/mdast": "^3.0.0",
+    "@types/mdast": "^4.0.0",
     "markdown-table": "^3.0.0",
-    "mdast-util-from-markdown": "^1.0.0",
-    "mdast-util-to-markdown": "^1.3.0"
+    "mdast-util-from-markdown": "^2.0.0",
+    "mdast-util-to-markdown": "^2.0.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",
-    "c8": "^7.0.0",
-    "micromark-extension-gfm-table": "^1.0.0",
+    "c8": "^8.0.0",
+    "micromark-extension-gfm-table": "^2.0.0",
     "prettier": "^2.0.0",
     "remark-cli": "^11.0.0",
     "remark-preset-wooorm": "^9.0.0",
     "string-width": "^6.0.0",
     "type-coverage": "^2.0.0",
     "typescript": "^5.0.0",
-    "unist-util-remove-position": "^4.0.0",
+    "unist-util-remove-position": "^5.0.0",
     "xo": "^0.54.0"
   },
   "scripts": {

test.js

@@ -23,7 +23,7 @@ test('core', () => {
 test('gfmTableFromMarkdown', () => {
   assert.deepEqual(
     fromMarkdown('| a\n| -', {
-      extensions: [gfmTable],
+      extensions: [gfmTable()],
       mdastExtensions: [gfmTableFromMarkdown]
     }),
     {
@@ -76,7 +76,7 @@ test('gfmTableFromMarkdown', () => {
 
   assert.deepEqual(
     fromMarkdown('| a | b | c | d |\n| - | :- | -: | :-: |', {
-      extensions: [gfmTable],
+      extensions: [gfmTable()],
       mdastExtensions: [gfmTableFromMarkdown]
     }),
     {
@@ -178,14 +178,15 @@ test('gfmTableFromMarkdown', () => {
     'should support alignment'
   )
 
+  let tree = fromMarkdown('| `\\|` |\n | --- |', {
+    extensions: [gfmTable()],
+    mdastExtensions: [gfmTableFromMarkdown]
+  })
+
+  removePosition(tree, {force: true})
+
   assert.deepEqual(
-    removePosition(
-      fromMarkdown('| `\\|` |\n | --- |', {
-        extensions: [gfmTable],
-        mdastExtensions: [gfmTableFromMarkdown]
-      }),
-      true
-    ),
+    tree,
     {
       type: 'root',
       children: [
@@ -209,14 +210,15 @@ test('gfmTableFromMarkdown', () => {
     'should support an escaped pipe in code in a table cell'
   )
 
+  tree = fromMarkdown('`\\|`', {
+    extensions: [gfmTable()],
+    mdastExtensions: [gfmTableFromMarkdown]
+  })
+
+  removePosition(tree, {force: true})
+
   assert.deepEqual(
-    removePosition(
-      fromMarkdown('`\\|`', {
-        extensions: [gfmTable],
-        mdastExtensions: [gfmTableFromMarkdown]
-      }),
-      true
-    ),
+    tree,
     {
       type: 'root',
       children: [
@@ -226,14 +228,15 @@ test('gfmTableFromMarkdown', () => {
     'should not support an escaped pipe in code *not* in a table cell'
   )
 
+  tree = fromMarkdown('| `\\\\|`\\\\` b |\n | --- | --- |', {
+    extensions: [gfmTable()],
+    mdastExtensions: [gfmTableFromMarkdown]
+  })
+
+  removePosition(tree, {force: true})
+
   assert.deepEqual(
-    removePosition(
-      fromMarkdown('| `\\\\|`\\\\` b |\n | --- | --- |', {
-        extensions: [gfmTable],
-        mdastExtensions: [gfmTableFromMarkdown]
-      }),
-      true
-    ),
+    tree,
     {
       type: 'root',
       children: [