Refactor code-style

.gitignore

@@ -1,12 +1,8 @@
 coverage/
 node_modules/
-packages/remark/*.d.ts
-packages/remark-cli/*.d.ts
-packages/remark-parse/lib/*.d.ts
-packages/remark-parse/test.d.ts
-packages/remark-stringify/lib/*.d.ts
-packages/remark-stringify/test.d.ts
-test.d.ts
 .DS_Store
+*.d.ts
 *.log
 yarn.lock
+!/packages/remark-parse/index.d.ts
+!/packages/remark-stringify/index.d.ts

packages/remark-cli/cli.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+
 /**
  * @typedef Pack
  * @property {string} name
@@ -25,16 +26,16 @@ const cli = JSON.parse(
 )
 
 args({
-  processor: remark,
-  name: proc.name,
   description: cli.description,
+  extensions: markdownExtensions,
+  ignoreName: '.' + proc.name + 'ignore',
+  name: proc.name,
+  packageField: proc.name + 'Config',
+  pluginPrefix: proc.name,
+  processor: remark,
+  rcName: '.' + proc.name + 'rc',
   version: [
     proc.name + ': ' + proc.version,
     cli.name + ': ' + cli.version
-  ].join(', '),
-  pluginPrefix: proc.name,
-  packageField: proc.name + 'Config',
-  rcName: '.' + proc.name + 'rc',
-  ignoreName: '.' + proc.name + 'ignore',
-  extensions: markdownExtensions
+  ].join(', ')
 })

packages/remark-parse/index.d.ts

@@ -1,9 +1,28 @@
-// This wrapper exists because JS in TS can’t export a `@type` of a function.
 import type {Root} from 'mdast'
 import type {Plugin} from 'unified'
 import type {Options} from './lib/index.js'
 
-declare const remarkParse: Plugin<[(Options | undefined)?], string, Root>
+export type {Options} from './lib/index.js'
+
+/**
+ * Add support for parsing from markdown.
+ *
+ * @this
+ *   Unified processor.
+ * @param
+ *   Configuration (optional).
+ * @returns
+ *   Nothing.
+ */
+declare const remarkParse: Plugin<
+  [(Readonly<Options> | null | undefined)?],
+  string,
+  Root
+>
 export default remarkParse
 
-export type {Options} from './lib/index.js'
+// To do: register types.
+// // Add custom settings supported when `remark-parse` is added.
+// declare module 'unified' {
+//   interface Settings extends Options {}
+// }

packages/remark-parse/index.js

@@ -1 +1,2 @@
+// Note: types exposed from `index.d.ts`.
 export {default} from './lib/index.js'

packages/remark-parse/lib/index.js

@@ -1,33 +1,52 @@
 /**
  * @typedef {import('mdast').Root} Root
- * @typedef {import('mdast-util-from-markdown').Options} Options
+ * @typedef {import('mdast-util-from-markdown').Options} FromMarkdownOptions
+ * @typedef {import('unified').Parser<Root>} Parser
+ * @typedef {import('unified').Processor<Root>} Processor
+ */
+
+/**
+ * @typedef {Omit<FromMarkdownOptions, 'extensions' | 'fromMarkdownExtensions'>} Options
  */
 
 import {fromMarkdown} from 'mdast-util-from-markdown'
 
 /**
- * @this {import('unified').Processor}
- * @type {import('unified').Plugin<[Options?] | void[], string, Root>}
+ * Aadd support for parsing from markdown.
+ *
+ * @param {Readonly<Options> | null | undefined} [options]
+ *   Configuration (optional).
+ * @returns {undefined}
+ *   Nothing.
  */
 export default function remarkParse(options) {
-  /** @type {import('unified').Parser<Root>} */
-  const parser = (doc) => {
+  /** @type {Processor} */
+  // @ts-expect-error: TS in JSDoc generates wrong types if `this` is typed regularly.
+  const self = this
+
+  self.parser = parser
+
+  /**
+   * @type {Parser}
+   */
+  function parser(doc) {
+    // To do: remove cast when typed.
     // Assume options.
-    const settings = /** @type {Options} */ (this.data('settings'))
+    const settings = /** @type {Options} */ (self.data('settings'))
 
-    return fromMarkdown(
-      doc,
-      Object.assign({}, settings, options, {
-        // Note: these options are not in the readme.
-        // The goal is for them to be set by plugins on `data` instead of being
-        // passed by users.
-        // @ts-expect-error: to do: type.
-        extensions: this.data('micromarkExtensions') || [],
-        // @ts-expect-error: to do: type.
-        mdastExtensions: this.data('fromMarkdownExtensions') || []
-      })
-    )
-  }
+    /** @type {FromMarkdownOptions} */
+    const resolvedOptions = {
+      ...settings,
+      ...options,
+      // Note: these options are not in the readme.
+      // The goal is for them to be set by plugins on `data` instead of being
+      // passed by users.
+      // @ts-expect-error: to do: type.
+      extensions: self.data('micromarkExtensions') || [],
+      // @ts-expect-error: to do: type.
+      mdastExtensions: self.data('fromMarkdownExtensions') || []
+    }
 
-  Object.assign(this, {Parser: parser})
+    return fromMarkdown(doc, resolvedOptions)
+  }
 }

packages/remark-parse/package.json

@@ -53,6 +53,19 @@
     "strict": true
   },
   "xo": {
-    "prettier": true
+    "overrides": [
+      {
+        "files": [
+          "**/*.ts"
+        ],
+        "rules": {
+          "@typescript-eslint/ban-types": "off"
+        }
+      }
+    ],
+    "prettier": true,
+    "rules": {
+      "unicorn/no-this-assignment": "off"
+    }
   }
 }

