Add improved error messages for unclosed JSX

Author: wooorm

index.js

@@ -7,6 +7,7 @@
  * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
  * @typedef {import('mdast-util-to-markdown').Handle} ToMarkdownHandle
  * @typedef {import('mdast-util-to-markdown').Map} ToMarkdownMap
+ * @typedef {import('mdast-util-from-markdown').OnError} OnError
  * @typedef {import('estree-jsx').Program} Program
  * @typedef {import('./complex-types').MdxJsxAttributeValueExpression} MdxJsxAttributeValueExpression
  * @typedef {import('./complex-types').MdxJsxAttribute} MdxJsxAttribute
@@ -310,7 +311,8 @@ function exitMdxJsxTag(token) {
         attributes: tag.attributes,
         children: []
       },
-      token
+      token,
+      onError
     )
   }
 
@@ -321,6 +323,26 @@ function exitMdxJsxTag(token) {
   }
 }
 
+/** @type {OnError} */
+function onError(closing, open) {
+  const tag = /** @type {Tag} */ (this.getData('mdxJsxTag'))
+  const place = closing ? ' before the end of `' + closing.type + '`' : ''
+  const position = closing
+    ? {start: closing.start, end: closing.end}
+    : undefined
+
+  throw new VFileMessage(
+    'Expected a closing tag for `' +
+      serializeAbbreviatedTag(tag) +
+      '` (' +
+      stringifyPosition({start: open.start, end: open.end}) +
+      ')' +
+      place,
+    position,
+    'mdast-util-mdx-jsx:end-tag-mismatch'
+  )
+}
+
 /**
  * Serialize a tag, excluding attributes.
  * `self-closing` is not supported, because we don’t need it yet.
@@ -344,7 +366,7 @@ function mdxElement(node, _, context) {
   const exit = context.enter(node.type)
   let attributeValue = ''
   let index = -1
-  /** @type {Array.<string>} */
+  /** @type {Array<string>} */
   const attributes = []
   /** @type {string} */
   let result

package.json

@@ -49,7 +49,7 @@
     "@types/tape": "^4.0.0",
     "acorn": "^8.0.0",
     "c8": "^7.0.0",
-    "mdast-util-from-markdown": "^1.0.0",
+    "mdast-util-from-markdown": "^1.1.0",
     "micromark-extension-mdx-jsx": "^1.0.0",
     "prettier": "^2.0.0",
     "remark-cli": "^10.0.0",

test.js

@@ -205,7 +205,7 @@ test('markdown -> mdast', (t) => {
         mdastExtensions: [mdxJsxFromMarkdown]
       })
     },
-    /Cannot close `paragraph` \(1:1-1:8\): a different token \(`mdxJsxTextTag`, 1:3-1:6\) is open/,
+    /Expected a closing tag for `<b>` \(1:3-1:6\) before the end of `paragraph`/,
     'should crash on an unclosed text jsx (agnostic)'
   )
 
@@ -216,7 +216,7 @@ test('markdown -> mdast', (t) => {
         mdastExtensions: [mdxJsxFromMarkdown]
       })
     },
-    /Cannot close document, a token \(`mdxJsxFlowTag`, 1:1-1:4\) is still open/,
+    /Expected a closing tag for `<a>` \(1:1-1:4\)/,
     'should crash on an unclosed flow jsx (agnostic)'
   )
 
@@ -1076,7 +1076,7 @@ test('markdown -> mdast', (t) => {
         mdastExtensions: [mdxJsxFromMarkdown]
       })
     },
-    /Cannot close `emphasis` \(1:3-1:19\): a different token \(`mdxJsxTextTag`, 1:9-1:12\) is open/,
+    /Expected a closing tag for `<b>` \(1:9-1:12\) before the end of `emphasis`/,
     'should crash when misnesting w/ attention (emphasis)'
   )
 
@@ -1087,7 +1087,7 @@ test('markdown -> mdast', (t) => {
         mdastExtensions: [mdxJsxFromMarkdown]
       })
     },
-    /Cannot close `strong` \(1:3-1:21\): a different token \(`mdxJsxTextTag`, 1:10-1:13\) is open/,
+    /Expected a closing tag for `<b>` \(1:10-1:13\) before the end of `strong`/,
     'should crash when misnesting w/ attention (strong)'
   )
 
@@ -1098,7 +1098,7 @@ test('markdown -> mdast', (t) => {
         mdastExtensions: [mdxJsxFromMarkdown]
       })
     },
-    /Cannot close `link` \(1:3-1:22\): a different token \(`mdxJsxTextTag`, 1:9-1:12\) is open/,
+    /Expected a closing tag for `<b>` \(1:9-1:12\) before the end of `link`/,
     'should crash when misnesting w/ label (link)'
   )
 
@@ -1109,7 +1109,7 @@ test('markdown -> mdast', (t) => {
         mdastExtensions: [mdxJsxFromMarkdown]
       })
     },
-    /Cannot close `image` \(1:3-1:23\): a different token \(`mdxJsxTextTag`, 1:10-1:13\) is open/,
+    /Expected a closing tag for `<b>` \(1:10-1:13\) before the end of `image`/,
     'should crash when misnesting w/ label (image)'
   )