Refactor code-style

Author: wooorm

index.d.ts

@@ -7,7 +7,6 @@ export type {ToOptions} from './lib/index.js'
 /**
  * Math (flow).
  */
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 export interface Math extends Literal {
   /**
    * Node type.
@@ -17,13 +16,12 @@ export interface Math extends Literal {
   /**
    * Custom information relating to the node.
    */
-  meta?: string | undefined | null
+  meta?: string | null | undefined
 }
 
 /**
  * Math (text).
  */
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 export interface InlineMath extends Literal {
   /**
    * Node type.
@@ -33,7 +31,6 @@ export interface InlineMath extends Literal {
 
 // 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 in math (flow).
@@ -44,7 +41,6 @@ declare module 'mdast-util-from-markdown' {
 
 // Add custom data tracked to turn a tree into markdown.
 declare module 'mdast-util-to-markdown' {
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
   interface ConstructNameMap {
     /**
      * Math (flow).
@@ -76,17 +72,14 @@ declare module 'mdast-util-to-markdown' {
 
 // Add nodes to tree.
 declare module 'mdast' {
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
   interface BlockContentMap {
     math: Math
   }
 
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
   interface PhrasingContentMap {
     inlineMath: InlineMath
   }
 
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
   interface RootContentMap {
     inlineMath: InlineMath
     math: Math

lib/index.js

@@ -2,21 +2,22 @@
  * @typedef {import('mdast-util-from-markdown').CompileContext} CompileContext
  * @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
  * @typedef {import('mdast-util-from-markdown').Handle} FromMarkdownHandle
- * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
  * @typedef {import('mdast-util-to-markdown').Handle} ToMarkdownHandle
- * @typedef {import('../index.js').Math} Math
+ * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
  * @typedef {import('../index.js').InlineMath} InlineMath
+ * @typedef {import('../index.js').Math} Math
  *
  * @typedef ToOptions
  *   Configuration.
  * @property {boolean | null | undefined} [singleDollarTextMath=true]
- *   Whether to support math (text) with a single dollar.
+ *   Whether to support math (text) with a single dollar (default: `true`).
  *
  *   Single dollars work in Pandoc and many other places, but often interfere
  *   with “normal” dollars in text.
  *   If you turn this off, you can still use two or more dollars for text math.
  */
 
+import {ok as assert} from 'devlop'
 import {longestStreak} from 'longest-streak'
 
 /**
@@ -76,7 +77,8 @@ export function mathFromMarkdown() {
    */
   function exitMathFlowMeta() {
     const data = this.resume()
-    const node = /** @type {Math} */ (this.stack[this.stack.length - 1])
+    const node = this.stack[this.stack.length - 1]
+    assert(node.type === 'math')
     node.meta = data
   }
 
@@ -97,10 +99,11 @@ export function mathFromMarkdown() {
    */
   function exitMathFlow(token) {
     const data = this.resume().replace(/^(\r?\n|\r)|(\r?\n|\r)$/g, '')
-    const node = /** @type {Math} */ (this.stack[this.stack.length - 1])
+    const node = this.stack[this.stack.length - 1]
+    assert(node.type === 'math')
     this.exit(token)
     node.value = data
-    // @ts-expect-error: we defined it.
+    // @ts-expect-error: we defined it in `enterMathFlow`.
     node.data.hChildren[0].value = data
     this.data.mathFlowInside = undefined
   }
@@ -131,7 +134,8 @@ export function mathFromMarkdown() {
    */
   function exitMathText(token) {
     const data = this.resume()
-    const node = /** @type {Math} */ (this.stack[this.stack.length - 1])
+    const node = this.stack[this.stack.length - 1]
+    assert(node.type === 'inlineMath')
     this.exit(token)
     node.value = data
     // @ts-expect-error: we defined it.
@@ -152,7 +156,7 @@ export function mathFromMarkdown() {
  * Create an extension for `mdast-util-to-markdown`.
  *
  * @param {ToOptions | null | undefined} [options]
- *   Configuration.
+ *   Configuration (optional).
  * @returns {ToMarkdownExtension}
  *   Extension for `mdast-util-to-markdown`.
  */
@@ -184,22 +188,21 @@ export function mathToMarkdown(options) {
    * @type {ToMarkdownHandle}
    * @param {Math} node
    */
-  // To do: next major: rename `context` to state, `safeOptions` to info.
   // Note: fixing this code? Please also fix the similar code for code:
   // <https://github.com/syntax-tree/mdast-util-to-markdown/blob/main/lib/handle/code.js>
-  function math(node, _, context, safeOptions) {
+  function math(node, _, state, info) {
     const raw = node.value || ''
-    const tracker = context.createTracker(safeOptions)
+    const tracker = state.createTracker(info)
     const sequence = '$'.repeat(Math.max(longestStreak(raw, '$') + 1, 2))
-    const exit = context.enter('mathFlow')
+    const exit = state.enter('mathFlow')
     let value = tracker.move(sequence)
 
     if (node.meta) {
-      const subexit = context.enter('mathFlowMeta')
+      const subexit = state.enter('mathFlowMeta')
       value += tracker.move(
-        context.safe(node.meta, {
-          before: value,
+        state.safe(node.meta, {
           after: '\n',
+          before: value,
           encode: ['$'],
           ...tracker.current()
         })
@@ -224,10 +227,7 @@ export function mathToMarkdown(options) {
    */
   // Note: fixing this code? Please also fix the similar code for inline code:
   // <https://github.com/syntax-tree/mdast-util-to-markdown/blob/main/lib/handle/inline-code.js>
-  //
-  // To do: next major: rename `context` to state.
-  // To do: next major: use `state` (`safe`, `track`, `patternCompile`).
-  function inlineMath(node, _, context) {
+  function inlineMath(node, _, state) {
     let value = node.value || ''
     let size = 1
 
@@ -267,15 +267,15 @@ export function mathToMarkdown(options) {
     // We can’t escape characters in `inlineMath`, but because eols are
     // transformed to spaces when going from markdown to HTML anyway, we can swap
     // them out.
-    while (++index < context.unsafe.length) {
-      const pattern = context.unsafe[index]
+    while (++index < state.unsafe.length) {
+      const pattern = state.unsafe[index]
 
       // Only look for `atBreak`s.
       // Btw: note that `atBreak` patterns will always start the regex at LF or
       // CR.
       if (!pattern.atBreak) continue
 
-      const expression = context.compilePattern(pattern)
+      const expression = state.compilePattern(pattern)
       /** @type {RegExpExecArray | null} */
       let match
 

package.json

@@ -38,6 +38,7 @@
   ],
   "dependencies": {
     "@types/mdast": "^4.0.0",
+    "devlop": "^1.0.0",
     "longest-streak": "^3.0.0",
     "mdast-util-from-markdown": "^2.0.0",
     "mdast-util-to-markdown": "^2.1.0"
@@ -81,9 +82,19 @@
     "strict": true
   },
   "xo": {
+    "overrides": [
+      {
+        "files": [
+          "**/*.ts"
+        ],
+        "rules": {
+          "@typescript-eslint/ban-types": "off",
+          "@typescript-eslint/consistent-type-definitions": "off"
+        }
+      }
+    ],
     "prettier": true,
     "rules": {
-      "@typescript-eslint/ban-types": "off",
       "unicorn/prefer-at": "off",
       "unicorn/prefer-string-replace-all": "off"
     }

readme.md

@@ -213,7 +213,7 @@ import type {Literal} from 'mdast'
 
 interface Math extends Literal {
   type: 'math'
-  meta?: string | undefined | null
+  meta?: string | null | undefined
 }
 ```
 
@@ -350,7 +350,7 @@ import {visit} from 'unist-util-visit'
 /** @type {import('mdast').Root} */
 const tree = getMdastNodeSomeHow()
 
-visit(tree, (node) => {
+visit(tree, function (node) {
   // `node` can now be one of the nodes for math.
 })
 ```