Node.js如何实现带注释的YAML序列化与反序列化？

目前Node.js生态中有可以满足该需求的第三方工具，以下是两个常用的可选方案：

方案1：使用yaml-comment包 #

这个包是专门为保留YAML注释的读写场景开发的，完整支持你需要的能力：

• 读取YAML文件时会将注释和对应配置项关联，最终导出为可直接操作的普通JS对象
• 修改JS对象后序列化回写YAML时，会自动保留原有注释，新增的配置项也支持自定义添加注释
• 基础使用示例：

const { load, dump } = require('yaml-comment');
const fs = require('node:fs');

// 加载带注释的YAML内容到JS对象
const rawYaml = fs.readFileSync('./app-config.yml', 'utf8');
const config = load(rawYaml);

// 正常操作JS对象
config.database.host = '192.168.1.100';
config.app.debug = false;

// 回写文件，原有注释全部保留
fs.writeFileSync('./app-config.yml', dump(config));

方案2：使用yaml-ast-parser自定义实现 #

如果你有更复杂的定制需求，可以基于YAML抽象语法树实现：

• 用yaml-ast-parser解析YAML得到完整AST，所有注释、缩进、换行等格式信息都会保留在AST节点中
• 自行修改对应配置节点的value后，再基于AST生成最终的YAML内容，可以100%还原原文件的格式和注释

内容的提问来源于stack exchange，提问作者Tembero