Refactor code-style

Author: wooorm

index.d.ts

@@ -1,7 +1,6 @@
 export {gfmFootnoteFromMarkdown, gfmFootnoteToMarkdown} from './lib/index.js'
 
 declare module 'mdast-util-to-markdown' {
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
   interface ConstructNameMap {
     /**
      * Footnote reference.

lib/index.js

@@ -1,21 +1,19 @@
 /**
- * @typedef {import('mdast').FootnoteReference} FootnoteReference
  * @typedef {import('mdast').FootnoteDefinition} FootnoteDefinition
+ * @typedef {import('mdast').FootnoteReference} FootnoteReference
  * @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('mdast-util-to-markdown').Map} Map
+ * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
  */
 
+import {ok as assert} from 'devlop'
 import {normalizeIdentifier} from 'micromark-util-normalize-identifier'
 
 footnoteReference.peek = footnoteReferencePeek
 
-// To do: next major: rename `context` -> `state`, `safeOptions` to `info`, use
-// utilities on `state`.
-
 /**
  * Create an extension for `mdast-util-from-markdown` to enable GFM footnotes
  * in markdown.
@@ -80,9 +78,8 @@ function enterFootnoteDefinitionLabelString() {
  */
 function exitFootnoteDefinitionLabelString(token) {
   const label = this.resume()
-  const node = /** @type {FootnoteDefinition} */ (
-    this.stack[this.stack.length - 1]
-  )
+  const node = this.stack[this.stack.length - 1]
+  assert(node.type === 'footnoteDefinition')
   node.label = label
   node.identifier = normalizeIdentifier(
     this.sliceSerialize(token)
@@ -119,9 +116,8 @@ function enterFootnoteCallString() {
  */
 function exitFootnoteCallString(token) {
   const label = this.resume()
-  const node = /** @type {FootnoteDefinition} */ (
-    this.stack[this.stack.length - 1]
-  )
+  const node = this.stack[this.stack.length - 1]
+  assert(node.type === 'footnoteReference')
   node.label = label
   node.identifier = normalizeIdentifier(
     this.sliceSerialize(token)
@@ -140,13 +136,13 @@ function exitFootnoteCall(token) {
  * @type {ToMarkdownHandle}
  * @param {FootnoteReference} node
  */
-function footnoteReference(node, _, context, safeOptions) {
-  const tracker = context.createTracker(safeOptions)
+function footnoteReference(node, _, state, info) {
+  const tracker = state.createTracker(info)
   let value = tracker.move('[^')
-  const exit = context.enter('footnoteReference')
-  const subexit = context.enter('reference')
+  const exit = state.enter('footnoteReference')
+  const subexit = state.enter('reference')
   value += tracker.move(
-    context.safe(context.associationId(node), {
+    state.safe(state.associationId(node), {
       ...tracker.current(),
       before: value,
       after: ']'
@@ -167,13 +163,13 @@ function footnoteReferencePeek() {
  * @type {ToMarkdownHandle}
  * @param {FootnoteDefinition} node
  */
-function footnoteDefinition(node, _, context, safeOptions) {
-  const tracker = context.createTracker(safeOptions)
+function footnoteDefinition(node, _, state, info) {
+  const tracker = state.createTracker(info)
   let value = tracker.move('[^')
-  const exit = context.enter('footnoteDefinition')
-  const subexit = context.enter('label')
+  const exit = state.enter('footnoteDefinition')
+  const subexit = state.enter('label')
   value += tracker.move(
-    context.safe(context.associationId(node), {
+    state.safe(state.associationId(node), {
       ...tracker.current(),
       before: value,
       after: ']'
@@ -185,7 +181,7 @@ function footnoteDefinition(node, _, context, safeOptions) {
   )
   tracker.shift(4)
   value += tracker.move(
-    context.indentLines(context.containerFlow(node, tracker.current()), map)
+    state.indentLines(state.containerFlow(node, tracker.current()), map)
   )
   exit()
 

package.json

@@ -36,6 +36,7 @@
   ],
   "dependencies": {
     "@types/mdast": "^4.0.0",
+    "devlop": "^1.1.0",
     "mdast-util-from-markdown": "^2.0.0",
     "mdast-util-to-markdown": "^2.0.0",
     "micromark-util-normalize-identifier": "^2.0.0"
@@ -79,6 +80,16 @@
     "strict": true
   },
   "xo": {
+    "overrides": [
+      {
+        "files": [
+          "**/*.ts"
+        ],
+        "rules": {
+          "@typescript-eslint/consistent-type-definitions": "off"
+        }
+      }
+    ],
     "prettier": true
   }
 }