Add typed settings

Author: wooorm

.gitignore

@@ -4,5 +4,6 @@ node_modules/
 *.d.ts
 *.log
 yarn.lock
+!/packages/remark/index.d.ts
 !/packages/remark-parse/index.d.ts
 !/packages/remark-stringify/index.d.ts

packages/remark-parse/index.d.ts

@@ -1,4 +1,6 @@
 import type {Root} from 'mdast'
+import type {Extension} from 'mdast-util-from-markdown'
+import type {Extension as MicromarkExtension} from 'micromark-util-types'
 import type {Plugin} from 'unified'
 import type {Options} from './lib/index.js'
 
@@ -21,8 +23,12 @@ declare const remarkParse: Plugin<
 >
 export default remarkParse
 
-// To do: register types.
-// // Add custom settings supported when `remark-parse` is added.
-// declare module 'unified' {
-//   interface Settings extends Options {}
-// }
+// Add custom settings supported when `remark-parse` is added.
+declare module 'unified' {
+  interface Settings extends Options {}
+
+  interface Data {
+    micromarkExtensions?: MicromarkExtension[]
+    fromMarkdownExtensions?: Array<Extension[] | Extension>
+  }
+}

packages/remark-parse/lib/index.js

@@ -30,23 +30,14 @@ export default function remarkParse(options) {
    * @type {Parser}
    */
   function parser(doc) {
-    // To do: remove cast when typed.
-    // Assume options.
-    const settings = /** @type {Options} */ (self.data('settings'))
-
-    /** @type {FromMarkdownOptions} */
-    const resolvedOptions = {
-      ...settings,
+    return fromMarkdown(doc, {
+      ...self.data('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') || []
-    }
-
-    return fromMarkdown(doc, resolvedOptions)
+    })
   }
 }

packages/remark-parse/package.json

@@ -43,6 +43,7 @@
   "dependencies": {
     "@types/mdast": "^4.0.0",
     "mdast-util-from-markdown": "^2.0.0",
+    "micromark-util-types": "^2.0.0",
     "unified": "^11.0.0"
   },
   "scripts": {},
@@ -59,7 +60,8 @@
           "**/*.ts"
         ],
         "rules": {
-          "@typescript-eslint/ban-types": "off"
+          "@typescript-eslint/ban-types": "off",
+          "@typescript-eslint/consistent-type-definitions": "off"
         }
       }
     ],

packages/remark-stringify/index.d.ts

@@ -1,4 +1,5 @@
 import type {Root} from 'mdast'
+import type {Options as Extension} from 'mdast-util-to-markdown'
 import type {Plugin} from 'unified'
 import type {Options} from './lib/index.js'
 
@@ -21,8 +22,11 @@ declare const remarkStringify: Plugin<
 >
 export default remarkStringify
 
-// To do: register types.
-// // Add custom settings supported when `remark-stringify` is added.
-// declare module 'unified' {
-//   interface Settings extends Options {}
-// }
+// Add custom settings supported when `remark-stringify` is added.
+declare module 'unified' {
+  interface Settings extends Options {}
+
+  interface Data {
+    toMarkdownExtensions?: Extension[]
+  }
+}

packages/remark-stringify/lib/index.js

@@ -30,21 +30,13 @@ export default function remarkStringify(options) {
    * @type {Compiler}
    */
   function compiler(tree) {
-    // To do: remove cast when typed.
-    // Assume options.
-    const settings = /** @type {Options} */ (self.data('settings'))
-
-    /** @type {ToMarkdownOptions} */
-    const resolvedOptions = {
-      ...settings,
+    return toMarkdown(tree, {
+      ...self.data('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') || []
-    }
-
-    return toMarkdown(tree, resolvedOptions)
+    })
   }
 }

packages/remark-stringify/package.json

@@ -59,7 +59,8 @@
           "**/*.ts"
         ],
         "rules": {
-          "@typescript-eslint/ban-types": "off"
+          "@typescript-eslint/ban-types": "off",
+          "@typescript-eslint/consistent-type-definitions": "off"
         }
       }
     ],

packages/remark/index.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="remark-parse" />
+/// <reference types="remark-stringify" />
+
+import type {Root} from 'hast'
+import type {Processor} from 'unified'
+
+/**
+ * Create a new unified processor that already uses `remark-parse` and
+ * `remark-stringify`.
+ */
+export const remark: Processor<Root, undefined, undefined, Root, string>

packages/remark/index.js

@@ -1,3 +1,4 @@
+// Note: types exposed from `index.d.ts`
 import remarkParse from 'remark-parse'
 import remarkStringify from 'remark-stringify'
 import {unified} from 'unified'

packages/remark/package.json

@@ -51,6 +51,16 @@
     "strict": true
   },
   "xo": {
+    "overrides": [
+      {
+        "files": [
+          "**/*.ts"
+        ],
+        "rules": {
+          "@typescript-eslint/triple-slash-reference": "off"
+        }
+      }
+    ],
     "prettier": true
   }
 }

test.js

@@ -25,7 +25,6 @@ test('remark', async function (t) {
   await t.test('should accept settings', async function () {
     assert.equal(
       remark()
-        // @ts-expect-error: to do: type settings.
         .data('settings', {closeAtx: true})
         .processSync('# foo')
         .toString(),
@@ -139,9 +138,7 @@ test('remark-parse', async function (t) {
 
   await t.test('should support extensions', function () {
     const tree = unified()
-      // @ts-expect-error: to do: type settings.
       .data('micromarkExtensions', [gfm()])
-      // @ts-expect-error: to do: type settings.
       .data('fromMarkdownExtensions', [gfmFromMarkdown()])
       .use(remarkParse)
       .parse('* [x] contact@example.com ~~strikethrough~~')
@@ -210,7 +207,6 @@ test('remark-stringify', async function (t) {
 
   await t.test('should support extensions', async function () {
     const result = unified()
-      // @ts-expect-error: to do: type settings.
       .data('toMarkdownExtensions', [gfmToMarkdown()])
       .use(remarkStringify)
       .stringify({

tsconfig.json

@@ -13,6 +13,7 @@
   "exclude": ["**/coverage/", "**/node_modules/"],
   "include": [
     "**/*.js",
+    "packages/remark/index.d.ts",
     "packages/remark-parse/index.d.ts",
     "packages/remark-stringify/index.d.ts"
   ]