node-karin 0.6.15 → 0.6.17

package/lib/cli/init.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+import { select } from '@inquirer/prompts'
+import { KarinInit } from '../utils/init.js'
+async function main () {
+  /** 捕获错误 打印日志 */
+  process.on('uncaughtException', err => console.error(err))
+  process.on('unhandledRejection', err => console.error(err))
+  const init = new KarinInit()
+  init.init()
+  const prompt = await select({
+    message: '请选择npm源 中国大陆服务器一定要更换!!!',
+    choices: [
+      { name: '淘宝源(推荐)', value: 'https://registry.npmmirror.com' },
+      { name: '官方源', value: 'https://registry.npmjs.org' },
+    ],
+  })
+  /** 结果 */
+  await init.changeRegistry(prompt)
+  const pkg = await select({
+    message: '请选择包管理器 如果不知道怎么选 请选pnpm',
+    choices: [
+      { name: 'pnpm', value: 'pnpm' },
+      { name: 'yarn', value: 'yarn' },
+    ],
+  })
+  /** 结果 */
+  await init.install(pkg)
+}
+main().then(() => process.exit(0)).catch(() => process.exit(0))

package/lib/cli/log.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/lib/cli/log.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+import fs from 'fs'
+import yaml from 'yaml'
+import path from 'path'
+import { spawn } from 'child_process'
+const cwd = process.cwd()
+const _path = path.resolve(cwd + '/config/config/pm2.yaml')
+const data = yaml.parse(fs.readFileSync(_path, 'utf8'))
+const name = data.apps[0].name
+const lines = data.lines || 1000
+const cmd = process.platform === 'win32' ? 'pm2.cmd' : 'pm2'
+spawn(cmd, ['logs', '--lines', lines, name], { stdio: 'inherit', shell: true, cwd })

package/lib/cli/postinstall.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/lib/cli/postinstall.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+import fs from 'fs'
+import { KarinInit } from '../utils/init.js'
+async function main () {
+  /** 捕获错误 打印日志 */
+  process.on('uncaughtException', err => console.error(err))
+  process.on('unhandledRejection', err => console.error(err))
+  /** 在src目录说明为开发环境 不执行任何初始化操作 */
+  if (fs.existsSync('./src')) { return }
+  const init = new KarinInit()
+  init.init()
+  /** 判断锁文件 优先度: pnpm > yarn > cnpm > npm */
+  let pkg
+  if (fs.existsSync('pnpm-lock.yaml')) {
+    pkg = 'pnpm'
+  } else if (fs.existsSync('yarn.lock')) {
+    pkg = 'yarn'
+  } else if (fs.existsSync('cnpm-lock.yaml')) {
+    pkg = 'cnpm'
+  } else {
+    pkg = 'npm'
+  }
+  await init.install(pkg)
+}
+main().then(() => process.exit(0)).catch(() => process.exit(0))

package/lib/utils/init.d.ts

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+export declare class KarinInit {
+    /**
+     * 基础目录
+     */
+    baseDir: string[];
+    constructor();
+    init(): void;
+    /**
+     * 递归创建目录
+     * @param dirname - 路径
+     */
+    mkdir(dirname: string): boolean;
+    /**
+     * 解析json
+     */
+    readJson(file: string): any;
+    /**
+     * 获取插件列表
+     */
+    getPlugins(): string[];
+    /**
+     * 从npm包内复制默认配置出来
+     */
+    copyFile(): Promise<void>;
+    /**
+     * 修改package.json以支持运行
+     */
+    modifyPackage(): void;
+    /**
+     * 更换镜像源为淘宝源
+     */
+    changeRegistry(host: string): Promise<void>;
+    /**
+     * 安装pnpm或者yarn
+     * @param type - 包管理器名称
+     */
+    install(type: 'pnpm' | 'yarn' | 'cnpm' | 'npm'): Promise<void>;
+    /**
+     * 执行命令
+     * @param cmd - 命令
+     */
+    shell(cmd: string): Promise<unknown>;
+    /**
+     * 获取当前的包管理器
+     */
+    getRegistry(): 'pnpm' | 'cnpm' | 'yarn' | 'npm';
+}

package/lib/utils/init.js

