Refactor code-style

Author: wooorm

index.d.ts

@@ -4,7 +4,6 @@ export {gfmTableFromMarkdown, gfmTableToMarkdown} from './lib/index.js'
 
 // Add custom data tracked to turn markdown into a tree.
 declare module 'mdast-util-from-markdown' {
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
   interface CompileData {
     /**
      * Whether we’re currently in a table.
@@ -15,7 +14,6 @@ declare module 'mdast-util-from-markdown' {
 
 // Add custom data tracked to turn a syntax tree into markdown.
 declare module 'mdast-util-to-markdown' {
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
   interface ConstructNameMap {
     /**
      * Whole table.

lib/index.js

@@ -1,10 +1,10 @@
 /**
+ * @typedef {import('mdast').InlineCode} InlineCode
  * @typedef {import('mdast').Table} Table
- * @typedef {import('mdast').TableRow} TableRow
  * @typedef {import('mdast').TableCell} TableCell
- * @typedef {import('mdast').InlineCode} InlineCode
+ * @typedef {import('mdast').TableRow} TableRow
  *
- * @typedef {import('markdown-table').MarkdownTableOptions} MarkdownTableOptions
+ * @typedef {import('markdown-table').Options} MarkdownTableOptions
  *
  * @typedef {import('mdast-util-from-markdown').CompileContext} CompileContext
  * @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
@@ -20,18 +20,19 @@
  * @typedef Options
  *   Configuration.
  * @property {boolean | null | undefined} [tableCellPadding=true]
- *   Whether to add a space of padding between delimiters and cells.
+ *   Whether to add a space of padding between delimiters and cells (default:
+ *   `true`).
  * @property {boolean | null | undefined} [tablePipeAlign=true]
- *   Whether to align the delimiters.
+ *   Whether to align the delimiters (default: `true`).
  * @property {MarkdownTableOptions['stringLength'] | null | undefined} [stringLength]
  *   Function to detect the length of table cell content, used when aligning
- *   the delimiters between cells
+ *   the delimiters between cells (optional).
  */
 
+import {ok as assert} from 'devlop'
 import {markdownTable} from 'markdown-table'
 import {defaultHandlers} from 'mdast-util-to-markdown'
 
-// To do: next major: use `state` and `state` utilities from `mdast-util-to-markdown`.
 // To do: next major: expose functions.
 
 /**
@@ -60,13 +61,14 @@ export const gfmTableFromMarkdown = {
  * @type {FromMarkdownHandle}
  */
 function enterTable(token) {
-  /** @type {Array<'left' | 'right' | 'center' | 'none'>} */
-  // @ts-expect-error: `align` is custom.
   const align = token._align
+  assert(align, 'expected `_align` on table')
   this.enter(
     {
       type: 'table',
-      align: align.map((d) => (d === 'none' ? null : d)),
+      align: align.map(function (d) {
+        return d === 'none' ? null : d
+      }),
       children: []
     },
     token
@@ -120,7 +122,8 @@ function exitCodeText(token) {
     value = value.replace(/\\([\\|])/g, replace)
   }
 
-  const node = /** @type {InlineCode} */ (this.stack[this.stack.length - 1])
+  const node = this.stack[this.stack.length - 1]
+  assert(node.type === 'inlineCode')
   node.value = value
   this.exit(token)
 }
@@ -171,22 +174,19 @@ export function gfmTableToMarkdown(options) {
       {atBreak: true, character: '-', after: '[:|-]'}
     ],
     handlers: {
+      inlineCode: inlineCodeWithTable,
       table: handleTable,
-      tableRow: handleTableRow,
       tableCell: handleTableCell,
-      inlineCode: inlineCodeWithTable
+      tableRow: handleTableRow
     }
   }
 
   /**
    * @type {ToMarkdownHandle}
    * @param {Table} node
    */
-  function handleTable(node, _, context, safeOptions) {
-    return serializeData(
-      handleTableAsData(node, context, safeOptions),
-      node.align
-    )
+  function handleTable(node, _, state, info) {
+    return serializeData(handleTableAsData(node, state, info), node.align)
   }
 
   /**
@@ -197,8 +197,8 @@ export function gfmTableToMarkdown(options) {
    * @type {ToMarkdownHandle}
    * @param {TableRow} node
    */
-  function handleTableRow(node, _, context, safeOptions) {
-    const row = handleTableRowAsData(node, context, safeOptions)
+  function handleTableRow(node, _, state, info) {
+    const row = handleTableRowAsData(node, state, info)
     const value = serializeData([row])
     // `markdown-table` will always add an align row
     return value.slice(0, value.indexOf('\n'))
@@ -208,11 +208,11 @@ export function gfmTableToMarkdown(options) {
    * @type {ToMarkdownHandle}
    * @param {TableCell} node
    */
-  function handleTableCell(node, _, context, safeOptions) {
-    const exit = context.enter('tableCell')
-    const subexit = context.enter('phrasing')
-    const value = context.containerPhrasing(node, {
-      ...safeOptions,
+  function handleTableCell(node, _, state, info) {
+    const exit = state.enter('tableCell')
+    const subexit = state.enter('phrasing')
+    const value = state.containerPhrasing(node, {
+      ...info,
       before: around,
       after: around
     })
@@ -239,22 +239,18 @@ export function gfmTableToMarkdown(options) {
 
   /**
    * @param {Table} node
-   * @param {State} context
-   * @param {Info} safeOptions
+   * @param {State} state
+   * @param {Info} info
    */
-  function handleTableAsData(node, context, safeOptions) {
+  function handleTableAsData(node, state, info) {
     const children = node.children
     let index = -1
     /** @type {Array<Array<string>>} */
     const result = []
-    const subexit = context.enter('table')
+    const subexit = state.enter('table')
 
     while (++index < children.length) {
-      result[index] = handleTableRowAsData(
-        children[index],
-        context,
-        safeOptions
-      )
+      result[index] = handleTableRowAsData(children[index], state, info)
     }
 
     subexit()
@@ -264,26 +260,21 @@ export function gfmTableToMarkdown(options) {
 
   /**
    * @param {TableRow} node
-   * @param {State} context
-   * @param {Info} safeOptions
+   * @param {State} state
+   * @param {Info} info
    */
-  function handleTableRowAsData(node, context, safeOptions) {
+  function handleTableRowAsData(node, state, info) {
     const children = node.children
     let index = -1
     /** @type {Array<string>} */
     const result = []
-    const subexit = context.enter('tableRow')
+    const subexit = state.enter('tableRow')
 
     while (++index < children.length) {
       // Note: the positional info as used here is incorrect.
       // Making it correct would be impossible due to aligning cells?
       // And it would need copy/pasting `markdown-table` into this project.
-      result[index] = handleTableCell(
-        children[index],
-        node,
-        context,
-        safeOptions
-      )
+      result[index] = handleTableCell(children[index], node, state, info)
     }
 
     subexit()
@@ -295,10 +286,10 @@ export function gfmTableToMarkdown(options) {
    * @type {ToMarkdownHandle}
    * @param {InlineCode} node
    */
-  function inlineCodeWithTable(node, parent, context) {
-    let value = defaultHandlers.inlineCode(node, parent, context)
+  function inlineCodeWithTable(node, parent, state) {
+    let value = defaultHandlers.inlineCode(node, parent, state)
 
-    if (context.stack.includes('tableCell')) {
+    if (state.stack.includes('tableCell')) {
       value = value.replace(/\|/g, '\\$&')
     }
 

package.json

@@ -39,6 +39,7 @@
   ],
   "dependencies": {
     "@types/mdast": "^4.0.0",
+    "devlop": "^1.0.0",
     "markdown-table": "^3.0.0",
     "mdast-util-from-markdown": "^2.0.0",
     "mdast-util-to-markdown": "^2.0.0"
@@ -84,6 +85,16 @@
     "strict": true
   },
   "xo": {
+    "overrides": [
+      {
+        "files": [
+          "**/*.ts"
+        ],
+        "rules": {
+          "@typescript-eslint/consistent-type-definitions": "off"
+        }
+      }
+    ],
     "prettier": true
   }
 }