Refactor code-style

Author: wooorm

index.js

@@ -28,11 +28,11 @@
  * @typedef {EstreeJsxAttribute['name']} EstreeJsxAttributeName
  * @typedef {EstreeJsxElement['children'][number]} EstreeJsxChild
  *
- * @typedef {import('mdast-util-mdx-jsx').MDXJsxAttributeValueExpression} MDXJsxAttributeValueExpression
- * @typedef {import('mdast-util-mdx-jsx').MDXJsxAttribute} MDXJsxAttribute
- * @typedef {import('mdast-util-mdx-jsx').MDXJsxExpressionAttribute} MDXJsxExpressionAttribute
- * @typedef {import('mdast-util-mdx-jsx').MDXJsxFlowElement} MDXJsxFlowElement
- * @typedef {import('mdast-util-mdx-jsx').MDXJsxTextElement} MDXJsxTextElement
+ * @typedef {import('mdast-util-mdx-jsx').MdxJsxAttributeValueExpression} MDXJsxAttributeValueExpression
+ * @typedef {import('mdast-util-mdx-jsx').MdxJsxAttribute} MDXJsxAttribute
+ * @typedef {import('mdast-util-mdx-jsx').MdxJsxExpressionAttribute} MDXJsxExpressionAttribute
+ * @typedef {import('mdast-util-mdx-jsx').MdxJsxFlowElement} MDXJsxFlowElement
+ * @typedef {import('mdast-util-mdx-jsx').MdxJsxTextElement} MDXJsxTextElement
  *
  * @typedef {import('mdast-util-mdx-expression').MDXFlowExpression} MDXFlowExpression
  * @typedef {import('mdast-util-mdx-expression').MDXTextExpression} MDXTextExpression
@@ -46,12 +46,12 @@
  *
  * @typedef Options
  * @property {Space} [space='html']
- * @property {Object.<string, Handle>} [handlers={}]
+ * @property {Record<string, Handle>} [handlers={}]
  *
  * @typedef Context
  * @property {typeof html} schema
- * @property {Array.<EstreeComment>} comments
- * @property {Array.<EstreeDirective|EstreeStatement|EstreeModuleDeclaration>} esm
+ * @property {Array<EstreeComment>} comments
+ * @property {Array<EstreeDirective|EstreeStatement|EstreeModuleDeclaration>} esm
  * @property {Handle} handle
  */
 
