glede-init 0.0.1

package/bin/cli.js

@@ -0,0 +1,125 @@
+#!/usr/bin/env bun
+
+import path from 'path';
+import fs from 'fs';
+import { fileURLToPath } from 'url';
+import prompts from 'prompts';
+import { copySync } from '../copy';
+import { version } from '../package.json';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+// ANSI 颜色代码 
+const colors = {
+  reset: "\x1b[0m",
+  bold: "\x1b[1m",
+  dim: "\x1b[2m",
+  underscore: "\x1b[4m",
+  blink: "\x1b[5m",
+  reverse: "\x1b[7m",
+  hidden: "\x1b[8m",
+
+  // 前景色（文本颜色）
+  black: "\x1b[30m",
+  red: "\x1b[31m",
+  green: "\x1b[32m",
+  yellow: "\x1b[33m",
+  blue: "\x1b[34m",
+  magenta: "\x1b[35m",
+  cyan: "\x1b[36m",
+  white: "\x1b[37m",
+  gray: "\x1b[90m",
+
+  // 背景色 
+  bgBlack: "\x1b[40m",
+  bgRed: "\x1b[41m",
+  bgGreen: "\x1b[42m",
+  bgYellow: "\x1b[43m",
+  bgBlue: "\x1b[44m",
+  bgMagenta: "\x1b[45m",
+  bgCyan: "\x1b[46m",
+  bgWhite: "\x1b[47m"
+};
+
+async function initProject() {
+  console.log(`${colors.green} 🚀 Welcome to use GledeServer. cli version ${version}`);
+
+  // 1. 获取项目信息 
+  const response = await prompts([
+    {
+      type: 'text',
+      name: 'projectName',
+      message: '请输入项目名称:',
+      initial: 'my-project',
+      validate: value => value.trim() === '' ? '项目名称不能为空' : true
+    },
+    {
+      type: 'confirm',
+      name: 'installDeps',
+      message: '是否要安装依赖?',
+      initial: true
+    }
+  ]);
+
+  if (!response.projectName) {
+    console.log(`${colors.red} ❌  项目创建已取消`);
+    return;
+  }
+
+  const projectPath = path.join(process.cwd(), response.projectName);
+
+  try {
+    // 2. 创建项目目录 
+    console.log(`${colors.blue} ⏳  正在创建项目目录...`);
+    fs.mkdirSync(projectPath, { recursive: true });
+
+    // 3. 复制模板文件 
+    const templatePath = path.join(__dirname, '../templates/default/.');
+    copySync(templatePath, projectPath);
+
+    // 4. 更新 package.json  中的项目名称 
+    const packageJsonPath = path.join(projectPath, 'package.json');
+    if (fs.existsSync(packageJsonPath)) {
+      const pkg = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
+      pkg.name = response.projectName.toLowerCase().replace(/\s+/g, '-');
+      fs.writeFileSync(packageJsonPath, JSON.stringify(pkg, null, 2));
+    }
+
+    console.log(`${colors.green} ✅  项目 ${response.projectName}创建成功`);
+
+    // 5. 安装依赖 
+    if (response.installDeps) {
+      console.log(`${colors.blue} ⏳  正在安装依赖...`);
+      const installProcess = Bun.spawn(['bun', 'install'], {
+        cwd: projectPath,
+        stdout: 'inherit',
+        stderr: 'inherit'
+      });
+
+      await installProcess.exited;
+
+      if (installProcess.exitCode === 0) {
+        console.log(`${colors.green} ✅   依赖安装成功`);
+      }
+      else {
+        response.installDeps = false;
+        console.log(`${colors.yellow} ⚠️  依赖安装过程中出现错误`);
+      }
+    }
+
+    // 6. 显示完成信息 
+    console.log(`${colors.reset}
+${colors.bold} 🎉  Glede 服务器初始化完成!${colors.reset}
+
+接下来可以执行:
+  ${colors.cyan} cd  ${response.projectName}
+  ${response.installDeps ? '' : `${colors.cyan} bun install`}
+  ${colors.cyan} bun dev ${colors.gray} # 启动开发服务器
+    `);
+  }
+  catch (e) {
+    console.error(colors.red, `❌  项目创建失败: ${e.message}`);
+  }
+}
+
+initProject().catch(console.error); 

package/copy.js

