node-karin 0.0.3

package/lib/utils/update.d.ts

@@ -0,0 +1,69 @@
+import fs from 'fs';
+declare const _default: {
+    dir: string;
+    /**
+     * 获取插件列表 拥有packageon才会被识别
+     * @returns {string[]}
+     */
+    getPlugins(): string[];
+    /**
+     * 更新框架或插件
+     * @param path - 插件相对路径
+     * @param cmd - 更新命令 默认git pull
+     * @param time - 超时时间 默认120s
+     */
+    update(path: string, cmd?: string, time?: number): Promise<{
+        status: string;
+        data: string;
+    }>;
+    /**
+     * 获取指定仓库最后一次提交时间日期
+     * @param path - 插件相对路径
+     */
+    getTime(path: string): Promise<string>;
+    /**
+     * 获取指定仓库最后一次提交哈希值
+     * @param {string} path - 插件相对路径
+     * @param {boolean} [short] - 是否获取短哈希 默认true
+     * @returns {Promise<string>}
+     */
+    getHash(path: string, short?: boolean): Promise<string>;
+    /**
+     * 获取指定仓库的提交记录
+     * @param {{
+     *  path: string,
+     *  count?: number,
+     *  hash?: string
+     * }} options - 参数
+     * @param {string} options.path - 插件相对路径
+     * @param {number} [options.count] - 获取日志条数 默认1条
+     * @param {string} [options.hash] - 指定HEAD
+     * @returns {Promise<string>}
+     */
+    getCommit(options: {
+        path: any;
+        count?: any;
+        hash?: any;
+        branch?: any;
+    }): Promise<string>;
+    /**
+     * 检查插件是否有更新
+     * @param {string} path - 插件相对路径
+     * @param {number} [time] - 超时时间 默认120s
+     * @returns {Promise<{status: 'ok'|'failed', data: string|boolean}>}
+     */
+    checkUpdate(path: fs.PathLike, time?: number): Promise<{
+        status: string;
+        data: string | undefined;
+        count?: undefined;
+    } | {
+        status: string;
+        data: boolean;
+        count?: undefined;
+    } | {
+        status: string;
+        data: string;
+        count: string | number;
+    }>;
+};
+export default _default;

package/lib/utils/update.js

