create-nserve 1.0.0

package/README.md

@@ -0,0 +1,29 @@
+# @aicblock/nserve
+
+![npm](https://img.shields.io/npm/v/@aicblock/nserve)
+![npm](https://img.shields.io/npm/dm/@aicblock/nserve)
+![NPM](https://img.shields.io/npm/l/@aicblock/nserve)
+
+#### Description
+
+🛠️ Description NodeJS Server-side development CLI
+
+#### 快速搭建第一个 Nserve 项目
+
+#### 使用 NPM:
+
+```sh
+$ npm create nserve@latest
+```
+
+#### 使用 Yarn:
+
+```sh
+$ yarn create nserve@latest
+```
+
+#### 使用 PNPM:
+
+```sh
+$ pnpm create  nserve@latest
+```

package/bin/index.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+
+const fs = require('fs-extra')
+const path = require('path')
+const prompts = require('prompts')
+const { version: nserveVersion } = require('../package.json')
+
+async function init() {
+  // 1. 获取用户输入
+  const response = await prompts([
+    {
+      type: 'text',
+      name: 'projectName',
+      message: '项目名称?',
+      initial: 'my-project'
+    }
+  ])
+
+  // 2. 定义路径
+  const templateDir = path.join(__dirname, '../template')
+  const targetDir = path.join(process.cwd(), response.projectName)
+
+  // 3. 复制模板文件
+  await fs.copy(templateDir, targetDir)
+
+  // 4. 修改 package.json 中的项目名
+  const pkgPath = path.join(targetDir, 'package.json')
+  const pkg = require(pkgPath)
+  pkg.name = response.projectName
+  pkg.devDependencies['@aicblock/nserve'] = nserveVersion
+  await fs.writeJson(pkgPath, pkg, { spaces: 2 })
+
+  console.log('项目创建成功!')
+}
+
+init().catch(console.error)

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "create-nserve",
+  "version": "1.0.0",
+  "main": "bin/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "nserve",
+    "create-app",
+    "aicblock"
+  ],
+  "bin": {
+    "create-nserve": "./bin/index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/aiclouddigit/nserve.git"
+  },
+  "files": [
+    "bin",
+    "template"
+  ],
+  "author": "jieyang;damon yang",
+  "license": "MIT",
+  "description": "NodeJS Server-side development CLI template",
+  "dependencies": {
+    "fs-extra": "^11.3.3",
+    "prompts": "^2.4.2"
+  }
+}

package/template/README.md

@@ -0,0 +1,17 @@
+# @aicblock/nserve
+
+![npm](https://img.shields.io/npm/v/@aicblock/nserve)
+![npm](https://img.shields.io/npm/dm/@aicblock/nserve)
+![NPM](https://img.shields.io/npm/l/@aicblock/nserve)
+
+#### Description
+
+🛠️ Description NodeJS Server-side development CLI
+
+#### Installation
+
+```sh
+npm i @aicblock/nserve@latest -g
+# OR
+npm i @aicblock/nserve@latest -D
+```

package/template/nserve-config/model/t_user.sql

@@ -0,0 +1,14 @@
+CREATE TABLE `t_users`  (
+  `id` int NOT NULL AUTO_INCREMENT COMMENT '主键ID',
+  `unionid` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_bin NOT NULL COMMENT '第三方用户唯一识别码',
+  `email` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_bin NULL DEFAULT NULL COMMENT '邮箱地址',
+  `real_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_bin NOT NULL COMMENT '真实姓名',
+  `nickname` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_bin NULL DEFAULT NULL COMMENT '昵称',
+  `username` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_bin NULL DEFAULT NULL COMMENT '用户名',
+  `password` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_bin NULL DEFAULT NULL COMMENT '登陆密码',
+  `type` int NULL DEFAULT 2 COMMENT '用户类型',
+  `status` int NULL DEFAULT 1 COMMENT '用户状态',
+  `update_at` datetime NOT NULL COMMENT '更新时间',
+  PRIMARY KEY (`id`) USING BTREE,
+  UNIQUE INDEX `unionid`(`unionid` ASC) USING BTREE
+) ENGINE = InnoDB AUTO_INCREMENT = 518060 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_0900_bin ROW_FORMAT = Dynamic;

package/template/nserve-config/router/user.ts

@@ -0,0 +1,13 @@
+import { DefineGenRouter } from '@aicblock/nserve'
+
+export default DefineGenRouter({
+  servicePath: '/user/v1',
+  serviceHandler: 'user',
+  routers: [
+    {
+      path: '/list',
+      method: 'GET',
+      name: 'list'
+    }
+  ]
+})

package/template/nserve.config.ts

@@ -0,0 +1,12 @@
+import { DefineNserveConfig } from '@aicblock/nserve'
+
+export default DefineNserveConfig({
+  yamlConfig: {
+    MYSQL_CONF: {
+      host: 'xxx.xxx.xx.xxx',
+      user: 'dev',
+      password: 'password_admin',
+      database: 'test'
+    }
+  }
+})

package/template/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "{{name}}",
+  "version": "1.0.0",
+  "description": "NodeJS Server-side development CLI template",
+  "scripts": {
+    "dev": "nserve serve",
+    "build": "nserve build",
+    "gen": "nserve gen"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@aicblock/nserve": "{{nserveVersion}}",
+    "@types/express": "^5.0.6",
+    "@types/node": "^24.0.4"
+  }
+}

package/template/src/app.ts

@@ -0,0 +1,80 @@
+import express from 'express'
+import routers from './handler/router'
+import emysql from '@dpapejs/emysql'
+import { LoadConfig } from '@aicblock/nserve/lib/tools'
+import { join } from 'path'
+const app = express()
+
+/**
+ * 初始化mysql数据库
+ */
+const initDatabase = async () => {
+  // 判断数据库名是否为空
+  const { database, user, password, port, host } = global.MYSQL_CONF || {}
+  if (!database) {
+    throw Error('Failed to read the database configuration file')
+  }
+  try {
+    global.mysql = new emysql({
+      database,
+      user,
+      password,
+      port,
+      host,
+      log: 'debug'
+    })
+    const connection = await mysql.pool?.getConnection()
+    connection?.release()
+  } catch (error) {
+    console.error('❌ 数据库连接失败:', error)
+    return Promise.reject(error)
+  }
+}
+
+// 启动应用
+const run = async () => {
+  try {
+    LoadConfig(join(__dirname, 'config.yaml'))
+    await initDatabase()
+    routers.length > 0 && app.use('/api', routers)
+
+    // 健康检查
+    app.get('/api/health', (_, res) => {
+      res.json({
+        status: 'OK',
+        timestamp: new Date().toISOString(),
+        version: process.env.VERSION
+      })
+    })
+
+    // 404处理
+    app.use(/.*/, (_, res) => {
+      res.status(404).json({
+        success: false,
+        message: '接口不存在'
+      })
+    })
+
+    // 启动服务器
+    app.listen(3000, () => {
+      console.log(`🚀 服务器运行在端口 3000`)
+      console.log(`📊 环境: ${process.env.NODE_ENV || 'development'}`)
+      console.log(`🔗 API地址: http://localhost:3000/api`)
+    })
+
+    // 优雅关闭
+    process.on('SIGTERM', () => {
+      console.log('收到SIGTERM信号，正在关闭服务器...')
+      process.exit(0)
+    })
+
+    process.on('SIGINT', () => {
+      console.log('收到SIGINT信号，正在关闭服务器...')
+      process.exit(0)
+    })
+  } catch (error) {
+    console.error('初始化数据失败:', error)
+  }
+}
+
+run()

package/template/src/handler/router.ts

@@ -0,0 +1 @@
+export default []

package/template/src/types/index.d.ts

@@ -0,0 +1,17 @@
+/* eslint-disable no-var */
+import emysql from '@dpapejs/emysql'
+import eredis from '@/common/redis'
+declare global {
+  /**
+   * mysql 服务
+   */
+  var mysql: emysql
+  // 数据库配置信息
+  var MYSQL_CONF: {
+    password: string
+    user: string
+    database: string
+    port?: number
+    host?: string
+  }
+}

package/template/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "ES2015",
+    "outDir": "./lib",
+    "lib": ["esnext"],
+    "esModuleInterop": true,
+    "removeComments": false,
+    "noEmitOnError": true,
+    "isolatedModules": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "strictNullChecks": true,
+    "strict": true,
+    "baseUrl": "./",
+    "skipLibCheck": true,
+    "paths": {
+      "@/*": ["src/*"]
+    },
+    "types": ["@types/node"]
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules"]
+}