chore!: update major version of mdast-utils

lib/from-markdown.test.ts

@@ -1,3 +1,4 @@
+import { test, expect } from 'vitest';
 import { defListFromMarkdown } from './from-markdown';
 import { fromMarkdown } from 'mdast-util-from-markdown';
 import { defList } from 'micromark-extension-definition-list';

lib/md2html.test.ts

@@ -1,3 +1,5 @@
+import { test, expect } from 'vitest';
+
 import { defListHastHandlers } from './to-hast';
 import { defListFromMarkdown } from './from-markdown';
 

lib/md2md.test.ts

@@ -1,3 +1,5 @@
+import { test, expect } from 'vitest';
+
 import { defListFromMarkdown } from './from-markdown';
 import { defListToMarkdown } from './to-markdown';
 
@@ -14,6 +16,8 @@ const md2md = (md: string) => {
   });
   return toMarkdown(mdast, {
     extensions: [defListToMarkdown],
+    fences: false,
+    listItemIndent: 'tab',
   });
 };
 

lib/to-hast.test.ts

@@ -1,14 +1,18 @@
+import { test, expect } from 'vitest';
+
 import { toHast } from 'mdast-util-to-hast';
 import { defListHastHandlers } from './to-hast';
 
-const mdast2hast = (mdast: any) => {
+import type { Root } from 'mdast';
+
+const mdast2hast = (mdast: Root) => {
   return toHast(mdast, {
     handlers: defListHastHandlers,
   });
 };
 
 test('mdast to hast', () => {
-  const mdast = {
+  const mdast: Root = {
     type: 'root',
     children: [
       {

lib/to-hast.ts

@@ -1,9 +1,15 @@
-import { all, Handler } from 'mdast-util-to-hast';
+import type { Handler } from 'mdast-util-to-hast';
+import type { Element } from 'hast';
 import { u } from 'unist-builder';
 import { types } from 'micromark-extension-definition-list';
+import type {
+  DefListNode as MdastDefList,
+  DefListTermNode as MdastDefListTerm,
+  DefListDescriptionNode as MdastDefListDescription,
+} from './types.js';
 
-export const mdastDefList2hast: Handler = (h, node, _parent) => {
-  const items = all(h, node);
+export const mdastDefList2hast: Handler = (state, node: MdastDefList, _parent) => {
+  const items = state.all(node);
   const children = [];
   for (let i = 0; i < items.length; i++) {
     children.push(u('text', '\n'));
@@ -12,16 +18,31 @@ export const mdastDefList2hast: Handler = (h, node, _parent) => {
   if (items.length > 0) {
     children.push(u('text', '\n'));
   }
-  return h(node, 'dl', {}, children);
+
+  const result: Element = { type: 'element', tagName: 'dl', children, properties: {} };
+  state.patch(node, result);
+  return result;
 };
 
-export const mdastDefListTerm2hast: Handler = (h, node, _parent) => {
-  return h(node, 'dt', {}, all(h, node));
+export const mdastDefListTerm2hast: Handler = (state, node: MdastDefListTerm, _parent) => {
+  const result: Element = {
+    type: 'element',
+    tagName: 'dt',
+    properties: {},
+    children: state.all(node),
+  };
+  state.patch(node, result);
+  return result;
 };
 
-export const mdastDefListDescription2hast: Handler = (h, node, _parent) => {
+export const mdastDefListDescription2hast: Handler = (
+  state,
+  node: MdastDefListDescription,
+  _parent,
+) => {
   const children = [];
-  const tmpChildren = all(h, node);
+  const tmpChildren = state.all(node);
+
   for (let i = 0; i < tmpChildren.length; i++) {
     const child = tmpChildren[i];
 
@@ -40,7 +61,9 @@ export const mdastDefListDescription2hast: Handler = (h, node, _parent) => {
     children.push(u('text', '\n'));
   }
 
-  return h(node, 'dd', {}, children);
+  const result: Element = { type: 'element', tagName: 'dd', properties: {}, children };
+  state.patch(node, result);
+  return result;
 };
 
 export const defListHastHandlers = {

lib/to-markdown.test.ts

@@ -1,14 +1,17 @@
+import { test, expect } from 'vitest';
+
 import { defListToMarkdown } from './to-markdown';
 import { toMarkdown } from 'mdast-util-to-markdown';
 import { dedent } from 'ts-dedent';
+import type { Root } from 'mdast';
 
-const compile = (mdast: any) =>
+const compile = (mdast: Root) =>
   toMarkdown(mdast, {
     extensions: [defListToMarkdown],
   });
 
 test('mdast -> markdown: basic', () => {
-  const mdast = {
+  const mdast: Root = {
     type: 'root',
     children: [
       {
@@ -94,7 +97,7 @@ test('mdast -> markdown: basic', () => {
 });
 
 test('mdast -> markdown: multiples items, spreading', () => {
-  const mdast = {
+  const mdast: Root = {
     type: 'root',
     children: [
       {
@@ -195,7 +198,7 @@ test('mdast -> markdown: multiples items, spreading', () => {
 });
 
 test('mdast -> markdown: unsafe (1)', () => {
-  const mdast = {
+  const mdast: Root = {
     type: 'root',
     children: [
       {
@@ -280,7 +283,7 @@ test('mdast -> markdown: unsafe (1)', () => {
 });
 
 test('mdast -> markdown: unsafe (2)', () => {
-  const mdast = {
+  const mdast: Root = {
     type: 'root',
     children: [
       {

lib/to-markdown.ts

@@ -1,4 +1,5 @@
 import type { Handle, Join, Options } from 'mdast-util-to-markdown';
+import type { DefListNode, DefListDescriptionNode, DefListTermNode } from './types.js';
 
 declare module 'mdast-util-to-markdown' {
   interface ConstructNameMap {
@@ -8,23 +9,24 @@ declare module 'mdast-util-to-markdown' {
   }
 }
 
-const defListHandler: Handle = (node, _parent, state, info) => {
+const defListHandler: Handle = (node: DefListNode, _parent, state, info) => {
   const exit = state.enter('defList');
   const value = state.containerFlow(node, info);
   exit();
   return value;
 };
 
-const defListTermHandler: Handle = (node, _parent, state, info) => {
+const defListTermHandler: Handle = (node: DefListTermNode, _parent, state, info) => {
   const exit = state.enter('defListTerm');
   const subexit = state.enter('phrasing');
+  // @ts-ignore -- cannot extend phrasingParents
   const value = state.containerPhrasing(node, { ...info, before: '\n', after: '\n' });
   subexit();
   exit();
   return value;
 };
 
-const defListDescriptionHandler: Handle = (node, _parent, state, info) => {
+const defListDescriptionHandler: Handle = (node: DefListDescriptionNode, _parent, state, info) => {
   const exit = state.enter('defListDescription');
   const value = state.indentLines(state.containerFlow(node, info), map);
   exit();
@@ -43,6 +45,7 @@ const joinDefItems: Join = (left, right, parent, _state) => {
   if (parent.type !== 'defList') {
     return;
   }
+  // @ts-ignore - cannot extend FlowChildren type
   if (left.type === 'defListDescription' && right.type === 'defListTerm') {
     return 1;
   }

lib/types.ts

@@ -22,12 +22,20 @@ export interface DefListDescriptionNode extends Parent {
 }
 
 declare module 'mdast' {
-  // module augmentation
+  interface RootContentMap {
+    deflist: DefListNode;
+    // mdast.RootContent contains all nodes even if they are not suppose to be children of Root.
+    deflistTerm: DefListTermNode;
+    deflistDescription: DefListDescriptionNode;
+  }
+
   interface BlockContentMap {
     deflist: DefListNode;
+    deflistTerm: DefListTermNode;
+    deflistDescription: DefListDescriptionNode;
+  }
 
-    // HACK: these are NOT block contents
-    deflistterm: DefListTermNode;
-    deflistdescription: DefListDescriptionNode;
+  interface PhrasingContentMap {
+    deflistTerm: DefListTermNode;
   }
 }

package.json

@@ -26,28 +26,28 @@
     "index.js"
   ],
   "dependencies": {
-    "@types/mdast": "^3.0.10",
-    "@types/unist": "^2.0.8",
-    "mdast-util-from-markdown": "^1.0.0",
-    "mdast-util-to-hast": "^12.0.0",
-    "mdast-util-to-markdown": "^1.5.0",
-    "micromark-extension-definition-list": "^1.5.0",
-    "unist-builder": "^3.0.0"
+    "@types/mdast": "^4.0.1",
+    "@types/unist": "^3.0.0",
+    "mdast-util-from-markdown": "^2.0.0",
+    "mdast-util-to-hast": "^13.0.2",
+    "mdast-util-to-markdown": "^2.1.0",
+    "micromark-extension-definition-list": "^2.0.0",
+    "unist-builder": "^4.0.0"
   },
   "devDependencies": {
-    "@types/jest": "27.5.2",
+    "@types/hast": "^3.0.1",
     "@typescript-eslint/eslint-plugin": "6.6.0",
     "@typescript-eslint/parser": "6.6.0",
     "eslint": "8.49.0",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-import": "2.28.1",
-    "hast-util-to-html": "8.0.4",
-    "jest": "27.5.1",
+    "hast-util-to-html": "9.0.0",
     "npm-check-updates": "16.10.12",
     "prettier": "3.0.3",
     "rimraf": "5.0.1",
     "ts-dedent": "2.2.0",
-    "typescript": "5.1.3"
+    "typescript": "5.1.3",
+    "vitest": "^0.34.6"
   },
   "keywords": [
     "mdast",
@@ -59,7 +59,8 @@
     "lint": "eslint ./**/*.ts",
     "lint-fix": "eslint --fix ./**/*.ts && prettier --write ./**/*.{ts,json}",
     "typecheck": "tsc",
-    "test": "npm run build && NODE_OPTIONS=--experimental-vm-modules jest 'test\\.js' --testPathIgnorePatterns=\"/node_modules/\"",
+    "test": "vitest run .js",
+    "test:dev": "npm run clean && vitest",
     "build": "npm run clean && tsc",
     "prepack": "npm run build",
     "clean": "rimraf index.js index.test.js lib/*.d.ts lib/*.js"