@@ -0,0 +1,94 @@
+import path from 'path';
+import fs from 'fs';
+
+/**
+ * 实现 fs-extra 的 copy 功能（同步版）
+ */
+export function copySync(src, dest, options = {}) {
+  const {
+    preserveTimestamps = true,
+    dereference = false,
+    mode
+  } = options;
+
+  // 规范化路径并解析符号链接（如果需跟随）
+  const resolvedSrc = dereference
+    ? fs.realpathSync(src)
+    : normalizeToPosixPath(src);
+
+  const stats = dereference
+    ? fs.statSync(resolvedSrc)
+    : fs.lstatSync(resolvedSrc);
+
+  // 检查目标路径是否存在 
+  let destExists = false;
+  try {
+    fs.accessSync(dest, fs.constants.F_OK);
+    destExists = true;
+  } catch { }
+
+  // 处理不同类型文件的复制 
+  if (stats.isDirectory()) {
+    copyDirSync(resolvedSrc, dest, { preserveTimestamps, dereference, mode });
+  } else if (stats.isFile() || (stats.isSymbolicLink() && !dereference)) {
+    copyFileSync(resolvedSrc, dest, { preserveTimestamps, mode });
+  } else {
+    throw new Error(`Unsupported file type: ${resolvedSrc}`);
+  }
+}
+
+// 复制单个文件（或符号链接）
+function copyFileSync(src, dest, options) {
+  const { mode, preserveTimestamps } = options;
+
+  // 复制内容（如果是符号链接则创建新链接）
+  if (fs.lstatSync(src).isSymbolicLink()) {
+    const linkTarget = fs.readlinkSync(src);
+    fs.symlinkSync(linkTarget, dest);
+  } else {
+    fs.copyFileSync(src, dest, fs.constants.COPYFILE_FICLONE);
+  }
+
+  // 保留权限 
+  if (mode !== undefined) {
+    fs.chmodSync(dest, mode);
+  } else {
+    fs.chmodSync(dest, fs.statSync(src).mode);
+  }
+
+  // 保留时间戳 
+  if (preserveTimestamps) {
+    const { atime, mtime } = fs.statSync(src);
+    fs.utimesSync(dest, atime, mtime);
+  }
+}
+
+// 递归复制目录 
+function copyDirSync(src, dest, options) {
+  // 创建目标目录 
+  fs.mkdirSync(dest, { recursive: true });
+
+  // 遍历源目录 
+  for (const entry of fs.readdirSync(src)) {
+    const srcEntry = path.join(src, entry);
+    const destEntry = path.join(dest, entry);
+    copySync(srcEntry, destEntry, options); // 递归调用 
+  }
+
+  // 保留目录权限和时间戳 
+  if (options.mode !== undefined) {
+    fs.chmodSync(dest, options.mode);
+  } else {
+    fs.chmodSync(dest, fs.statSync(src).mode);
+  }
+
+  if (options.preserveTimestamps) {
+    const { atime, mtime } = fs.statSync(src);
+    fs.utimesSync(dest, atime, mtime);
+  }
+}
+
+// 工具函数：规范化路径为 POSIX 风格（跨平台一致）
+function normalizeToPosixPath(p) {
+  return path.normalize(p).replace(/\\/g, '/');
+}

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "glede-init",
+  "version": "0.0.1",
+  "type": "module",
+  "bin": {
+    "glede-server-init": "./bin/cli.js"
+  },
+  "files": [
+    "bin",
+    "copy.js",
+    "templates"
+  ],
+  "dependencies": {
+    "prompts": "^2.4.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/templates/default/.editorconfig

@@ -0,0 +1,22 @@
+root = true
+
+[*]
+charset=utf-8
+end_of_line=LF
+insert_final_newline=true
+indent_style=space
+indent_size=2
+max_line_length = 80
+
+[*.{yml,yaml,json}]
+indent_style = space
+indent_size = 2
+
+[*.{js,ts,vue}]
+quote_type = single
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab

package/templates/default/.env

@@ -0,0 +1,2 @@
+# 运行环境
+NODE_ENV=development

package/templates/default/.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+  "recommendations": [
+    "editorconfig.editorconfig"
+  ]
+}

package/templates/default/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "protoc": {
+    "options": [
+      "--proto_path=${workspaceFolder}/protos/model"
+    ]
+  }
+}

package/templates/default/README.md

