Replace js-yaml with yaml

Author: wooorm

index.js

@@ -1,19 +1,29 @@
 /**
  * @typedef {import('vfile').VFile} VFile
- * @typedef {import('js-yaml').LoadOptions} LoadOptions
+ * @typedef {import('yaml').ParseOptions} ParseOptions
+ * @typedef {import('yaml').DocumentOptions} DocumentOptions
+ * @typedef {import('yaml').SchemaOptions} SchemaOptions
+ * @typedef {import('yaml').ToJSOptions} ToJsOptions
+ * @typedef {ParseOptions & DocumentOptions & SchemaOptions & ToJsOptions} YamlOptions
  *
- * @typedef Options VFile matter options
- * @property {boolean} [strip=false] Remove the YAML front matter from the file
- * @property {Omit<LoadOptions, 'filename'>} [yaml] Options for the YAML parser
+ * @typedef Options
+ *   Configuration (optional).
+ * @property {boolean} [strip=false]
+ *   Remove the YAML front matter from the file.
+ * @property {YamlOptions} [yaml]
+ *   Options for the YAML parser.
+ *   These are passed as `x` in `yaml.parse('', x)`, which is equivalent to
+ *   `ParseOptions & DocumentOptions & SchemaOptions & ToJsOptions`.
  */
 
 import buffer from 'is-buffer'
-import {load} from 'js-yaml'
+import yaml from 'yaml'
 
 /**
- * Parse the YAML front matter in a [`vfile`](https://github.com/vfile/vfile), and add it as `file.data.matter`.
+ * Parse the YAML front matter in a `vfile`, and add it as `file.data.matter`.
  *
- * If no matter is found in the file, nothing happens, except that `file.data.matter` is set to an empty object (`{}`).
+ * If no matter is found in the file, nothing happens, except that
+ * `file.data.matter` is set to an empty object (`{}`).
  *
  * @template {VFile} File
  * @param {File} file
@@ -31,10 +41,7 @@ export function matter(file, options = {}) {
     /^---(?:\r?\n|\r)(?:([\s\S]*?)(?:\r?\n|\r))?---(?:\r?\n|\r|$)/.exec(doc)
 
   if (match) {
-    file.data.matter = load(
-      match[1],
-      Object.assign({}, yamlOptions, {filename: file.path})
-    )
+    file.data.matter = yaml.parse(match[1], yamlOptions)
 
     if (strip) {
       doc = doc.slice(match[0].length)

package.json

@@ -33,9 +33,8 @@
     "index.js"
   ],
   "dependencies": {
-    "@types/js-yaml": "^4.0.0",
     "is-buffer": "^2.0.0",
-    "js-yaml": "^4.0.0"
+    "yaml": "^2.0.0"
   },
   "devDependencies": {
     "@types/tape": "^4.0.0",

test.js

@@ -1,7 +1,6 @@
 import {Buffer} from 'node:buffer'
 import test from 'tape'
 import buffer from 'is-buffer'
-import {CORE_SCHEMA} from 'js-yaml'
 import {toVFile as vfile} from 'to-vfile'
 import {matter} from './index.js'
 
@@ -42,13 +41,17 @@ test('vfile-matter', function (t) {
   file = matter(vfile(), {strip: true})
   t.ok(file.value === undefined, 'should supporting empties')
 
-  file = matter(vfile({value: '---\ndate: 2021-01-01\n---\n'}), {
-    yaml: {schema: CORE_SCHEMA}
+  file = matter(vfile({value: '---\nyes: no\n---\n'}), {
+    yaml: {version: '1.2'}
+  })
+  t.deepEqual(file.data, {matter: {yes: 'no'}}, 'should pass yaml options (1)')
+  file = matter(vfile({value: '---\nyes: no\n---\n'}), {
+    yaml: {version: '1.1'}
   })
   t.deepEqual(
     file.data,
-    {matter: {date: '2021-01-01'}},
-    'should pass yaml options'
+    {matter: {true: false}},
+    'should pass yaml options (2)'
   )
 
   t.end()