packages/remark-stringify/index.d.ts

@@ -1,9 +1,28 @@
-// This wrapper exists because JS in TS can’t export a `@type` of a function.
 import type {Root} from 'mdast'
 import type {Plugin} from 'unified'
 import type {Options} from './lib/index.js'
 
-declare const remarkStringify: Plugin<[(Options | undefined)?], Root, string>
+export type {Options} from './lib/index.js'
+
+/**
+ * Add support for serializing as HTML.
+ *
+ * @this
+ *   Unified processor.
+ * @param
+ *   Configuration (optional).
+ * @returns
+ *   Nothing.
+ */
+declare const remarkStringify: Plugin<
+  [(Readonly<Options> | null | undefined)?],
+  Root,
+  string
+>
 export default remarkStringify
 
-export type {Options} from './lib/index.js'
+// To do: register types.
+// // Add custom settings supported when `remark-stringify` is added.
+// declare module 'unified' {
+//   interface Settings extends Options {}
+// }

packages/remark-stringify/index.js

@@ -1 +1,2 @@
+// Note: types exposed from `index.d.ts`.
 export {default} from './lib/index.js'

packages/remark-stringify/lib/index.js

@@ -1,36 +1,50 @@
 /**
- * @typedef {import('mdast').Root|import('mdast').Content} Node
+ * @typedef {import('mdast').Root} Root
  * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownOptions
+ * @typedef {import('unified').Compiler<Root, string>} Compiler
+ * @typedef {import('unified').Processor<undefined, undefined, undefined, Root, string>} Processor
+ */
+
+/**
  * @typedef {Omit<ToMarkdownOptions, 'extensions'>} Options
  */
 
 import {toMarkdown} from 'mdast-util-to-markdown'
 
 /**
- * @this {import('unified').Processor}
- * @type {import('unified').Plugin<[Options?]|void[], Node, string>}
+ * Add support for serializing as markdown.
+ *
+ * @param {Readonly<Options> | null | undefined} [options]
+ *   Configuration (optional).
+ * @returns {undefined}
+ *   Nothing.
  */
 export default function remarkStringify(options) {
-  /** @type {import('unified').Compiler<Node, string>} */
-  const compiler = (tree) => {
+  /** @type {Processor} */
+  // @ts-expect-error: TS in JSDoc generates wrong types if `this` is typed regularly.
+  const self = this
+
+  self.compiler = compiler
+
+  /**
+   * @type {Compiler}
+   */
+  function compiler(tree) {
+    // To do: remove cast when typed.
     // Assume options.
-    const settings = /** @type {Options} */ (this.data('settings'))
+    const settings = /** @type {Options} */ (self.data('settings'))
 
-    return toMarkdown(
-      tree,
-      Object.assign({}, settings, options, {
-        // Note: this option is not in the readme.
-        // The goal is for it to be set by plugins on `data` instead of being
-        // passed by users.
-        extensions:
-          // @ts-expect-error: to do: type.
-          /** @type {ToMarkdownOptions['extensions']} */ (
-            // @ts-expect-error: to do: type.
-            this.data('toMarkdownExtensions')
-          ) || []
-      })
-    )
-  }
+    /** @type {ToMarkdownOptions} */
+    const resolvedOptions = {
+      ...settings,
+      ...options,
+      // Note: this option is not in the readme.
+      // The goal is for it to be set by plugins on `data` instead of being
+      // passed by users.
+      // @ts-expect-error: to do: type.
+      extensions: self.data('toMarkdownExtensions') || []
+    }
 
-  Object.assign(this, {Compiler: compiler})
+    return toMarkdown(tree, resolvedOptions)
+  }
 }

packages/remark-stringify/package.json

@@ -53,6 +53,19 @@
     "strict": true
   },
   "xo": {
-    "prettier": true
+    "overrides": [
+      {
+        "files": [
+          "**/*.ts"
+        ],
+        "rules": {
+          "@typescript-eslint/ban-types": "off"
+        }
+      }
+    ],
+    "prettier": true,
+    "rules": {
+      "unicorn/no-this-assignment": "off"
+    }
   }
 }

packages/remark/index.js

@@ -1,5 +1,9 @@
-import {unified} from 'unified'
 import remarkParse from 'remark-parse'
 import remarkStringify from 'remark-stringify'
+import {unified} from 'unified'
 
+/**
+ * Create a new unified processor that already uses `remark-parse` and
+ * `remark-stringify`.
+ */
 export const remark = unified().use(remarkParse).use(remarkStringify).freeze()

packages/remark/readme.md

@@ -175,7 +175,7 @@ main()
 
 async function main() {
   const file = await remark()
-    .data('settings', {bullet: '*', setext: true, listItemIndent: 'one'})
+    .data('settings', {bullet: '*', listItemIndent: 'one', setext: true})
     .process('# Moons of Neptune\n\n- Naiad\n- Thalassa\n- Despine\n- …')
 
   console.log(String(file))

readme.md

@@ -114,8 +114,8 @@ console.log(String(file)) // => '## Hi, Saturn!'
 
 /** @type {import('unified').Plugin<[], import('mdast').Root>} */
 function myRemarkPluginToIncreaseHeadings() {
-  return (tree) => {
-    visit(tree, (node) => {
+  return function (tree) {
+    visit(tree, function (node) {
       if (node.type === 'heading') {
         node.depth++
       }