@@ -0,0 +1,29 @@
+# Default Template
+
+> [glede-server](https://gitee.com/philuo/glede-server-bun)
+
+```
+├── app.ts                      // 服务器启动入口
+├── configs                     // 服务器配置
+│   └── app-config.ts           // 服务器配置文件 支持ts和json格式, 可配置多个用于区分运行时环境
+├── tsconfig.json               // ts编译配置
+├── types                       // ts类型描述
+│   └── global.d.ts             // 全局类型描述
+├── controllers                 // 数据操作对象
+├── protos                      // protobuf子模块, 用于生成proto对应的编解码工具
+├── components                  // 服务通用组件
+├── utils                       // 服务通用工具
+├── crons                       // 定时事务
+├── logs                        // 日志目录
+│   ├── running.log             // 服务运行日志
+│   └── routers.txt             // 注册路由信息树状图
+└── routers                     // 接口目录
+    ├── api                     // /api开头, 用于业务接口
+    ├── common                  // /开头, 用于通用接口
+    └── openapi                 // /openapi开头, 用于开放接口对接三方
+```
+
+## 生成proto编解码工具
+
+- `cd protos`, 阅读[protos/README.md](./protos/README.md)
+- 把`./protos/gen/pb/index.js` 和`./protos/gen/pb/index.d.ts` 拷贝到 `./configs/protos/` 下使用

package/templates/default/app.ts

@@ -0,0 +1,19 @@
+/**
+ * @file 业务服务器
+ * @date 2023-10-30
+ * @author Perfumere
+ */
+
+import { Server } from 'glede-server-bun';
+import { serviceEntry, serviceMount, printServerRunning } from '@/components/service/entry';
+
+// initialize common utils
+serviceEntry();
+
+Server({ conf: 'configs/app-config.ts' }, (_, address: string) => {
+  // 挂载全局工具
+  serviceMount();
+
+  // 打印启动IP:PORT
+  printServerRunning(address);
+});

package/templates/default/components/service/entry.ts

@@ -0,0 +1,85 @@
+/**
+ * @file 服务入口初始化
+ * @author fanchong
+ * @date 2024-05-11
+ */
+
+import { networkInterfaces } from 'os';
+import { logger, CatchExec } from '@/utils/libs';
+import { GledeStaticUtil } from 'glede-server-bun';
+
+/** 应用是否已经初始化, 单个进程内仅执行一次 */
+let loaded = false;
+
+/**
+ * 服务初始化
+ */
+export function serviceEntry() {
+  if (loaded) {
+    return;
+  }
+
+  loaded = true;
+
+  const serverConf = require('@/configs/app-config').default || {};
+
+  /**
+   * 服务启动配置文件
+   */
+  global.serverConf = serverConf;
+  /**
+   * 日志打印工具
+   */
+  global.logger = logger;
+  /**
+   * 传入Promise为之绑定catch方法并返回，设置打印错误日志
+   */
+  global.CatchExec = CatchExec;
+  /**
+   * res_err
+   */
+  global.serr = {
+    params: (msg: string) => ({ code: 1, data: null, msg: String(msg) }),
+    process: (msg: string) => ({ code: 2, data: null, msg: String(msg) }),
+    ban: (msg: string) => ({ code: 3, data: null, msg: String(msg) })
+  };
+}
+
+/**
+ * 服务启动挂载
+ */
+export function serviceMount() {
+  const { getRedisInstance, getPgInstance } = GledeStaticUtil;
+
+  /**
+   * redis实例
+   */
+  global.redis = getRedisInstance();
+  /**
+   * pg实例
+   */
+  global.sql = getPgInstance();
+}
+
+
+
+/**
+ * 打印服务启动访问链接: IP:PORT
+ */
+export function printServerRunning(address: string) {
+  const interfaces = networkInterfaces();
+  let ip = '';
+
+  for (let devName in interfaces) {
+    const iface = interfaces[devName]!;
+    for (let i = 0; i < iface.length; i++) {
+      const alias = iface[i]!;
+
+      if (alias.family === 'IPv4' && alias.address !== '127.0.0.1' && !alias.internal) {
+        ip = alias.address;
+      }
+    }
+  }
+
+  console.log('server: \x1b[32m' + address.replace('0.0.0.0', ip));
+}

package/templates/default/configs/app-config.ts

@@ -0,0 +1,31 @@
+/**
+ * @file 服务器配置
+ * @date 2025-04-26
+ * @author Perfumere
+ */
+
+export default {
+  host: '0.0.0.0',
+  port: 3020,
+  // redis: {
+  //   host: '0.0.0.0'
+  // },
+  // mongodb: {
+  //   url: 'mongodb://localhost:27017/your-db',
+  //   options: {
+  //     autoIndex: true
+  //   }
+  // },
+  // pg: {
+  //   url: 'postgresql://postgres@localhost:5432/heartwork'
+  // },
+  token: {
+    salt: 'glede-server',         // 盐应存放在数据库/环境变量中
+    period: 7200
+  },
+  sign: {
+    salt: 'glede-server',         // 盐1应存放在数据库/环境变量中
+    key: 'UGhpbHVvLW1hbGxqYWRl',  // 同客户端约定的key
+    period: 3600
+  }
+} as GledeServerOpts;

package/templates/default/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "{{name}}",
+  "version": "1.0.0",
+  "private": true,
+  "description": "",
+  "scripts": {
+    "dev": "bun run --watch app.ts",
+    "start": "bun run app.ts"
+  },
+  "dependencies": {
+    "glede-server-bun": "^1.0.20"
+  },
+  "engines": {
+    "bun": "^1.2.10"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.2.10",
+    "typescript": "^5.0.0"
+  }
+}