@@ -229,12 +229,12 @@ function element(node, context) {
       }
 
       if (prop === 'style') {
-        /** @type {Object.<string, string>} */
+        /** @type {Record<string, string>} */
         // @ts-expect-error Assume `value` is then an object.
         const styleValue =
           typeof value === 'string' ? parseStyle(value, node.tagName) : value
 
-        /** @type {Array.<EstreeProperty>} */
+        /** @type {Array<EstreeProperty>} */
         const cssProperties = []
         /** @type {string} */
         let cssProp
@@ -506,10 +506,10 @@ function mdxJsxElement(node, context) {
  */
 function root(node, context) {
   const children = all(node, context)
-  /** @type {Array.<EstreeJsxChild>} */
+  /** @type {Array<EstreeJsxChild>} */
   const cleanChildren = []
   let index = -1
-  /** @type {Array.<EstreeJsxChild>|undefined} */
+  /** @type {Array<EstreeJsxChild>|undefined} */
   let queue
 
   // Remove surrounding whitespace nodes from the fragment.
@@ -555,12 +555,12 @@ function text(node) {
 /**
  * @param {Parent|MDXJsxFlowElement|MDXJsxTextElement} parent
  * @param {Context} context
- * @returns {Array.<EstreeJsxChild>}
+ * @returns {Array<EstreeJsxChild>}
  */
 function all(parent, context) {
   const children = parent.children || []
   let index = -1
-  /** @type {Array.<EstreeJsxChild>} */
+  /** @type {Array<EstreeJsxChild>} */
   const results = []
   // Currently, a warning is triggered by react for *any* white space in
   // tables.
@@ -602,7 +602,7 @@ function all(parent, context) {
  */
 function inherit(hast, esnode) {
   const left = hast.data
-  /** @type {Object.<string, unknown>|undefined} */
+  /** @type {Record<string, unknown>|undefined} */
   let right
   /** @type {string} */
   let key
@@ -704,10 +704,10 @@ const createJsxName =
 /**
  * @param {string} value
  * @param {string} tagName
- * @returns {Object.<string, string>}
+ * @returns {Record<string, string>}
  */
 function parseStyle(value, tagName) {
-  /** @type {Object.<string, string>} */
+  /** @type {Record<string, string>} */
   const result = {}
 
   try {

package.json

@@ -69,10 +69,10 @@
     "hast-util-from-parse5": "^7.0.0",
     "hastscript": "^7.0.0",
     "mdast-util-from-markdown": "^1.0.0",
-    "mdast-util-mdx": "^1.0.0",
+    "mdast-util-mdx": "^2.0.0",
     "mdast-util-to-hast": "^12.0.0",
     "micromark-extension-mdxjs": "^1.0.0",
-    "parse5": "^6.0.0",
+    "parse5": "^7.0.0",
     "prettier": "^2.0.0",
     "recast": "^0.21.0",
     "remark-cli": "^10.0.0",

test.js

@@ -20,7 +20,7 @@ import {fromMarkdown} from 'mdast-util-from-markdown'
 import {toHast} from 'mdast-util-to-hast'
 import {mdxFromMarkdown} from 'mdast-util-mdx'
 import {mdxjs} from 'micromark-extension-mdxjs'
-import parse5 from 'parse5'
+import * as parse5 from 'parse5'
 import recast from 'recast'
 import {visit} from 'unist-util-visit'
 import {toEstree} from './index.js'
@@ -41,7 +41,7 @@ const passThrough = [
 test('hast-util-to-estree', (t) => {
   t.throws(
     () => {
-      // @ts-expect-error runtime.
+      // @ts-expect-error: runtime.
       toEstree({})
     },
     /Cannot handle value `\[object Object]`/,
@@ -285,7 +285,7 @@ test('hast-util-to-estree', (t) => {
       tagName: 'a',
       properties: {
         style: {
-          // @ts-expect-error: runtime.
+          // @ts-expect-error: incorrect hast.
           WebkitBoxShadow: '0 0 1px 0 tomato',
           msBoxShadow: '0 0 1px 0 tomato',
           boxShadow: '0 0 1px 0 tomato'
@@ -507,7 +507,7 @@ test('hast-util-to-estree', (t) => {
     toEstree(
       {
         type: 'root',
-        // @ts-expect-error: runtime.
+        // @ts-expect-error: custom node.
         children: [{type: 'array', value: 'comma,seperated,array'}]
       },
       {
@@ -910,14 +910,15 @@ test('integration (micromark-extension-mdxjs, mdast-util-mdx)', (t) => {
   function transform(doc, clean) {
     const mdast = fromMarkdown(doc, {
       extensions: [mdxjs()],
-      mdastExtensions: [mdxFromMarkdown]
+      mdastExtensions: [mdxFromMarkdown()]
     })
 
     const hast = toHast(mdast, {passThrough})
 
+    // @ts-expect-error: hush.
     if (clean && hast) visit(hast, passThrough, acornClean)
 
-    // @ts-expect-error: update.
+    // @ts-expect-error: it’s a node.
     return recastSerialize(toEstree(hast))
 
     /**
@@ -1053,7 +1054,7 @@ test('integration (@babel/plugin-transform-react-jsx, react)', (t) => {
   function transform(doc, transformReactOptions) {
     const mdast = fromMarkdown(doc, {
       extensions: [mdxjs()],
-      mdastExtensions: [mdxFromMarkdown]
+      mdastExtensions: [mdxFromMarkdown()]
     })
 
     const hast = toHast(mdast, {passThrough})
@@ -1145,7 +1146,7 @@ test('integration (@vue/babel-plugin-jsx, Vue 3)', (t) => {
   function transform(doc) {
     const mdast = fromMarkdown(doc, {
       extensions: [mdxjs()],
-      mdastExtensions: [mdxFromMarkdown]
+      mdastExtensions: [mdxFromMarkdown()]
     })
 
     const hast = toHast(mdast, {passThrough})
@@ -1194,7 +1195,7 @@ function acornClean(node) {
  * @returns {Program}
  */
 function acornParse(doc) {
-  /** @type {Array.<Comment>} */
+  /** @type {Array<Comment>} */
   const comments = []
   const tree = Parser.extend(jsx()).parse(doc, {
     // @ts-expect-error Acorn.
@@ -1211,7 +1212,7 @@ function acornParse(doc) {
  * @param {Program} tree
  */
 function recastSerialize(tree) {
-  /** @type {Array.<Comment>} */
+  /** @type {Array<Comment>} */
   tree.comments = undefined
   return recast.prettyPrint(tree).code
 }