Update vfile

Author: wooorm

lib/index.js

@@ -1,13 +1,16 @@
 /**
- * @typedef {import('vfile').BufferEncoding} BufferEncoding
- *   Encodings supported by the buffer class.
- *
- *   This is a copy of the types from Node and `VFile`.
  * @typedef {import('vfile').VFileOptions} Options
  * @typedef {import('vfile').VFileValue} Value
  */
 
 /**
+ * @typedef {'ascii' | 'base64' | 'base64url' | 'binary' | 'hex' | 'latin1' | 'ucs-2' | 'ucs2' | 'utf-8' | 'utf16le' | 'utf8'} BufferEncoding
+ *   Encodings supported by the buffer class.
+ *
+ *   This is a copy of the types from Node, copied to prevent Node globals from
+ *   being needed.
+ *   Copied from: <https://github.com/DefinitelyTyped/DefinitelyTyped/blob/1761eec/types/node/buffer.d.ts#L223>.
+ *
  * @typedef ReadOptions
  *   Configuration for `fs.readFile`.
  * @property {BufferEncoding | null | undefined} [encoding]
@@ -58,7 +61,6 @@
 import fs from 'fs'
 import path from 'path'
 import {URL} from 'url'
-import buffer from 'is-buffer'
 import {VFile} from 'vfile'
 
 // To do: next major: use `node:` prefix.
@@ -82,8 +84,8 @@ import {VFile} from 'vfile'
 export function toVFile(description) {
   if (typeof description === 'string' || description instanceof URL) {
     description = {path: description}
-  } else if (buffer(description)) {
-    description = {path: String(description)}
+  } else if (isUint8Array(description)) {
+    description = {path: new TextDecoder().decode(description)}
   }
 
   // To do: do not return given file.
@@ -304,6 +306,23 @@ function looksLikeAVFile(value) {
   )
 }
 
+/**
+ * Check whether `value` is an `Uint8Array`.
+ *
+ * @param {unknown} value
+ *   thing.
+ * @returns {value is Uint8Array}
+ *   Whether `value` is an `Uint8Array`.
+ */
+function isUint8Array(value) {
+  return Boolean(
+    value &&
+      typeof value === 'object' &&
+      'byteLength' in value &&
+      'byteOffset' in value
+  )
+}
+
 // To do: next major: remove?
 toVFile.readSync = readSync
 toVFile.writeSync = writeSync

package.json

@@ -35,8 +35,7 @@
     "index.js"
   ],
   "dependencies": {
-    "is-buffer": "^2.0.0",
-    "vfile": "^5.1.0"
+    "vfile": "^6.0.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",

test.js

@@ -43,6 +43,12 @@ test('toVFile', async function (t) {
     assert.equal(file.value, undefined)
   })
 
+  await t.test('should accept a uint array as `.path`', function () {
+    const file = toVFile(new Uint8Array([0x61, 0x62, 0x63, 0x2e, 0x6d, 0x64]))
+
+    assert.equal(file.path, 'abc.md')
+  })
+
   await t.test('should accept an object', function () {
     const file = toVFile({
       dirname: join('foo', 'bar'),