@@ -0,0 +1,151 @@
+import fs from 'fs'
+import exec from './exec.js'
+export default new (class Update {
+  dir
+  constructor () {
+    this.dir = './plugins'
+  }
+
+  /**
+     * 获取插件列表 拥有packageon才会被识别
+     * @returns {string[]}
+     */
+  getPlugins () {
+    const list = []
+    const files = fs.readdirSync(this.dir, { withFileTypes: true })
+    /** 忽略非文件夹、非karin-plugin-开头的文件夹或/karin-adapter-开头的文件夹 */
+    files.forEach(file => {
+      if (!file.isDirectory()) { return }
+      if (!file.name.startsWith('karin-plugin-') && !file.name.startsWith('karin-adapter-')) { return }
+      if (!fs.existsSync(`${this.dir}/${file.name}/packageon`)) { return }
+      list.push(file.name)
+    })
+    return list
+  }
+
+  /**
+     * 更新框架或插件
+     * @param path - 插件相对路径
+     * @param cmd - 更新命令 默认git pull
+     * @param time - 超时时间 默认120s
+     */
+  async update (path, cmd = 'git pull', time = 120) {
+    /** 检查一下路径是否存在 */
+    if (!fs.existsSync(path)) { return { status: 'failed', data: '路径不存在' } }
+    /** 检查是否有.git文件夹 */
+    if (!fs.existsSync(`${path}/.git`)) { return { status: 'failed', data: '该路径不是一个git仓库' } }
+    /** 设置超时时间 */
+    const timer = setTimeout(() => {
+      return { status: 'failed', data: '执行超时' }
+    }, time * 1000)
+    const options = { env: process.env, cwd: path, encoding: 'utf-8' }
+    /** 记录当前短哈希 */
+    const hash = await this.getHash(path)
+    /** 执行更新 */
+    const { status, error } = await exec(cmd, true, options)
+    /** 执行成功 */
+    if (status === 'ok') {
+      clearTimeout(timer)
+      /** 再次获取短哈希 查看是否有更新 */
+      const newHash = await this.getHash(path)
+      if (hash === newHash) {
+        const time = await this.getTime(path)
+        return {
+          status: 'ok',
+          data: ['\n当前版本已是最新版本', `Hash: ${hash}`, `最后更新：${await this.getCommit({ path, count: 1 })}`, `最后提交时间：${time}`].join('\n'),
+        }
+      }
+      const Commit = await this.getCommit({ path, hash })
+      return {
+        status: 'ok',
+        data: ['\n更新成功', `当前Hash: ${newHash}`, `更新日志：\n${Commit}`].join('\n'),
+      }
+    }
+    const msg = ['\n更新失败', `当前Hash: ${hash}`, `错误信息：${error?.message?.toString() || error?.stack?.toString() || error?.toString()}`, '请解决错误后重试或执行【#强制更新】']
+    return { status: 'failed', data: msg.join('\n') }
+  }
+
+  /**
+     * 获取指定仓库最后一次提交时间日期
+     * @param path - 插件相对路径
+     */
+  async getTime (path) {
+    const cmd = 'git log -1 --format=%cd --date=format:"%Y-%m-%d %H:%M:%S"'
+    const data = await exec(cmd, false, { cwd: path, encoding: 'utf-8' })
+    if (data.status === 'failed') { return '获取时间失败，请重试或更新Git~' }
+    return data.stdout.trim()
+  }
+
+  /**
+     * 获取指定仓库最后一次提交哈希值
+     * @param {string} path - 插件相对路径
+     * @param {boolean} [short] - 是否获取短哈希 默认true
+     * @returns {Promise<string>}
+     */
+  async getHash (path, short = true) {
+    const cmd = short ? 'git rev-parse --short HEAD' : 'git rev-parse HEAD'
+    const data = await exec(cmd, false, { cwd: path, encoding: 'utf-8' })
+    if (data.status === 'failed') {
+      const text = data.error
+      throw new Error(text)
+    }
+    return data.stdout.trim()
+  }
+
+  /**
+     * 获取指定仓库的提交记录
+     * @param {{
+     *  path: string,
+     *  count?: number,
+     *  hash?: string
+     * }} options - 参数
+     * @param {string} options.path - 插件相对路径
+     * @param {number} [options.count] - 获取日志条数 默认1条
+     * @param {string} [options.hash] - 指定HEAD
+     * @returns {Promise<string>}
+     */
+  async getCommit (options) {
+    const { path, count = 1, hash, branch } = options
+    let cmd = `git log -${count} --format="[%ad]%s %n" --date="format:%m-%d %H:%M"`
+    /** 键入HEAD */
+    if (hash) { cmd = `git log ${hash}..HEAD --format="[%ad] %s %n" --date="format:%m-%d %H:%M"` }
+    /** 指定分支 */
+    if (branch) { cmd = `git log -${count} ${branch} --format="[%ad] %s %n" --date="format:%m-%d %H:%M"` }
+    const data = await exec(cmd, false, { cwd: path, encoding: 'utf-8' })
+    if (data.status === 'failed') {
+      const text = data.error
+      throw new Error(text)
+    }
+    return data.stdout.trim()
+  }
+
+  /**
+     * 检查插件是否有更新
+     * @param {string} path - 插件相对路径
+     * @param {number} [time] - 超时时间 默认120s
+     * @returns {Promise<{status: 'ok'|'failed', data: string|boolean}>}
+     */
+  async checkUpdate (path, time = 120) {
+    /** 检查一下路径是否存在 */
+    if (!fs.existsSync(path)) { return { status: 'failed', data: '路径不存在' } }
+    /** 检查是否有.git文件夹 */
+    if (!fs.existsSync(`${path}/.git`)) { return { status: 'failed', data: '该路径不是一个git仓库' } }
+    /** 设置超时时间 */
+    const timer = setTimeout(() => {
+      return { status: 'failed', data: '执行超时' }
+    }, time * 1000)
+    const options = { env: process.env, cwd: path, encoding: 'utf-8' }
+    /** git fetch origin */
+    const { status, error } = await exec('git fetch origin', false, options)
+    if (status === 'failed') { return { status: 'failed', data: error?.message } }
+    /** git status -uno */
+    const { stdout } = await exec('git status -uno', false, options)
+    clearTimeout(timer)
+    /** 检查是否有更新 没更新直接返回 */
+    if (stdout.includes('Your branch is up to date with')) { return { status: 'ok', data: false } }
+    /** 获取落后几次更新 */
+    const count = stdout.match(/Your branch is behind '.*' by (\d+) commits/)?.[1] || 1
+    const data = await this.getCommit({ path, count, branch: 'origin' })
+    return { status: 'ok', data, count }
+  }
+})()

package/lib/utils/updateVersion.d.ts

