Refactor code-style

Author: wooorm

index.d.ts

@@ -7,7 +7,6 @@ import type {
 
 export {directiveFromMarkdown, directiveToMarkdown} from './lib/index.js'
 
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 interface DirectiveFields {
   /**
    * Directive name.
@@ -17,15 +16,13 @@ interface DirectiveFields {
   /**
    * Directive attributes.
    */
-  // eslint-disable-next-line @typescript-eslint/ban-types
   attributes?: Record<string, string | null | undefined> | null | undefined
 }
 
 /**
  * Directive in flow content (such as in the root document, or block
  * quotes), which contains further flow content.
  */
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 export interface ContainerDirective extends Parent, DirectiveFields {
   /**
    * Node type.
@@ -42,7 +39,6 @@ export interface ContainerDirective extends Parent, DirectiveFields {
  * Directive in flow content (such as in the root document, or block
  * quotes), which contains nothing.
  */
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 export interface LeafDirective extends Parent, DirectiveFields {
   /**
    * Node type.
@@ -58,7 +54,6 @@ export interface LeafDirective extends Parent, DirectiveFields {
 /**
  * Directive in phrasing content (such as in paragraphs, headings).
  */
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 export interface TextDirective extends Parent, DirectiveFields {
   /**
    * Node type.
@@ -78,7 +73,6 @@ export type Directive = ContainerDirective | LeafDirective | TextDirective
 
 // 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 {
     /**
      * Attributes for current directive.
@@ -89,7 +83,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 container directive.
@@ -156,10 +149,9 @@ declare module 'mdast-util-to-markdown' {
   }
 }
 
-// Add nodes to content.
+// Add nodes to content, register `data` on paragraph.
 declare module 'mdast' {
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-  interface RootContentMap {
+  interface BlockContentMap {
     /**
      * Directive in flow content (such as in the root document, or block
      * quotes), which contains further flow content.
@@ -171,23 +163,31 @@ declare module 'mdast' {
      * quotes), which contains nothing.
      */
     leafDirective: LeafDirective
+  }
 
+  interface ParagraphData {
     /**
-     * Directive in phrasing content (such as in paragraphs, headings).
+     * Field set on the first paragraph which is a child of a container
+     * directive.
+     * When this is `true`, that means the paragraph represents the *label*:
+     *
+     * ```markdown
+     * :::a[This is the label]
+     * This is further things.
+     * :::
+     * ```
      */
-    textDirective: TextDirective
+    directiveLabel?: boolean | null | undefined
   }
 
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
   interface PhrasingContentMap {
     /**
      * Directive in phrasing content (such as in paragraphs, headings).
      */
     textDirective: TextDirective
   }
 
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-  interface BlockContentMap {
+  interface RootContentMap {
     /**
      * Directive in flow content (such as in the root document, or block
      * quotes), which contains further flow content.
@@ -199,22 +199,10 @@ declare module 'mdast' {
      * quotes), which contains nothing.
      */
     leafDirective: LeafDirective
-  }
 
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-  interface ParagraphData {
     /**
-     * Field set on the first paragraph which is a child of a container
-     * directive.
-     * When this is `true`, that means the paragraph represents the *label*:
-     *
-     * ```markdown
-     * :::a[This is the label]
-     * This is further things.
-     * :::
-     * ```
+     * Directive in phrasing content (such as in paragraphs, headings).
      */
-    // eslint-disable-next-line @typescript-eslint/ban-types
-    directiveLabel?: boolean | null | undefined
+    textDirective: TextDirective
   }
 }

lib/index.js

@@ -1,6 +1,5 @@
 /**
- * @typedef {import('mdast').BlockContent} BlockContent
- * @typedef {import('mdast').DefinitionContent} DefinitionContent
+ * @typedef {import('mdast').Nodes} Nodes
  * @typedef {import('mdast').Paragraph} Paragraph
  *
  * @typedef {import('mdast-util-from-markdown').CompileContext} CompileContext
@@ -13,11 +12,12 @@
  * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
  * @typedef {import('mdast-util-to-markdown').State} State
  *
+ * @typedef {import('../index.js').Directive} Directive
  * @typedef {import('../index.js').LeafDirective} LeafDirective
  * @typedef {import('../index.js').TextDirective} TextDirective
- * @typedef {import('../index.js').Directive} Directive
  */
 
+import {ok as assert} from 'devlop'
 import {parseEntities} from 'parse-entities'
 import {stringifyEntitiesLight} from 'stringify-entities'
 import {visitParents} from 'unist-util-visit-parents'
@@ -144,7 +144,12 @@ function enter(type, token) {
  * @param {Token} token
  */
 function exitName(token) {
-  const node = /** @type {Directive} */ (this.stack[this.stack.length - 1])
+  const node = this.stack[this.stack.length - 1]
+  assert(
+    node.type === 'containerDirective' ||
+      node.type === 'leafDirective' ||
+      node.type === 'textDirective'
+  )
   node.name = this.sliceSerialize(token)
 }
 
@@ -181,9 +186,8 @@ function enterAttributes() {
  * @type {FromMarkdownHandle}
  */
 function exitAttributeIdValue(token) {
-  const list = /** @type {Array<[string, string]>} */ (
-    this.data.directiveAttributes
-  )
+  const list = this.data.directiveAttributes
+  assert(list, 'expected `directiveAttributes`')
   list.push([
     'id',
     parseEntities(this.sliceSerialize(token), {
@@ -197,9 +201,8 @@ function exitAttributeIdValue(token) {
  * @type {FromMarkdownHandle}
  */
 function exitAttributeClassValue(token) {
-  const list = /** @type {Array<[string, string]>} */ (
-    this.data.directiveAttributes
-  )
+  const list = this.data.directiveAttributes
+  assert(list, 'expected `directiveAttributes`')
   list.push([
     'class',
     parseEntities(this.sliceSerialize(token), {
@@ -213,9 +216,8 @@ function exitAttributeClassValue(token) {
  * @type {FromMarkdownHandle}
  */
 function exitAttributeValue(token) {
-  const list = /** @type {Array<[string, string]>} */ (
-    this.data.directiveAttributes
-  )
+  const list = this.data.directiveAttributes
+  assert(list, 'expected `directiveAttributes`')
   list[list.length - 1][1] = parseEntities(this.sliceSerialize(token), {
     attribute: true
   })
@@ -226,9 +228,8 @@ function exitAttributeValue(token) {
  * @type {FromMarkdownHandle}
  */
 function exitAttributeName(token) {
-  const list = /** @type {Array<[string, string]>} */ (
-    this.data.directiveAttributes
-  )
+  const list = this.data.directiveAttributes
+  assert(list, 'expected `directiveAttributes`')
 
   // Attribute names in CommonMark are significantly limited, so character
   // references can’t exist.
@@ -240,9 +241,8 @@ function exitAttributeName(token) {
  * @type {FromMarkdownHandle}
  */
 function exitAttributes() {
-  const list = /** @type {Array<[string, string]>} */ (
-    this.data.directiveAttributes
-  )
+  const list = this.data.directiveAttributes
+  assert(list, 'expected `directiveAttributes`')
   /** @type {Record<string, string>} */
   const cleaned = {}
   let index = -1
@@ -259,7 +259,12 @@ function exitAttributes() {
 
   this.data.directiveAttributes = undefined
   this.resume() // Drop EOLs
-  const node = /** @type {Directive} */ (this.stack[this.stack.length - 1])
+  const node = this.stack[this.stack.length - 1]
+  assert(
+    node.type === 'containerDirective' ||
+      node.type === 'leafDirective' ||
+      node.type === 'textDirective'
+  )
   node.attributes = cleaned
 }
 
@@ -275,12 +280,12 @@ function exit(token) {
  * @type {ToMarkdownHandle}
  * @param {Directive} node
  */
-function handleDirective(node, _, state, safeOptions) {
-  const tracker = state.createTracker(safeOptions)
+function handleDirective(node, _, state, info) {
+  const tracker = state.createTracker(info)
   const sequence = fence(node)
   const exit = state.enter(node.type)
   let value = tracker.move(sequence + (node.name || ''))
-  /** @type {Paragraph | LeafDirective | TextDirective | undefined} */
+  /** @type {LeafDirective | Paragraph | TextDirective | undefined} */
   let label
 
   if (node.type === 'containerDirective') {
@@ -424,7 +429,7 @@ function attributes(node, state) {
 }
 
 /**
- * @param {BlockContent | DefinitionContent} node
+ * @param {Nodes} node
  * @returns {node is Paragraph & {data: {directiveLabel: true}}}
  */
 function inlineDirectiveLabel(node) {

package.json

@@ -32,13 +32,13 @@
   "types": "index.d.ts",
   "files": [
     "lib/",
-    "complex-types.d.ts",
     "index.d.ts",
     "index.js"
   ],
   "dependencies": {
     "@types/mdast": "^4.0.0",
     "@types/unist": "^3.0.0",
+    "devlop": "^1.0.0",
     "mdast-util-from-markdown": "^2.0.0",
     "mdast-util-to-markdown": "^2.0.0",
     "parse-entities": "^4.0.0",
@@ -85,6 +85,17 @@
     "strict": true
   },
   "xo": {
+    "overrides": [
+      {
+        "files": [
+          "**/*.ts"
+        ],
+        "rules": {
+          "@typescript-eslint/ban-types": "off",
+          "@typescript-eslint/consistent-type-definitions": "off"
+        }
+      }
+    ],
     "prettier": true
   }
 }

readme.md

@@ -427,7 +427,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 directives.
 })
 ```