npm 包 formatted 使用教程

介绍

formatted 是一个轻量级的 npm 包，用于格式化 JSON 和 YAML 文件。它能够将 JSON 和 YAML 文件转换成易于阅读和编辑的字符串形式，同时还支持在 JSON 和 YAML 文件之间进行转换。该包适用于前端和后端开发人员，旨在提高开发效率和代码质量。

安装

formatted 可以使用 npm 安装：

npm install formatted --save

使用

格式化 JSON 文件

要格式化 JSON 文件，只需将文件路径作为 formatted 函数的参数传递即可：

const formatted = require('formatted');
let json = formatted('./data.json');
console.log(json);

此时，formatted 函数会读取 data.json 文件并将其格式化为易于阅读的字符串形式，并将该字符串形式作为函数的返回值。输出结果如下所示：

-- -------------------- ---- -------
-
  ------- -------
  ------ ---
  -------- ----------------------
  ---------- -
    ----------
    ----------
  -
-

格式化 YAML 文件

要格式化 YAML 文件，只需将文件路径作为 formatted 函数的参数传递，并且将第二个参数设置为 'yaml'，即可：

const formatted = require('formatted');
let yaml = formatted('./data.yaml', 'yaml');
console.log(yaml);

此时，formatted 函数会读取 data.yaml 文件并将其格式化为易于阅读的字符串形式，并将该字符串形式作为函数的返回值。输出结果如下所示：

name: Lucy
age: 26
email: example@example.com
hobbies:
  - reading
  - swimming

将 JSON 文件转换为 YAML 文件

要将 JSON 文件转换为 YAML 文件，只需将源文件路径和目标文件路径作为 formatted 函数的参数传递，并且将第三个参数设置为 'yaml'，即可：

const formatted = require('formatted');
formatted('./data.json', './data.yaml', 'yaml');

此时，formatted 函数会读取 data.json 文件并将其转换为 YAML 文件，并将该文件保存到 data.yaml 文件中。

将 YAML 文件转换为 JSON 文件

要将 YAML 文件转换为 JSON 文件，只需将源文件路径和目标文件路径作为 formatted 函数的参数传递，并且不传递第三个参数，即可：

const formatted = require('formatted');
formatted('./data.yaml', './data.json');

此时，formatted 函数会读取 data.yaml 文件并将其转换为 JSON 文件，并将该文件保存到 data.json 文件中。

总结

formatted 是一个功能强大、易于使用的 npm 包，它可以帮助开发人员在日常工作中提高效率和代码质量。本文介绍了 formatted 的安装和使用方法，并给出了相应的示例代码。我们相信通过学习本文，您会对 formatted 有更深入的了解，并能够将其应用于实际的开发工作中。

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