@@ -0,0 +1,205 @@
+#!/usr/bin/env node
+import fs from 'fs'
+import path from 'path'
+import { exec } from 'child_process'
+import { karinDir } from '../core/dir.js'
+export class KarinInit {
+  /**
+     * 基础目录
+     */
+  baseDir
+  constructor () {
+    this.baseDir = [
+      './lib',
+      './config/config',
+      './config/defSet',
+      './config/view',
+      './config/plugin',
+      './temp/input',
+      './temp/html',
+      './plugins/karin-plugin-example',
+    ]
+  }
+
+  init () {
+    this.baseDir.forEach(dir => this.mkdir(dir))
+    /** 非src源代码环境才创建 */
+    if (!fs.existsSync('./src')) {
+      this.copyFile()
+      this.modifyPackage()
+    }
+  }
+
+  /**
+     * 递归创建目录
+     * @param dirname - 路径
+     */
+  mkdir (dirname) {
+    if (fs.existsSync(dirname)) { return true }
+    if (this.mkdir(path.dirname(dirname))) { fs.mkdirSync(dirname) }
+    return true
+  }
+
+  /**
+     * 解析json
+     */
+  readJson (file) {
+    return JSON.parse(fs.readFileSync(file, 'utf-8'))
+  }
+
+  /**
+     * 获取插件列表
+     */
+  getPlugins () {
+    const pluginsDir = './plugins'
+    const plugins = fs.readdirSync(pluginsDir)
+    return plugins.filter(dir => dir.startsWith('karin-plugin-'))
+  }
+
+  /**
+     * 从npm包内复制默认配置出来
+     */
+  async copyFile () {
+    /** 配置 */
+    const list = ['config/defSet', 'config/view']
+    list.forEach(dir => {
+      const pkgDir = path.join(karinDir, dir)
+      const projDir = path.join(process.cwd(), dir)
+      /** 清空projDir目录下的文件 保留目录 */
+      if (fs.existsSync(projDir)) { fs.rmdirSync(projDir, { recursive: true }) }
+      /** 读取pkgDir目录下的所有文件 复制到projDir下 */
+      const files = fs.readdirSync(pkgDir).filter(file => file.endsWith('.yaml'))
+      files.forEach(file => {
+        const destPath = path.join(projDir, file)
+        const srcPath = path.join(pkgDir, file)
+        fs.copyFileSync(srcPath, destPath)
+      })
+    })
+    /** 创建pnpm工作区配置 */
+    fs.copyFileSync(path.join(karinDir, 'pnpm-workspace.yaml'), './pnpm-workspace.yaml')
+    /** 为每个插件包创建统一存储的文件夹 */
+    const plugins = this.getPlugins()
+    const DataList = [
+      'data',
+      'temp',
+      'resources',
+      'temp/html',
+      'config/plugin',
+    ]
+    DataList.forEach(_path => {
+      _path = path.join(process.cwd(), _path)
+      plugins.forEach(plugin => this.mkdir(path.join(_path, plugin)))
+    })
+  }
+
+  /**
+     * 修改package.json以支持运行
+     */
+  modifyPackage () {
+    const pkg = this.readJson(path.join(karinDir, 'package.json'))
+    const projPkg = this.readJson('./package.json')
+    delete pkg.bin
+    pkg.main = './node_modules/node-karin/lib/index.js'
+    pkg.dependencies['node-karin'] = 'latest'
+    pkg.dependencies['kritor-proto'] = 'latest'
+    pkg.dependencies = { ...projPkg.dependencies, ...pkg.dependencies }
+    pkg.devDependencies = { ...projPkg.devDependencies, ...pkg.devDependencies }
+    fs.writeFileSync('./package.json', JSON.stringify(pkg, null, 2))
+  }
+
+  /**
+     * 更换镜像源为淘宝源
+     */
+  async changeRegistry (host) {
+    const cmd = `npm config set registry ${host}`
+    // 检查当前镜像源是否为淘宝源
+    const registry = await this.shell('npm config get registry')
+    if (registry === host) {
+      console.log(`当前npm源已经是 ${host} ~`)
+      return
+    }
+    if (!await this.shell(cmd)) {
+      console.log('更换npm源失败，请手动更换npm源！')
+      console.log(`可尝试手动执行 【 npm config set registry ${host} 】 更换镜像源~`)
+    } else {
+      console.log('更换npm源成功~')
+    }
+  }
+
+  /**
+     * 安装pnpm或者yarn
+     * @param type - 包管理器名称
+     */
+  async install (type) {
+    /** 检查是否已经安装对应的包管理器 */
+    if (!this.shell(`${type} -v`)) {
+      console.log(`检测到未安装${type}，开始安装...`)
+      if (!await this.shell(`npm install -g ${type}`)) {
+        console.log(`${type}安装失败，请手动安装${type}！`)
+        console.log(`可尝试手动执行 【 npm install -g ${type} 】 安装${type}~`)
+        return
+      } else {
+        console.log(`${type}安装完成~`)
+      }
+    } else {
+      console.log('检测到已安装pnpm，开始安装依赖...')
+    }
+    /** 安装依赖 */
+    if (!this.shell(`${type} install -P`)) {
+      console.log('安装依赖失败，请手动安装依赖！')
+      console.log(`可尝试手动执行 【 ${type} install -P 】 安装依赖~`)
+      console.log('如中国大陆用户安装失败，请尝试执行换源 【 npm config set registry https://registry.npmmirror.com 】后再安装依赖~')
+    } else {
+      console.log('依赖安装完成~')
+    }
+    /** 检查安装pm2 */
+    if (!this.shell('pm2 -v')) {
+      console.log('检测到未安装pm2，开始安装pm2...')
+      if (!this.shell(`${type} install -g pm2`)) {
+        console.log('安装pm2失败，请手动安装pm2！')
+        console.log('可尝试手动执行 【 npm install -g pm2 】 安装pm2~')
+      } else {
+        console.log('pm2安装完成~')
+      }
+    } else {
+      console.log('检测到已安装pm2~')
+    }
+    console.log('依赖环境初始化完成~')
+  }
+
+  /**
+     * 执行命令
+     * @param cmd - 命令
+     */
+  shell (cmd) {
+    return new Promise(resolve => {
+      exec(cmd, { env: process.env, cwd: process.cwd() }, (err, stdout, stderr) => {
+        if (stdout) { return resolve(stdout.trim()) }
+        if (err) {
+          console.error(err)
+          return resolve(false)
+        }
+        if (stderr) {
+          console.error(stderr)
+          return resolve(false)
+        }
+      })
+    })
+  }
+
+  /**
+     * 获取当前的包管理器
+     */
+  getRegistry () {
+    const { npm_config_user_agent: agent, npm_config_userconfig: userconfig } = process.env
+    if (agent && agent.includes('pnpm')) {
+      return 'pnpm'
+    } else if (userconfig && userconfig.includes('cnpm')) {
+      return 'cnpm'
+    } else if (agent && agent.includes('yarn')) {
+      return 'yarn'
+    } else {
+      return 'npm'
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-karin",
-  "version": "0.6.15",
+  "version": "0.6.17",
   "private": false,
   "description": "基于 Kritor 进行开发的nodejs机器人框架",
   "homepage": "https://github.com/KarinJS/Karin",
@@ -17,7 +17,8 @@
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "bin": {
-    "init": "./lib/tools/init.js"
+    "init": "./lib/cli/init.js",
+    "log": "./lib/cli/log.js"
   },
   "files": [
     "/lib/**/*.js",
@@ -38,32 +39,32 @@
     "app": "node .",
     "build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json && npm run cp && npm run fix",
     "cp": "cp ./lib/modules.d.ts ./modules.d.ts && cp ./lib/modules.js ./modules.js",
+    "debug": "node . --dev",
     "delete": "pm2 delete ./config/config/pm2.yaml",
     "dev": "tsx ./lib/index.js --dev",
-    "debug": "tsx watch ./lib/index.js --dev",
     "fix": "eslint lib/**/*.js --fix",
     "fix:all": "eslint lib/**/*.js --fix && eslint lib/**/*.ts --fix",
-    "init": "node lib/tools/install.js",
-    "init:dev": "node lib/tools/install.js",
-    "init:pack": "node lib/tools/install.js",
-    "log": "node lib/tools/pm2Log.js",
+    "hook": "node lib/cli/hook.js",
+    "init": "node lib/cli/install.js",
+    "postinstall": "node lib/cli/postinstall.js",
+    "log": "node lib/cli/log.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",
-    "uninstall": "node lib/tools/uninstall.js"
+    "stop": "pm2 delete ./config/config/pm2.yaml"
   },
   "dependencies": {
     "@grpc/grpc-js": "1.10.10",
     "@grpc/proto-loader": "0.7.13",
+    "@inquirer/prompts": "5.1.2",
     "art-template": "4.13.2",
     "axios": "1.7.2",
     "chalk": "5.3.0",
     "chokidar": "3.6.0",
     "express": "4.19.2",
-    "kritor-proto": "^1.0.2",
+    "kritor-proto": "latest",
     "level": "8.0.1",
     "lodash": "4.17.21",
     "log4js": "6.9.1",

package/lib/tools/init.js

@@ -1,65 +0,0 @@
-#!/usr/bin/env node
-import fs from 'fs'
-import path from 'path'
-import { karinDir } from '../core/dir.js'
-import { execSync } from 'child_process'
-const pathList = ['./plugins', './config/config', './lib']
-// 创建目录
-pathList.forEach(dir => mkdir(dir))
-function mkdir (dirname) {
-  if (fs.existsSync(dirname)) { return true }
-  if (mkdir(path.dirname(dirname))) { fs.mkdirSync(dirname) }
-  return true
-}
-// 创建 lib 目录并导出 node-karin 模块
-fs.writeFileSync('./lib/index.js', `export * from 'node-karin'`)
-// 删除指定目录并重新创建
-const delList = ['./config/defSet', './config/view']
-delList.forEach(dir => {
-  if (fs.existsSync(dir)) { fs.rmdirSync(dir, { recursive: true }) }
-  mkdir(dir)
-  const root = path.join(karinDir, dir.replace('.', ''))
-  const files = fs.readdirSync(root).filter(file => file.endsWith('.yaml'))
-  files.forEach(file => {
-    const destPath = path.join(dir, file)
-    const srcPath = path.join(root, file)
-    if (!fs.existsSync(destPath)) { fs.copyFileSync(srcPath, destPath) }
-  })
-})
-// 修改 package.json 为 ESM 模块
-const pack = JSON.parse(fs.readFileSync('./package.json', 'utf-8'))
-const npmPack = JSON.parse(fs.readFileSync(path.join(karinDir, 'package.json'), 'utf-8'))
-npmPack.main = './node_modules/node-karin/lib/index.js'
-delete npmPack.bin
-delete npmPack.types
-npmPack.dependencies['node-karin'] = pack.dependencies['node-karin']
-fs.writeFileSync('./package.json', JSON.stringify(npmPack, null, 2))
-// 复制 pnpm-workspace.yaml 到根目录
-fs.copyFileSync(path.join(karinDir, 'pnpm-workspace.yaml'), './pnpm-workspace.yaml')
-// 检查是否安装 pnpm 并安装依赖
-console.log('检查是否安装 pnpm...')
-try {
-  const isPnpm = execSync('pnpm -v', { env: process.env }).toString().trim()
-  if (isPnpm) {
-    console.log('检查到 pnpm，开始安装依赖...')
-  } else {
-    installPnpm()
-  }
-} catch {
-  installPnpm()
-}
-// 安装依赖
-try {
-  execSync('pnpm install -P', { env: process.env, stdio: 'inherit' })
-  console.log('依赖安装完成~')
-} catch {
-  console.log('安装依赖失败，请手动安装依赖！')
-  console.log('可尝试手动执行 【 pnpm install -P 】 安装依赖~')
-  console.log('如中国大陆用户安装失败，请尝试执行换源 【 npm config set registry https://registry.npmmirror.com 】后再安装依赖~')
-}
-console.log('初始化完成~，请通过 【 node . 】 启动程序~')
-function installPnpm () {
-  console.log('未检查到 pnpm，开始安装 pnpm...')
-  execSync('npm --registry=https://registry.npmmirror.com install pnpm -g', { env: process.env, stdio: 'inherit' })
-  console.log('pnpm 安装完成，开始安装依赖...')
-}