npm 包 yaml-or-json 使用教程

什么是 yaml-or-json

yaml-or-json 是一款 Node.js 的 npm 包，它的功能是将 YAML 和 JSON 相互转换。

YAML（Yet Another Markup Language）是一种人类可读写的数据序列化格式，它是 JSON 的一个超集，具有更好的可读性和人性化的特点。

在前端开发中，我们会经常在使用配置文件和数据文件时选择 YAML 或 JSON，但是双方的转换并不方便。yaml-or-json 就是用来解决这个问题的。

安装

要使用 yaml-or-json，首先需要在项目中安装它。

使用 npm 命令进行安装：

npm install -g yaml-or-json

使用方法

yaml-or-json 提供了两个主要的 API：parse 和 stringify。分别用于对 YAML 和 JSON 进行解析和序列化。

解析 YAML

使用 yaml-or-json 解析 YAML 文件很简单，只需要调用 parse 方法并传入 YAML 文件路径即可。例如，我们有一个 YAML 文件 fruits.yaml，其中记录了一些水果的名字和价格：

# fruits.yaml
- name: apple
  price: 3.5
- name: banana
  price: 2.5
- name: cherry
  price: 7.2

我们可以使用如下代码获取 fruits.yaml 文件的内容：

const fs = require('fs');
const { parse } = require('yaml-or-json');

const fruits = parse(fs.readFileSync('./fruits.yaml', 'utf8'));
console.log(fruits);

输出结果：

[ 
  { name: 'apple', price: 3.5 },
  { name: 'banana', price: 2.5 },
  { name: 'cherry', price: 7.2 } 
]

序列化 YAML

反过来，我们也可以使用 yaml-or-json 将 JavaScript 对象序列化为 YAML。这需要调用 stringify 方法并传入一个对象。

例如，我们有一个包含了若干个水果名称和价格的对象：

const fruits = {
  apple: 3.5,
  banana: 2.5,
  cherry: 7.2,
};

我们可以使用如下代码将 fruits 序列化为 YAML：

const { stringify } = require('yaml-or-json');

const fruitsYaml = stringify(fruits, 'yaml');
console.log(fruitsYaml); // 输出为：
// "apple: 3.5\nbanana: 2.5\ncherry: 7.2\n"

也可以指定输出格式为 JSON：

const fruitsJson = stringify(fruits, 'json');
console.log(fruitsJson); // 输出为：{"apple":3.5,"banana":2.5,"cherry":7.2}

解析和序列化 JSON

同样，yaml-or-json 提供了 parseJson 和 stringifyJson 两个 API，分别用于解析和序列化 JSON 数据。

使用方法和 YAML 类似，只需要将 parse 和 stringify 方法的第二个参数改为 'json' 即可。

总结

使用 yaml-or-json，我们可以方便地将 YAML 和 JSON 相互转换，对于项目中需要频繁使用到配置文件和数据文件的场景，这个工具非常有用。

在实际开发中，我们经常会遇到配置文件需要转换成对象，或者需要将对象转换为配置文件的需求，yaml-or-json 就是解决这个问题的好工具。

完整示例代码在本文中已经提供，读者可以自行尝试使用。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/70951