node-karin 0.8.1 → 0.8.2

package/lib/cli/karin.js

@@ -267,8 +267,8 @@ program.command('start').description('启动karin').action(() => cli.start('prod
 program.command('pm2').description('后台运行karin').action(() => cli.start('prod' /* Mode.Prod */, 'js' /* Lang.Js */, 'pm2' /* Runner.Pm2 */))
 program.command('stop').description('停止后台运行').action(() => cli.stop())
 program.command('rs').description('重启pm2服务').action(() => cli.restart())
-program.command('dev').description('TypeScript开发模式').action(() => cli.start('dev' /* Mode.Dev */, 'ts' /* Lang.Ts */, 'tsx' /* Runner.Tsx */))
-program.command('debug').description('JavaScript调试模式').action(() => cli.start('dev' /* Mode.Dev */, 'js' /* Lang.Js */, 'node' /* Runner.Node */))
+program.command('dev').description('JavaScript开发模式').action(() => cli.start('dev' /* Mode.Dev */, 'js' /* Lang.Js */, 'node' /* Runner.Node */))
+program.command('ts').description('TypeScript开发模式').action(() => cli.start('dev' /* Mode.Dev */, 'ts' /* Lang.Ts */, 'tsx' /* Runner.Tsx */))
 program.command('log').description('查看日志').action(() => cli.log())
 program.command('up').description('更新依赖').action(() => cli.update())
 program.parse(process.argv)

package/lib/core/plugin.loader.js

@@ -185,8 +185,9 @@ class PluginLoader {
       } else {
         /** 入口文件 */
         if (common.exists(`${PluginPath}/${rootDir}/index.ts`)) {
-          this.FileList.push({ dir, name: 'index.ts' })
-          this.isDev && this.watchList.push({ dir, name: 'index.ts' })
+          const dirPath = `${dir}/${rootDir}`
+          this.FileList.push({ dir: dirPath, name: 'index.ts' })
+          this.isDev && this.watchList.push({ dir: dirPath, name: 'index.ts' })
           continue
         }
         /** ts源码 */

package/lib/utils/common.d.ts

@@ -5,8 +5,9 @@ import { dirName, fileName, KarinElement, NodeElement } from '../types/index.js'
 /**
  * 常用方法
  */
-export declare const common: {
+declare class Common {
     streamPipeline: (stream1: Readable, stream2: fs.WriteStream) => Promise<void>;
+    constructor();
     /**
      * 休眠函数
      * @param ms 毫秒
@@ -25,7 +26,7 @@ export declare const common: {
      * @param type 请求类型
      * @param param axios参数
      */
-    axios(url: string, type?: "get" | "post", param?: AxiosRequestConfig): Promise<any | null>;
+    axios(url: string, type?: 'get' | 'post', param?: AxiosRequestConfig): Promise<any | null>;
     /**
      * 递归创建目录
      * @param dirname - 要创建的文件夹路径
@@ -159,4 +160,22 @@ export declare const common: {
      * @param - 消息体
      */
     makeMessageLog(message: Array<KarinElement>): string;
-};
+    /**
+     * 更新yaml文件
+     * @param filePath - 文件路径
+     * @param settings - 设置项
+     */
+    updateYaml(filePath: string, settings: {
+        /** 键路径 */
+        key: string;
+        /** 要写入的 */
+        val: any;
+        /** 需要写入的注释 */
+        comment: string;
+    }[]): void;
+}
+/**
+ * 常用方法
+ */
+export declare const common: Common;
+export {};

package/lib/utils/common.js

@@ -1,12 +1,12 @@
 import { promisify } from 'util'
 import { fileURLToPath } from 'url'
 import { pipeline, Readable } from 'stream'
-import { logger, segment } from '../utils/index.js'
+import { logger, segment, YamlEditor } from '../utils/index.js'
 import { fs, path, axios, lodash, yaml as Yaml } from '../modules.js'
 /**
  * 常用方法
  */
-export const common = new (class Common {
+class Common {
   streamPipeline
   constructor () {
     this.streamPipeline = promisify(pipeline)
@@ -398,6 +398,7 @@ export const common = new (class Common {
       'lodash',
       'log4js',
       'moment',
+      'node-karin',
       'node-schedule',
       'redis',
       'ws',
@@ -555,4 +556,33 @@ export const common = new (class Common {
     }
     return logs.join('')
   }
-})()
+
+  /**
+     * 更新yaml文件
+     * @param filePath - 文件路径
+     * @param settings - 设置项
+     */
+  updateYaml (filePath, settings) {
+    let yaml = new YamlEditor(filePath)
+    /** 先添加内容 */
+    settings.forEach(({ key, val }) => {
+      try {
+        if (!yaml.has(key)) { yaml.set(key, val) }
+      } catch { }
+    })
+    /** 先保存 */
+    yaml.save()
+    /** 重新解析 再次写入注释 直接写入注释会报错 写入的不是node节点模式 */
+    yaml = new YamlEditor(filePath)
+    settings.forEach(({ key, comment }) => {
+      try {
+        yaml.comment(key, comment, true)
+      } catch { }
+    })
+    yaml.save()
+  }
+}
+/**
+ * 常用方法
+ */
+export const common = new Common()

package/lib/utils/config.d.ts

@@ -5,21 +5,21 @@ import { Redis, App, Config, Server, Package, GroupCfg } from '../types/index.js
  */
 export declare const config: {
     /**
-     * 根项目绝对路径
+     * 运行目录绝对路径
      */
-    projPath: string;
+    dir: string;
     /**
-     * 根项目配置文件夹路径
+     * 运行目录配置文件夹路径
      */
-    projConfigPath: string;
+    cfgDir: string;
     /**
-     * npm包路径
+     * node-karin npm包路径
      */
-    pkgPath: string;
+    pkgDir: string;
     /**
-     * karin包配置文件夹路径
+     * node-karin 包配置文件夹路径
      */
-    pkgConfigPath: string;
+    pkgCfgDir: string;
     change: Map<string, any>;
     watcher: Map<string, any>;
     review: boolean;
@@ -90,21 +90,21 @@ export declare const config: {
 };
 export declare const Cfg: {
     /**
-     * 根项目绝对路径
+     * 运行目录绝对路径
      */
-    projPath: string;
+    dir: string;
     /**
-     * 根项目配置文件夹路径
+     * 运行目录配置文件夹路径
      */
-    projConfigPath: string;
+    cfgDir: string;
     /**
-     * npm包路径
+     * node-karin npm包路径
      */
-    pkgPath: string;
+    pkgDir: string;
     /**
-     * karin包配置文件夹路径
+     * node-karin 包配置文件夹路径
      */
-    pkgConfigPath: string;
+    pkgCfgDir: string;
     change: Map<string, any>;
     watcher: Map<string, any>;
     review: boolean;

package/lib/utils/config.js

@@ -7,30 +7,30 @@ import { common } from './common.js'
  */
 export const config = new (class Cfg {
   /**
-     * 根项目绝对路径
+     * 运行目录绝对路径
      */
-  projPath
+  dir
   /**
-     * 根项目配置文件夹路径
+     * 运行目录配置文件夹路径
      */
-  projConfigPath
+  cfgDir
   /**
-     * npm包路径
+     * node-karin npm包路径
      */
-  pkgPath
+  pkgDir
   /**
-     * karin包配置文件夹路径
+     * node-karin 包配置文件夹路径
      */
-  pkgConfigPath
+  pkgCfgDir
   change
   watcher
   review
   logger
   constructor () {
-    this.projPath = process.cwd()
-    this.pkgPath = karinDir
-    this.projConfigPath = this.projPath + '/config'
-    this.pkgConfigPath = this.pkgPath + '/config/defSet'
+    this.dir = process.cwd()
+    this.pkgDir = karinDir
+    this.cfgDir = this.dir + '/config'
+    this.pkgCfgDir = this.pkgDir + '/config/defSet'
     /** 缓存 */
     this.change = new Map()
     /** 监听文件 */
@@ -43,17 +43,17 @@ export const config = new (class Cfg {
   /** 初始化配置 */
   async initCfg () {
     const list = [
-      this.projPath + '/temp/input',
-      this.projPath + '/plugins/karin-plugin-example',
-      this.projConfigPath + '/config',
-      this.projConfigPath + '/plugin',
+      this.dir + '/temp/input',
+      this.dir + '/plugins/karin-plugin-example',
+      this.cfgDir + '/config',
+      this.cfgDir + '/plugin',
     ]
     list.forEach(path => this.mkdir(path))
-    if (this.pkgConfigPath !== (this.projConfigPath + '/defSet').replace(/\\/g, '/')) {
-      const files = fs.readdirSync(this.pkgConfigPath).filter(file => file.endsWith('.yaml'))
+    if (this.pkgCfgDir !== (this.cfgDir + '/defSet').replace(/\\/g, '/')) {
+      const files = fs.readdirSync(this.pkgCfgDir).filter(file => file.endsWith('.yaml'))
       files.forEach(file => {
-        const path = `${this.projConfigPath}/config/${file}`
-        const pathDef = `${this.pkgConfigPath}/${file}`
+        const path = `${this.cfgDir}/config/${file}`
+        const pathDef = `${this.pkgCfgDir}/${file}`
         if (!fs.existsSync(path)) { fs.copyFileSync(pathDef, path) }
       })
     }
@@ -64,7 +64,7 @@ export const config = new (class Cfg {
       'temp',
       'resources',
       'temp/html',
-      this.projConfigPath + '/plugin',
+      this.cfgDir + '/plugin',
     ]
     DataList.forEach(path => this.dirPath(path, plugins))
     this.logger = (await import('./logger.js')).default

package/lib/utils/yamlEditor.d.ts

@@ -2,6 +2,7 @@ import Yaml from 'yaml';
 export type YamlValue = string | boolean | number | object | any[];
 export declare class YamlEditor {
     filePath: string;
+    doc: Yaml.Document;
     document: Yaml.Document;
     constructor(file: string);
     /**
@@ -73,13 +74,19 @@ export declare class YamlEditor {
      * @param comment - 要设置的注释
      * @param prepend - 如果为 true，则添加到注释的开头，否则添加到同一行的末尾
      */
-    comment(path: string, comment: string, prepend?: boolean): void;
+    comment(path: string, comment: string, prepend: boolean): void;
     /**
      * 删除指定键的注释
      * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
      * @param type - 要删除的注释类型，`before` 为注释前，`after` 为注释后，`all` 为全部
      */
     uncomment(path: string, type?: 'before' | 'after' | 'all'): void;
+    /**
+     * 检查注释是否存在
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
+     * @param type - 要检查的注释类型，`before` 为注释前，`after` 为注释后
+     */
+    hascomment(path: string, type: 'before' | 'after'): boolean;
     /**
      * 保存文件
      */

package/lib/utils/yamlEditor.js

@@ -9,10 +9,13 @@ import logger from './logger.js'
 import Yaml, { isMap, isSeq, isPair } from 'yaml'
 export class YamlEditor {
   filePath
+  doc
   document
   constructor (file) {
     this.filePath = file
-    this.document = Yaml.parseDocument(fs.readFileSync(file, 'utf8'))
+    const data = Yaml.parseDocument(fs.readFileSync(file, 'utf8'))
+    this.doc = data
+    this.document = data
   }
 
   /**
@@ -217,10 +220,11 @@ export class YamlEditor {
      * @param comment - 要设置的注释
      * @param prepend - 如果为 true，则添加到注释的开头，否则添加到同一行的末尾
      */
-  comment (path, comment, prepend = false) {
+  comment (path, comment, prepend) {
     if (!path) { throw new Error('[YamlEditor] path 不能为空') }
     const pair = this.getpair(path)
     if (!pair) { throw new Error(`[YamlEditor] 未找到节点 ${path}`) }
+    comment = ` ${comment}`
     if (prepend) {
       pair.key.commentBefore = comment
     } else {
@@ -247,11 +251,32 @@ export class YamlEditor {
     }
   }
 
+  /**
+     * 检查注释是否存在
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
+     * @param type - 要检查的注释类型，`before` 为注释前，`after` 为注释后
+     */
+  hascomment (path, type) {
+    if (!path) { throw new Error('[YamlEditor] path 不能为空') }
+    const pair = this.getpair(path)
+    if (!pair) { throw new Error(`[YamlEditor] 未找到节点 ${path}`) }
+    if (type === 'before') {
+      return !!pair.key.commentBefore
+    } else if (type === 'after') {
+      return !!pair.key.comment
+    }
+    return false
+  }
+
   /**
      * 保存文件
      */
   save () {
     try {
+      if (this.doc.toString() === this.document.toString()) {
+        logger.info('[YamlEditor] 文件未更改，无需保存')
+        return
+      }
       fs.writeFileSync(this.filePath, this.document.toString())
       logger.info('[YamlEditor] 文件已保存')
     } catch (error) {

package/package.json

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