fix: 增加yaml.read yaml.save

src/index.ts

@@ -1,4 +1,3 @@
-import yaml from 'yaml'
 import axios from 'axios'
 import moment from 'moment'
 import lodash from 'lodash'
@@ -13,4 +12,4 @@ export * from 'karin/types'
 export * from 'karin/adapter'
 export { karin as default } from 'karin/core'
 
-export { axios, moment, lodash, express, yaml }
+export { axios, moment, lodash, express }

src/utils/index.ts

@@ -11,3 +11,4 @@ export * from './core/logger'
 export * from './config/updateVersion'
 export * from './tools/restart'
 export * from './tools/stop'
+export * from './tools/yaml'

src/utils/tools/yaml.ts

@@ -0,0 +1,48 @@
+import fs from 'fs'
+import Yaml from 'yaml'
+import logger from '../core/logger'
+import { YamlEditor } from '../config/yamlEditor'
+
+type Comment = Record<string, string | { type: 'start' | 'end'; text: string }>
+
+const yamlNew = {
+  /**
+   * 传入yaml文件路径 自动读取并解析
+   * @param path yaml文件路径
+   */
+  read: (path: string) => {
+    const data = fs.readFileSync(path, 'utf-8')
+    return Yaml.parse(data)
+  },
+  /**
+   * 保存并写入注释
+   * @param path 保存的路径
+   * @param value 保存的数据
+   * @param commentConfig 注释配置文件路径或json
+   */
+  save: (path: string, value: any, commentConfig?: string) => {
+    if (!commentConfig) {
+      fs.writeFileSync(path, Yaml.stringify(value))
+      return
+    }
+
+    const editor = new YamlEditor(Yaml.stringify(value))
+    const comment = JSON.parse(fs.existsSync(commentConfig) ? fs.readFileSync(commentConfig, 'utf8') : commentConfig) as Comment
+
+    for (const [key, value] of Object.entries(comment)) {
+      try {
+        if (typeof value === 'object') {
+          editor.comment(key, value.text, value.type === 'start')
+        } else if (typeof value === 'string') {
+          editor.comment(key, value, true)
+        }
+      } catch (error: any) {
+        logger.error(`[YamlEditor] 添加注释时出错，已跳过：${error.stack || error.message || error}`)
+      }
+    }
+
+    fs.writeFileSync(path, editor.document.toString())
+  },
+}
+
+export const yaml = Object.assign(Yaml, yamlNew)