create-nserve 1.0.4 → 1.0.8

package/README.md

@@ -1,14 +1,10 @@
-# @aicblock/nserve
+# create-nserve 1.0.8
 
 ![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:
 
@@ -25,5 +21,16 @@ $ yarn create nserve@latest
 #### 使用 PNPM:
 
 ```sh
-$ pnpm create  nserve@latest
+$ pnpm create nserve@latest
+```
+
+选择 `Blank template` 或 `MySQL ORM`，输入新项目目录名，然后执行：
+
+```bash
+cd <项目目录>
+npm install
+npm run gen
+npm run dev
 ```
+
+MySQL 模板还需要先在 `nserve.config.ts` 中填写 `yamlConfig.MYSQL_CONF` 并准备数据库。模板安装的 `@aicblock/nserve` 版本与脚手架版本一致（当前为 1.0.8）。

package/bin/index.js

@@ -26,19 +26,8 @@ async function init () {
       initial: 0
     }
   ])
-  // 2. 定义路径
-  const templateDir = path.join(__dirname,  '../template',response.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 })
+  if (!response.projectName || !response.template) return
+  await createProject(response.projectName, response.template)
 
   console.log(`项目 ${response.projectName} 创建成功! 可执行以下命令:`)
   console.log(`  cd ${response.projectName}`)
@@ -46,4 +35,37 @@ async function init () {
   console.log('  npm run dev')
 }
 
-init().catch(console.error)
+async function createProject (projectName, template, cwd = process.cwd()) {
+  if (!/^[a-zA-Z0-9-]+$/.test(projectName)) {
+    throw new Error('项目名只能包含字母、数字和短横线')
+  }
+  if (!['mysql', 'blank'].includes(template)) {
+    throw new Error(`无效的项目模板: ${template}`)
+  }
+
+  const templateDir = path.join(__dirname, '../template', template)
+  const targetDir = path.join(cwd, projectName)
+  try {
+    await fs.mkdir(targetDir)
+  } catch (error) {
+    if (error.code === 'EEXIST') throw new Error(`目标目录已存在: ${targetDir}`)
+    throw error
+  }
+  await fs.copy(templateDir, targetDir, { overwrite: false, errorOnExist: true })
+
+  const pkgPath = path.join(targetDir, 'package.json')
+  const pkg = await fs.readJson(pkgPath)
+  pkg.name = projectName
+  pkg.devDependencies['@aicblock/nserve'] = nserveVersion
+  await fs.writeJson(pkgPath, pkg, { spaces: 2 })
+  return targetDir
+}
+
+module.exports = { createProject }
+
+if (require.main === module) {
+  init().catch((error) => {
+    console.error(error)
+    process.exitCode = 1
+  })
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-nserve",
-  "version": "1.0.4",
+  "version": "1.0.8",
   "main": "bin/index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/template/blank/README.md

@@ -1,17 +1,9 @@
-# @aicblock/nserve
+# NServe 1.0.8 空白模板
 
-![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
+```bash
+npm install
+npm run gen
+npm run dev
 ```
+
+服务默认监听 `http://localhost:3000`，示例接口为 `/api/user/v1/list`，健康检查为 `/api/health`。可在 `nserve.config.ts` 的 `yamlConfig.RUN_PORT` 修改端口；修改路由描述文件后再次运行 `npm run gen`。生产构建使用 `npm run build`。

package/template/blank/package.json

@@ -7,7 +7,9 @@
     "build": "nserve build",
     "gen": "nserve gen"
   },
-  "dependencies": {},
+  "dependencies": {
+    "express": "5.2.1"
+  },
   "devDependencies": {
     "@aicblock/nserve": "{{nserveVersion}}",
     "@types/express": "^5.0.6",

package/template/blank/src/app.ts

@@ -40,7 +40,7 @@ const run = async () => {
         message: '接口不存在'
       })
     })
-    const RUN_PORT = Number(process.env.RUN_PORT || 3000)
+    const RUN_PORT = Number(process.env.RUN_PORT || global.RUN_PORT || 3000)
     // 启动服务器
     app.listen(RUN_PORT, () => {
       console.log(`🚀 服务器运行在端口 ${RUN_PORT}`)
@@ -60,6 +60,7 @@ const run = async () => {
     })
   } catch (error) {
     console.error('初始化数据失败:', error)
+    process.exitCode = 1
   }
 }
 

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

@@ -0,0 +1,5 @@
+declare global {
+  var RUN_PORT: number
+}
+
+export {}

package/template/mysql/README.md

@@ -1,17 +1,11 @@
-# @aicblock/nserve
+# NServe 1.0.8 MySQL 模板
 
-![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)
+先在 `nserve.config.ts` 中填写 `yamlConfig.MYSQL_CONF` 的 `host`、`user`、`password`、`database`（需要时填写 `port`），并准备可连接的 MySQL 数据库。启动时会初始化连接，并根据 `nserve-config/model/*.sql` 创建表。
 
-#### Description
-
-🛠️ Description NodeJS Server-side development CLI
-
-#### Installation
-
-```sh
-npm i @aicblock/nserve@latest -g
-# OR
-npm i @aicblock/nserve@latest -D
+```bash
+npm install
+npm run gen
+npm run dev
 ```
+
+服务默认监听 `http://localhost:3000`，健康检查为 `/api/health`。可在 `nserve.config.ts` 的 `yamlConfig.RUN_PORT` 修改端口；修改 SQL 或路由描述文件后再次运行 `npm run gen`。生产构建使用 `npm run build`。

package/template/mysql/package.json

@@ -7,7 +7,10 @@
     "build": "nserve build",
     "gen": "nserve gen"
   },
-  "dependencies": {},
+  "dependencies": {
+    "@aicblock/esql": "2.0.2",
+    "express": "5.2.1"
+  },
   "devDependencies": {
     "@aicblock/nserve": "{{nserveVersion}}",
     "@types/express": "^5.0.6",

package/template/mysql/src/app.ts

@@ -71,7 +71,7 @@ const run = async () => {
         message: '接口不存在'
       })
     })
-    const RUN_PORT = Number(process.env.RUN_PORT || 3000)
+    const RUN_PORT = Number(process.env.RUN_PORT || global.RUN_PORT || 3000)
     // 启动服务器
     app.listen(RUN_PORT, () => {
       console.log(`🚀 服务器运行在端口 ${RUN_PORT}`)
@@ -91,6 +91,7 @@ const run = async () => {
     })
   } catch (error) {
     console.error('初始化数据失败:', error)
+    process.exitCode = 1
   }
 }
 

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

@@ -1,6 +1,7 @@
 /* eslint-disable no-var */
 import esql from '@aicblock/esql'
 declare global {
+  var RUN_PORT: number
   /**
    * mysql 服务
    */