Refactor code-style

Author: wooorm

lib/element.js

@@ -3,8 +3,8 @@
  * @typedef {import('./index.js').State} State
  */
 
-import {all} from './one.js'
 import {name} from './name.js'
+import {all} from './one.js'
 import {value} from './value.js'
 
 const own = {}.hasOwnProperty

lib/index.js

@@ -4,35 +4,37 @@
  */
 
 /**
- * @typedef {Literal & {type: 'raw'}} Raw
- *   To do: improved `Raw` type?
- *
- * @typedef {'"' | "'"} Quote
- *   XML quotes for attribute values.
- *
  * @typedef Options
  *   Configuration.
  * @property {boolean | null | undefined} [allowDangerousXml=false]
- *   Allow `raw` nodes and insert them as raw XML.
+ *   Allow `raw` nodes and insert them as raw XML (default: `false`).
  *
  *   When `false`, `Raw` nodes are encoded.
  *
  *   > ⚠️ **Danger**: only set this if you completely trust the content.
  * @property {boolean | null | undefined} [closeEmptyElements=false]
  *   Close elements without any content with slash (`/`) on the opening tag
- *   instead of an end tag: `<circle />` instead of `<circle></circle>`.
+ *   instead of an end tag: `<circle />` instead of `<circle></circle>`
+ *   (default: `false`).
  *
  *   See `tightClose` to control whether a space is used before the slash.
  * @property {Quote | null | undefined} [quote='"']
- *   Preferred quote to use.
+ *   Preferred quote to use (default: `'"'`).
  * @property {boolean | null | undefined} [quoteSmart=false]
- *   Use the other quote if that results in less bytes.
+ *   Use the other quote if that results in less bytes (default: `false`).
  * @property {boolean | null | undefined} [tightClose=false]
  *   Do not use an extra space when closing self-closing elements: `<circle/>`
- *   instead of `<circle />`.
+ *   instead of `<circle />` (default: `false`).
  *
  *   > 👉 **Note**: only used if `closeEmptyElements: true`.
  *
+ * @typedef {'"' | "'"} Quote
+ *   XML quotes for attribute values.
+ *
+ * @typedef {Literal & {type: 'raw'}} Raw
+ *   To do: improved `Raw` type?
+ *
+ *
  * @typedef State
  *   Info passed around about the current state.
  * @property {Options} options
@@ -47,7 +49,7 @@ import {one} from './one.js'
  * @param {Array<Nodes> | Nodes} tree
  *   xast node(s) to serialize.
  * @param {Options | null | undefined} [options]
- *   Configuration.
+ *   Configuration (optional).
  * @returns {string}
  *   Serialized XML.
  */

lib/instruction.js

@@ -2,8 +2,8 @@
  * @typedef {import('xast').Instruction} Instruction
  */
 
-import {escape} from './util-escape.js'
 import {name} from './name.js'
+import {escape} from './util-escape.js'
 
 const unsafe = /\?>/g
 const subset = ['>']

lib/one.js

@@ -5,25 +5,25 @@
  * @typedef {import('./index.js').State} State
  */
 
-import {element} from './element.js'
-import {text} from './text.js'
+import {cdata} from './cdata.js'
 import {comment} from './comment.js'
 import {doctype} from './doctype.js'
+import {element} from './element.js'
 import {instruction} from './instruction.js'
-import {cdata} from './cdata.js'
 import {raw} from './raw.js'
+import {text} from './text.js'
 
 const own = {}.hasOwnProperty
 
 const handlers = {
-  root: all,
-  element,
-  text,
+  cdata,
   comment,
   doctype,
+  element,
   instruction,
-  cdata,
-  raw
+  raw,
+  root: all,
+  text
 }
 
 /**

lib/text.js

@@ -10,7 +10,7 @@ const subset = ['&', '<']
 /**
  * Serialize a text.
  *
- * @param {Text | Raw} node
+ * @param {Raw | Text} node
  *   xast text node (or raw).
  * @returns {string}
  *   Serialized XML.

lib/util-escape.js

@@ -1,6 +1,6 @@
 import {stringifyEntitiesLight} from 'stringify-entities'
 
-// eslint-disable-next-line no-control-regex
+// eslint-disable-next-line no-control-regex -- XO is wrong.
 const noncharacter = /[\u0000-\u0008\u000B\u000C\u000E-\u001F]/g
 
 /**
@@ -11,7 +11,7 @@ const noncharacter = /[\u0000-\u0008\u000B\u000C\u000E-\u001F]/g
  * @param {Array<string>} subset
  *   Characters to escape.
  * @param {RegExp | null | undefined} [unsafe]
- *   Regex to scope `subset` to.
+ *   Regex to scope `subset` to (optional).
  * @returns {string}
  *   Escaped string.
  */