Refactor code-style

Author: wooorm

lib/handlers/comment.js

@@ -1,8 +1,11 @@
 /**
  * @typedef {import('estree').Comment} Comment
- * @typedef {import('estree-jsx').JSXExpressionContainer} JsxExpressionContainer
+ *
  * @typedef {import('estree-jsx').JSXEmptyExpression} JsxEmptyExpression
+ * @typedef {import('estree-jsx').JSXExpressionContainer} JsxExpressionContainer
+ *
  * @typedef {import('hast').Comment} HastComment
+ *
  * @typedef {import('../state.js').State} State
  */
 

lib/handlers/element.js

@@ -1,9 +1,12 @@
 /**
  * @typedef {import('estree').Property} Property
+ *
+ * @typedef {import('estree-jsx').JSXAttribute} JsxAttribute
  * @typedef {import('estree-jsx').JSXElement} JsxElement
  * @typedef {import('estree-jsx').JSXSpreadAttribute} JsxSpreadAttribute
- * @typedef {import('estree-jsx').JSXAttribute} JsxAttribute
+ *
  * @typedef {import('hast').Element} HastElement
+ *
  * @typedef {import('../state.js').State} State
  */
 
@@ -12,13 +15,9 @@
  */
 
 import {stringify as commas} from 'comma-separated-tokens'
-import {svg, find, hastToReact} from 'property-information'
+import {name as identifierName} from 'estree-util-is-identifier-name'
+import {find, hastToReact, svg} from 'property-information'
 import {stringify as spaces} from 'space-separated-tokens'
-import {
-  start as identifierStart,
-  cont as identifierCont,
-  name as identifierName
-} from 'estree-util-is-identifier-name'
 import styleToObject from 'style-to-object'
 
 const own = {}.hasOwnProperty