@@ -0,0 +1,33 @@
+export default class Version {
+    path: string;
+    packageDir: string;
+    CHANGELOGDir: string;
+    packageJson: any;
+    version: string;
+    commitsMap: {
+        [key: string]: string[];
+    };
+    HEAD: string;
+    cmd: string;
+    stdout: string | string[];
+    url: string;
+    constructor(path: string);
+    init(): Promise<void>;
+    /**
+     * 获取当前仓库最新的一个标签的HEAD
+     */
+    gitTag(): Promise<false | undefined>;
+    /**
+     * 获取当前仓库的远程地址
+     */
+    gitUrl(): Promise<void>;
+    /**
+     * 更新版本号 tag
+     */
+    updateVersion(): Promise<void>;
+    /**
+     * 封装exce方法
+     * @param {string} cmd 执行的命令
+     */
+    exce(cmd: string): Promise<string>;
+}

package/lib/utils/updateVersion.js

@@ -0,0 +1,145 @@
+import fs from 'fs'
+import { exec } from 'child_process'
+export default class Version {
+  path
+  packageDir
+  CHANGELOGDir
+  packageJson
+  version
+  commitsMap
+  HEAD
+  cmd
+  stdout
+  url
+  constructor (path) {
+    this.cmd = ''
+    this.stdout = ''
+    this.url = ''
+    this.HEAD = ''
+    this.path = path
+    this.packageDir = this.path + '/packageon'
+    this.CHANGELOGDir = this.path + '/CHANGELOG.md'
+    this.packageJson = JSON.parse(fs.readFileSync(this.packageDir, 'utf-8'))
+    this.version = this.packageJson.version
+    this.commitsMap = {
+      release: ['### Releases'],
+      feat: ['### 新增功能'],
+      fix: ['### Bug修复'],
+      docs: ['### 文档更新'],
+      style: ['### 代码样式修改'],
+      refactor: ['### 代码重构'],
+      perf: ['### 性能优化'],
+      chore: ['### 构建工具相关'],
+      revert: ['### 回滚'],
+      others: ['### 其他提交'],
+    }
+  }
+
+  async init () {
+    /** 获取仓库地址 */
+    await this.gitUrl()
+    /** 取tag对应的head */
+    await this.gitTag()
+    const HEAD = this.HEAD ? `${this.HEAD}..HEAD ` : ''
+    this.cmd = `git log ${HEAD}--pretty=format:"HEAD: %H=分割=sha: %h=分割=log: %s"`
+    this.stdout = (await this.exce(this.cmd))
+    if (!this.stdout) { throw new Error('commit为空...') }
+    this.stdout = this.stdout.trim().split('\n')
+    const reg = /(fix|feat|docs|style|refactor|perf|release|chore|revert)(:|：)/i
+    for (const commit of this.stdout) {
+      /** 拆分 */
+      const [HEAD, sha, log] = commit.split('=分割=').map(item => item.trim().replace(/^(HEAD|sha|log): /, ''))
+      /** 排除此项 */
+      if (log.startsWith('Merge branch')) { continue }
+      const match = log.match(reg)
+      const type = match ? match[1].toLowerCase() : 'others'
+      /** 拼接commit */
+      const info = `- ${log} ([${sha}](${this.url}/commit/${HEAD}))`
+      this.commitsMap[type].push(info)
+    }
+    /** 更新版本号 */
+    await this.updateVersion()
+    /** YYYY-MM-DD */
+    const date = new Date().toLocaleDateString().replace(/\//g, '-')
+    const text = [`## ${this.version} (${date})`]
+    for (const key in this.commitsMap) {
+      /** 排除空 */
+      if (this.commitsMap[key].length === 1) {
+        delete this.commitsMap[key]
+        continue
+      }
+      text.push(this.commitsMap[key].join('\n'))
+    }
+    /** 判断是否有CHANGELOG.md文件 */
+    if (fs.existsSync(this.CHANGELOGDir)) {
+      const oldText = fs.readFileSync(this.CHANGELOGDir, 'utf-8')
+      text.push(oldText)
+    }
+    fs.writeFileSync(this.CHANGELOGDir, text.join('\n\n'))
+    console.log('更新成功~')
+  }
+
+  /**
+     * 获取当前仓库最新的一个标签的HEAD
+     */
+  async gitTag () {
+    const cmd = 'git tag'
+    const stdout = await this.exce(cmd)
+    if (!stdout) { return false }
+    const tags = stdout.trim().split('\n')
+    const lastTag = tags[tags.length - 1]
+    const cmd2 = `git rev-list -n 1 ${lastTag}`
+    const HEAD = await this.exce(cmd2)
+    this.HEAD = HEAD.trim()
+  }
+
+  /**
+     * 获取当前仓库的远程地址
+     */
+  async gitUrl () {
+    const cmd = 'git remote -v'
+    const stdout = await this.exce(cmd)
+    let [url] = stdout.split('\n').map(item => item.split('\t')[1])
+    url = url.trim().split(' ')[0]
+    this.url = url
+  }
+
+  /**
+     * 更新版本号 tag
+     */
+  async updateVersion () {
+    /** 10进1 */
+    const versionArr = this.version.split('.').map((item) => parseInt(item))
+    if (versionArr[2] === 9) {
+      versionArr[1]++
+      versionArr[2] = 0
+    } else {
+      versionArr[2]++
+    }
+    this.version = versionArr.join('.')
+    this.packageJson.version = this.version
+    fs.writeFileSync(this.packageDir, JSON.stringify(this.packageJson, null, 2))
+    /** tag */
+    try {
+      await this.exce(`git tag v${this.version}`)
+    } catch (e) {
+      console.log('tag已存在')
+    }
+  }
+
+  /**
+     * 封装exce方法
+     * @param {string} cmd 执行的命令
+     */
+  exce (cmd) {
+    return new Promise((resolve, reject) => {
+      exec(cmd, { cwd: this.path }, (error, stdout) => {
+        if (error) {
+          reject(error)
+          return
+        }
+        resolve(stdout)
+      })
+    })
+  }
+}

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "node-karin",
+  "version": "0.0.3",
+  "private": false,
+  "homepage": "https://github.com/KarinJS/Karin#readme",
+  "bugs": {
+    "url": "https://github.com/KarinJS/Karin/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/KarinJS/Karin.git"
+  },
+  "author": "Karin",
+  "type": "module",
+  "imports": {
+    "#Karin": "./lib/index.js"
+  },
+  "main": "./lib/index.js",
+  "license": "GPL-3.0-only",
+  "files": [
+    "/lib/**/*.js",
+    "/lib/**/*.d.ts",
+    "/config/defSet/*.yaml",
+    "/config/view/*.yaml",
+    "LICENSE",
+    "package.json",
+    "README.md"
+  ],
+  "workspaces": [
+    "plugins/**"
+  ],
+  "scripts": {
+    "app": "node .",
+    "build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json && npm run fix",
+    "delete": "pm2 delete ./config/config/pm2.yaml",
+    "fix": "npx eslint lib/**/*.js --fix",
+    "init": "node lib/tools/install.js",
+    "init:dev": "node lib/tools/install.js",
+    "init:pack": "node lib/tools/install.js",
+    "js": "node .",
+    "js:dev": "node . --dev",
+    "log": "node lib/tools/pm2Log.js",
+    "monit": "pm2 monit",
+    "pub": "npm publish --access public",
+    "restart": "pm2 restart ./config/config/pm2.yaml",
+    "sort:pack": "npx sort-package-json",
+    "start": "pm2 start ./config/config/pm2.yaml && pm2 monit",
+    "stop": "pm2 delete ./config/config/pm2.yaml",
+    "ts": "tsx ./src/index.ts --dev",
+    "ts:dev": "tsx ./src/index.ts --dev",
+    "uninstall": "node lib/tools/uninstall.js",
+    "ver": "node lib/tools/updateVersion.js"
+  },
+  "dependencies": {
+    "@grpc/grpc-js": "1.10.10",
+    "@grpc/proto-loader": "0.7.13",
+    "art-template": "4.13.2",
+    "axios": "1.7.2",
+    "chalk": "5.3.0",
+    "chokidar": "3.6.0",
+    "express": "4.19.2",
+    "kritor-proto": "^0.0.6",
+    "level": "8.0.1",
+    "lodash": "4.17.21",
+    "log4js": "6.9.1",
+    "moment": "2.30.1",
+    "node-schedule": "2.1.1",
+    "redis": "4.6.14",
+    "ws": "8.16.0",
+    "yaml": "2.4.1"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "@types/lodash": "^4.17.5",
+    "@types/node": "^20.14.8",
+    "@types/node-schedule": "^2.1.7",
+    "@types/ws": "8.5.10",
+    "eslint": "9.5.0",
+    "neostandard": "^0.7.2",
+    "sort-package-json": "^2.10.0",
+    "tsc-alias": "^1.8.10",
+    "tsx": "^4.15.7",
+    "typescript": "^4.9.5"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}