package/templates/default/protos/README.md

@@ -0,0 +1,35 @@
+# Protos
+
+> 使用protobuf生成`encode`和`decode`
+
+## 生成服务端的编解码工具
+
+```bash
+# ./protos/gen/pb/index.js 和 ./protos/gen/pb/index.d.ts
+bun pb
+```
+
+## 生成客户端的编解码工具
+
+- 支持两种模式生成, 性能模式和min模式
+- 注意: 客户端使用时需要安装 `@protobuf-ts/@protobuf-ts/runtime`
+- 注意: 微信小程序打包后不支持`TextEncoder/TextDecoder`，需要引入polyfill, 请复制`./protos/fast-text-encoding.js`到小程序项目中。
+
+```ts
+// 小程序的入口文件引入polyfill
+import '@/utils/lib/fast-text-encoding';
+```
+
+### 性能模式, 生成的代码性能更好, 文件略大
+
+```bash
+# ./protos/gen/buf-speed/client 和./protos/gen/buf-speed/server
+bun buf
+```
+
+### min模式, 生成的代码性能略差, 文件小, 适合小程序等客户端等场景使用
+
+```bash
+# ./protos/gen/buf-min/client/index.ts 和./protos/gen/buf-min/server/index.ts
+protos bun buf:min
+```

package/templates/default/protos/buf.yaml

@@ -0,0 +1,5 @@
+version: v2
+modules:
+  - path: model
+  # - path: model/common
+  # - path: model/server

package/templates/default/protos/code.gen.yaml

@@ -0,0 +1,11 @@
+# Learn more: https://buf.build/docs/configuration/v2/buf-gen-yaml
+version: v2
+inputs:
+  - directory: model
+plugins:
+  - local: protoc-gen-ts
+    opt:
+      - force_optimize_code_size
+      - keep_enum_prefix
+      - long_type_string
+    out: gen/buf-min

package/templates/default/protos/fast-text-encoding.js

@@ -0,0 +1 @@
+((e)=>{function _(q){var G=0,K=Math.min(65536,q.length+1),J=new Uint16Array(K),M=[],B=0;for(;;){var C=G<q.length;if(!C||B>=K-1){var W=J.subarray(0,B),Y=W;if(M.push(String.fromCharCode.apply(null,Y)),!C)return M.join("");q=q.subarray(G),G=0,B=0}var O=q[G++];if((O&128)===0)J[B++]=O;else if((O&224)===192){var V=q[G++]&63;J[B++]=(O&31)<<6|V}else if((O&240)===224){var V=q[G++]&63,Z=q[G++]&63;J[B++]=(O&31)<<12|V<<6|Z}else if((O&248)===240){var V=q[G++]&63,Z=q[G++]&63,P=q[G++]&63,Q=(O&7)<<18|V<<12|Z<<6|P;if(Q>65535)Q-=65536,J[B++]=Q>>>10&1023|55296,Q=56320|Q&1023;J[B++]=Q}}}function H(q){var G=0,K=q.length,J=0,M=Math.max(32,K+(K>>>1)+7),B=new Uint8Array(M>>>3<<3);while(G<K){var C=q.charCodeAt(G++);if(C>=55296&&C<=56319){if(G<K){var W=q.charCodeAt(G);if((W&64512)===56320)++G,C=((C&1023)<<10)+(W&1023)+65536}if(C>=55296&&C<=56319)continue}if(J+4>B.length){M+=8,M*=1+G/q.length*2,M=M>>>3<<3;var Y=new Uint8Array(M);Y.set(B),B=Y}if((C&4294967168)===0){B[J++]=C;continue}else if((C&4294965248)===0)B[J++]=C>>>6&31|192;else if((C&4294901760)===0)B[J++]=C>>>12&15|224,B[J++]=C>>>6&63|128;else if((C&4292870144)===0)B[J++]=C>>>18&7|240,B[J++]=C>>>12&63|128,B[J++]=C>>>6&63|128;else continue;B[J++]=C&63|128}return B.slice?B.slice(0,J):B.subarray(0,J)}function $(){this.encoding="utf-8"}$.prototype.encode=function(q,G){return H(q)};var R=typeof Blob==="function"&&typeof URL==="function"&&typeof URL.createObjectURL==="function",X=["utf-8","utf8","unicode-1-1-utf-8"],N=_;if(R)N=(q)=>_(q);var z="construct 'TextDecoder'",D=`Failed to ${z}: the `;function A(q,G){q=q||"utf-8";var K=X.indexOf(q.toLowerCase())!==-1;if(!K)throw new RangeError(`${D} encoding label provided ('${q}') is invalid.`);this.encoding=q,this.fatal=!1,this.ignoreBOM=!1}A.prototype.decode=function(q,G){var K;if(q instanceof Uint8Array)K=q;else if(q.buffer instanceof ArrayBuffer)K=new Uint8Array(q.buffer);else K=new Uint8Array(q);return N(K,this.encoding)};e.TextEncoder=e.TextEncoder||$;e.TextDecoder=e.TextDecoder||A;})(globalThis);