@@ -63,10 +62,10 @@ export function element(node, state) {
       // Ignore nullish and `NaN` values.
       // Ignore `false` and falsey known booleans.
       if (
-        value === undefined ||
         value === null ||
-        (typeof value === 'number' && Number.isNaN(value)) ||
+        value === undefined ||
         value === false ||
+        (typeof value === 'number' && Number.isNaN(value)) ||
         (!value && info.boolean)
       ) {
         continue
@@ -125,7 +124,7 @@ export function element(node, state) {
         attributeValue = {type: 'Literal', value: String(value)}
       }
 
-      if (jsxIdentifierName(prop)) {
+      if (identifierName(prop, {jsx: true})) {
         attributes.push({
           type: 'JSXAttribute',
           name: {type: 'JSXIdentifier', name: prop},
@@ -197,6 +196,7 @@ function parseStyle(value, tagName) {
   try {
     styleToObject(value, iterator)
   } catch (error) {
+    // To do: use `cause`.
     const exception = /** @type {Error} */ (error)
     exception.message =
       tagName + '[style]' + exception.message.slice('undefined'.length)
@@ -212,7 +212,7 @@ function parseStyle(value, tagName) {
    *   Key.
    * @param {string} value
    *   Value.
-   * @returns {void}
+   * @returns {undefined}
    *   Nothing.
    */
   function iterator(name, value) {
@@ -277,32 +277,3 @@ function toCamel(_, $1) {
 function toDash($0) {
   return '-' + $0.toLowerCase()
 }
-
-/**
- * Checks if the given string is a valid identifier name.
- *
- * Allows dashes, so it’s actually JSX identifier names.
- *
- * @param {string} name
- *   Whatever.
- * @returns {boolean}
- *   Whether `name` is a valid JSX identifier.
- */
-function jsxIdentifierName(name) {
-  let index = -1
-
-  while (++index < name.length) {
-    if (!(index ? cont : identifierStart)(name.charCodeAt(index))) return false
-  }
-
-  // `false` if `name` is empty.
-  return index > 0
-
-  /**
-   * @param {number} code
-   * @returns {boolean}
-   */
-  function cont(code) {
-    return identifierCont(code) || code === 45 /* `-` */
-  }
-}

lib/handlers/index.js

@@ -3,26 +3,26 @@ import {element} from './element.js'
 import {mdxExpression} from './mdx-expression.js'
 import {mdxJsxElement} from './mdx-jsx-element.js'
 import {mdxjsEsm} from './mdxjs-esm.js'
-import {text} from './text.js'
 import {root} from './root.js'
+import {text} from './text.js'
 
 export const handlers = {
   comment,
   doctype: ignore,
   element,
   mdxFlowExpression: mdxExpression,
-  mdxTextExpression: mdxExpression,
   mdxJsxFlowElement: mdxJsxElement,
   mdxJsxTextElement: mdxJsxElement,
+  mdxTextExpression: mdxExpression,
   mdxjsEsm,
-  text,
-  root
+  root,
+  text
 }
 
 /**
  * Handle a node that is ignored.
  *
- * @returns {void}
+ * @returns {undefined}
  *   Nothing.
  */
 function ignore() {}

lib/handlers/mdx-expression.js

@@ -1,9 +1,12 @@
 /**
- * @typedef {import('mdast-util-mdx-expression').MdxFlowExpressionHast} MdxFlowExpression
- * @typedef {import('mdast-util-mdx-expression').MdxFlowExpressionHast} MdxTextExpression
  * @typedef {import('estree').Expression} Expression
+ *
  * @typedef {import('estree-jsx').JSXEmptyExpression} JsxEmptyExpression
  * @typedef {import('estree-jsx').JSXExpressionContainer} JsxExpressionContainer
+ *
+ * @typedef {import('mdast-util-mdx-expression').MdxFlowExpressionHast} MdxFlowExpression
+ * @typedef {import('mdast-util-mdx-expression').MdxTextExpressionHast} MdxTextExpression
+ *
  * @typedef {import('../state.js').State} State
  */
 

lib/handlers/mdx-jsx-element.js

@@ -1,11 +1,14 @@
 /**
- * @typedef {import('mdast-util-mdx-jsx').MdxJsxFlowElementHast} MdxJsxFlowElement
- * @typedef {import('mdast-util-mdx-jsx').MdxJsxTextElementHast} MdxJsxTextElement
  * @typedef {import('estree').Expression} Expression
+ *
+ * @typedef {import('estree-jsx').JSXAttribute} JsxAttribute
  * @typedef {import('estree-jsx').JSXElement} JsxElement
  * @typedef {import('estree-jsx').JSXFragment} JsxFragment
- * @typedef {import('estree-jsx').JSXAttribute} JsxAttribute
  * @typedef {import('estree-jsx').JSXSpreadAttribute} JsxSpreadAttribute
+ *
+ * @typedef {import('mdast-util-mdx-jsx').MdxJsxFlowElementHast} MdxJsxFlowElement
+ * @typedef {import('mdast-util-mdx-jsx').MdxJsxTextElementHast} MdxJsxTextElement
+ *
  * @typedef {import('../state.js').State} State
  */
 
@@ -49,7 +52,7 @@ export function mdxJsxElement(node, state) {
     let attributeValue
 
     if (attr.type === 'mdxJsxAttribute') {
-      if (value === undefined || value === null) {
+      if (value === null || value === undefined) {
         attributeValue = null
         // Empty.
       }

lib/handlers/mdxjs-esm.js

@@ -1,5 +1,6 @@
 /**
  * @typedef {import('mdast-util-mdxjs-esm').MdxjsEsmHast} MdxjsEsm
+ *
  * @typedef {import('../state.js').State} State
  */
 
@@ -12,7 +13,7 @@ import {attachComments} from 'estree-util-attach-comments'
  *   hast node to transform.
  * @param {State} state
  *   Info passed around about the current state.
- * @returns {void}
+ * @returns {undefined}
  *   Nothing.
  */
 export function mdxjsEsm(node, state) {

lib/handlers/root.js

@@ -1,10 +1,15 @@
 /**
- * @typedef {import('hast').Root} HastRoot
  * @typedef {import('estree-jsx').JSXFragment} JsxFragment
- * @typedef {JsxFragment['children'][number]} JsxChild
+ *
+ * @typedef {import('hast').Root} HastRoot
+ *
  * @typedef {import('../state.js').State} State
  */
 
+/**
+ * @typedef {JsxFragment['children'][number]} JsxChild
+ */
+
 import {whitespace} from 'hast-util-whitespace'
 
 /**

lib/handlers/text.js

@@ -1,7 +1,10 @@
 /**
- * @typedef {import('hast').Text} HastText
  * @typedef {import('estree').Literal} Literal
+ *
  * @typedef {import('estree-jsx').JSXExpressionContainer} JsxExpressionContainer
+ *
+ * @typedef {import('hast').Text} HastText
+ *
  * @typedef {import('../state.js').State} State
  */
 
@@ -15,7 +18,7 @@
  *   hast node to transform.
  * @param {State} state
  *   Info passed around about the current state.
- * @returns {JsxExpressionContainer | void}
+ * @returns {JsxExpressionContainer | undefined}
  *   JSX expression.
  */
 export function text(node, state) {

lib/index.js

@@ -7,11 +7,11 @@
  */
 
 /**
- * @typedef {import('hast').Nodes} HastNodes
- *
  * @typedef {import('estree').ExpressionStatement} ExpressionStatement
  * @typedef {import('estree').Program} Program
  *
+ * @typedef {import('hast').Nodes} HastNodes
+ *
  * @typedef {import('./state.js').Options} Options
  */
 
@@ -49,7 +49,7 @@ import {createState} from './state.js'
  * @param {HastNodes} tree
  *   hast tree.
  * @param {Options | null | undefined} [options]
- *   Configuration.
+ *   Configuration (optional).
  * @returns {Program}
  *   estree program node.
  *
@@ -84,7 +84,7 @@ export function toEstree(tree, options) {
     }
 
     /** @type {ExpressionStatement} */
-    // @ts-expect-error Types are wrong (`expression` *can* be JSX).
+    // @ts-expect-error: `estree` types don’t allow JSX.
     const statement = {type: 'ExpressionStatement', expression: result}
     state.patch(tree, statement)
     body.push(statement)