node-karin 0.12.15 → 0.12.16

package/lib/index.d.ts

@@ -1,4 +1,3 @@
-import yaml from 'yaml';
 import axios from 'axios';
 import moment from 'moment';
 import lodash from 'lodash';
@@ -11,4 +10,4 @@ export * from './utils/index.js';
 export * from './types/index.js';
 export * from './adapter/index.js';
 export { karin as default } from './core/index.js';
-export { axios, moment, lodash, express, yaml };
+export { axios, moment, lodash, express };

package/lib/index.js

@@ -1,4 +1,3 @@
-import yaml from 'yaml';
 import axios from 'axios';
 import moment from 'moment';
 import lodash from 'lodash';
@@ -11,4 +10,4 @@ export * from './utils/index.js';
 export * from './types/index.js';
 export * from './adapter/index.js';
 export { karin as default } from './core/index.js';
-export { axios, moment, lodash, express, yaml };
+export { axios, moment, lodash, express };

package/lib/utils/index.d.ts

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

package/lib/utils/index.js

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

package/lib/utils/tools/yaml.d.ts

@@ -0,0 +1,15 @@
+import Yaml from 'yaml';
+export declare const yaml: typeof Yaml & {
+    /**
+     * 传入yaml文件路径 自动读取并解析
+     * @param path yaml文件路径
+     */
+    read: (path: string) => any;
+    /**
+     * 保存并写入注释
+     * @param path 保存的路径
+     * @param value 保存的数据
+     * @param commentConfig 注释配置文件路径或json
+     */
+    save: (path: string, value: any, commentConfig?: string) => void;
+};

package/lib/utils/tools/yaml.js

@@ -0,0 +1,43 @@
+import fs from 'fs';
+import Yaml from 'yaml';
+import logger from '../core/logger.js';
+import { YamlEditor } from '../config/yamlEditor.js';
+const yamlNew = {
+    /**
+     * 传入yaml文件路径 自动读取并解析
+     * @param path yaml文件路径
+     */
+    read: (path) => {
+        const data = fs.readFileSync(path, 'utf-8');
+        return Yaml.parse(data);
+    },
+    /**
+     * 保存并写入注释
+     * @param path 保存的路径
+     * @param value 保存的数据
+     * @param commentConfig 注释配置文件路径或json
+     */
+    save: (path, value, commentConfig) => {
+        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);
+        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) {
+                logger.error(`[YamlEditor] 添加注释时出错，已跳过：${error.stack || error.message || error}`);
+            }
+        }
+        fs.writeFileSync(path, editor.document.toString());
+    },
+};
+export const yaml = Object.assign(Yaml, yamlNew);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-karin",
-  "version": "0.12.15",
+  "version": "0.12.16",
   "private": false,
   "description": "基于 Kritor 进行开发的nodejs机器人框架",
   "homepage": "https://github.com/KarinJS/Karin",