package/templates/default/protos/gen/buf-min/client/index.ts

@@ -0,0 +1,87 @@
+// @generated by protobuf-ts 2.9.6 with parameter force_optimize_code_size,keep_enum_prefix,long_type_string
+// @generated from protobuf file "client/index.proto" (package "client", syntax proto3)
+// tslint:disable
+import { MessageType } from "@protobuf-ts/runtime";
+/**
+ * 客户端指令消息
+ *
+ * @generated from protobuf message client.ClientDirective
+ */
+export interface ClientDirective {
+    /**
+     * @generated from protobuf field: client.ClientOptEnum option = 1;
+     */
+    option: ClientOptEnum; // 指令类型
+    /**
+     * 以下字段根据option类型选择性填充
+     *
+     * @generated from protobuf field: string ack_id = 2;
+     */
+    ackId: string; // 用于匹配后端回执
+    /**
+     * @generated from protobuf field: string cid = 3;
+     */
+    cid: string; // 会话记录ID(CLIENT_RELOAD/CLIENT_STOP/CLIENT_INTERACTION/CLIENT_EXPECT_ANSWER)
+    /**
+     * @generated from protobuf field: string content = 4;
+     */
+    content: string; // 用户问题/期望答案 (CLIENT_ASK/CLIENT_EXPECT_ANSWER)
+    /**
+     * @generated from protobuf field: string task_id = 5;
+     */
+    taskId: string; // 任务id (CLIENT_INTERACTION)
+    /**
+     * @generated from protobuf field: map<string, string> data = 6;
+     */
+    data: {
+        [key: string]: string;
+    }; // 用户交互数据 (CLIENT_INTERACTION)
+}
+/**
+ * 指令类型枚举
+ *
+ * @generated from protobuf enum client.ClientOptEnum
+ */
+export enum ClientOptEnum {
+    /**
+     * @generated from protobuf enum value: UNKNOWN = 0;
+     */
+    UNKNOWN = 0,
+    /**
+     * @generated from protobuf enum value: CLIENT_ASK = 1;
+     */
+    CLIENT_ASK = 1,
+    /**
+     * @generated from protobuf enum value: CLIENT_INTERACTION = 2;
+     */
+    CLIENT_INTERACTION = 2,
+    /**
+     * @generated from protobuf enum value: CLIENT_RELOAD = 3;
+     */
+    CLIENT_RELOAD = 3,
+    /**
+     * @generated from protobuf enum value: CLIENT_STOP = 4;
+     */
+    CLIENT_STOP = 4,
+    /**
+     * @generated from protobuf enum value: CLIENT_EXPECT_ANSWER = 5;
+     */
+    CLIENT_EXPECT_ANSWER = 5
+}
+// @generated message type with reflection information, may provide speed optimized methods
+class ClientDirective$Type extends MessageType<ClientDirective> {
+    constructor() {
+        super("client.ClientDirective", [
+            { no: 1, name: "option", kind: "enum", T: () => ["client.ClientOptEnum", ClientOptEnum] },
+            { no: 2, name: "ack_id", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
+            { no: 3, name: "cid", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
+            { no: 4, name: "content", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
+            { no: 5, name: "task_id", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
+            { no: 6, name: "data", kind: "map", K: 9 /*ScalarType.STRING*/, V: { kind: "scalar", T: 9 /*ScalarType.STRING*/ } }
+        ]);
+    }
+}
+/**
+ * @generated MessageType for protobuf message client.ClientDirective
+ */
+export const ClientDirective = new ClientDirective$Type();