Update unified, vfile

unifiedjs · Aug 22, 2023 · d5ca3cb · d5ca3cb
1 parent 7864c11
commit d5ca3cb
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 30 deletions.
diff --git a/index.js b/index.js
@@ -1,7 +1,6 @@
 /**
  * @typedef {import('unified').Processor} Processor
  * @typedef {import('unified').ProcessCallback} ProcessCallback
- * @typedef {import('vfile').BufferEncoding} Encoding
  * @typedef {import('vfile').VFileValue} Value
  * @typedef {((error?: Error) => void)} Callback
  * @typedef {Omit<NodeJS.ReadableStream & NodeJS.WritableStream, 'read'|'setEncoding'|'pause'|'resume'|'isPaused'|'unpipe'|'unshift'|'wrap'>} MinimalDuplex
@@ -36,14 +35,14 @@ export function stream(processor) {
   const write =
     /**
      * @type {(
-     *   ((value?: Value, encoding?: Encoding, callback?: Callback) => boolean) &
+     *   ((value?: Value, encoding?: string, callback?: Callback) => boolean) &
      *   ((value: Value, callback?: Callback) => boolean)
      * )}
      */
     (
       /**
        * @param {Value} [chunk]
-       * @param {Encoding} [encoding]
+       * @param {string} [encoding]
        * @param {Callback} [callback]
        */
       function (chunk, encoding, callback) {
@@ -56,6 +55,8 @@ export function stream(processor) {
           throw new Error('Did not expect `write` after `end`')
         }
 
+        // To do: improve writnig, I think there’s a Node textencoder example somewhere.
+        // @ts-expect-error: `encoding` is fine on buffers.
         chunks.push((chunk || '').toString(encoding || 'utf8'))
 
         if (callback) {
@@ -85,14 +86,14 @@ export function stream(processor) {
   const end =
     /**
      * @type {(
-     *   ((value?: Value, encoding?: Encoding, callback?: Callback) => boolean) &
+     *   ((value?: Value, encoding?: string, callback?: Callback) => boolean) &
      *   ((value: Value, callback?: Callback) => boolean)
      * )}
      */
     (
       /**
        * @param {Value} [chunk]
-       * @param {Encoding} [encoding]
+       * @param {string} [encoding]
        * @param {Callback} [callback]
        */
       function (chunk, encoding, callback) {

diff --git a/package.json b/package.json
@@ -26,16 +26,19 @@
     "index.js"
   ],
   "dependencies": {
-    "unified": "^10.0.0",
-    "vfile": "^5.0.0"
+    "unified": "^11.0.0",
+    "vfile": "^6.0.0"
   },
   "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@types/unist": "^3.0.0",
     "c8": "^8.0.0",
     "prettier": "^3.0.0",
     "remark-cli": "^11.0.0",
     "remark-preset-wooorm": "^9.0.0",
     "type-coverage": "^2.0.0",
     "typescript": "^5.0.0",
+    "vfile-message": "^4.0.2",
     "xo": "^0.56.0"
   },
   "scripts": {

diff --git a/test.js b/test.js
@@ -1,9 +1,9 @@
 /**
+ * @typedef {import('unist').Literal} Literal
+ * @typedef {import('unist').Node} Node
+ *
  * @typedef {import('unified').Processor} Processor
- * @typedef {import('unified').Plugin} Plugin
- * @typedef {import('unified').Transformer} Transformer
- * @typedef {import('unified').ParserFunction} ParserFunction
- * @typedef {import('unified').CompilerFunction} CompilerFunction
+ *
  * @typedef {import('vfile-message').VFileMessage} VFileMessage
  */
 
@@ -74,9 +74,7 @@ test('stream', async (t) => {
 
     stream(
       proc().use(() => {
-        return transformer
-        /** @type {Transformer} */
-        function transformer() {
+        return function () {
           return exception
         }
       })
@@ -99,9 +97,7 @@ test('stream', async (t) => {
 
     stream(
       proc().use(() => {
-        return transformer
-        /** @type {Transformer} */
-        function transformer(_, file) {
+        return function (_, file) {
           file.message(exception)
         }
       })
@@ -194,29 +190,37 @@ test('stream', async (t) => {
 })
 
 /**
- * @type {Plugin}
- * @this {Processor}
+ * @type {import('unified').Plugin<[], string, Node>}
  */
 function parse() {
-  this.Parser = parser
+  /** @type {Processor} */
+  // @ts-expect-error: TS is wrong about `this`.
+  // eslint-disable-next-line unicorn/no-this-assignment
+  const self = this
 
-  /** @type {ParserFunction} */
+  self.parser = parser
+
+  /** @type {import('unified').Parser<Node>} */
   function parser(doc) {
-    // @ts-expect-error: hush.
-    return {type: 'text', value: doc}
+    /** @type {Literal} */
+    const literal = {type: 'text', value: doc}
+    return literal
   }
 }
 
 /**
- * @type {Plugin}
- * @this {Processor}
+ * @type {import('unified').Plugin<[], Node, string>}
  */
 function stringify() {
-  this.Compiler = compiler
+  /** @type {Processor} */
+  // @ts-expect-error: TS is wrong about `this`.
+  // eslint-disable-next-line unicorn/no-this-assignment
+  const self = this
+
+  self.compiler = compiler
 
-  /** @type {CompilerFunction} */
-  function compiler(tree) {
-    // @ts-expect-error: it’s a text node.
-    return tree.value
+  /** @type {import('unified').Compiler<Node, string>} */
+  function compiler(node) {
+    return 'value' in node ? String(node.value) : ''
   }
 }