@aicblock/nserve 1.0.5 → 1.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +38 -20
- package/lib/commander.js +1 -1
- package/lib/runtime.js +15 -15
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
|
|
6
6
|
|
|
7
|
-
# NServe 用户使用文档
|
|
7
|
+
# NServe 1.0.8 用户使用文档
|
|
8
8
|
|
|
9
9
|
## 1. 项目简介
|
|
10
10
|
|
|
@@ -32,6 +32,17 @@ $ yarn create nserve@latest
|
|
|
32
32
|
$ pnpm create nserve@latest
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
+
选择空白模板或 MySQL 模板并输入项目名后，进入生成的项目目录：
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
cd <项目目录>
|
|
39
|
+
npm install
|
|
40
|
+
npm run gen
|
|
41
|
+
npm run dev
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
MySQL 模板启动前需要在 `nserve.config.ts` 配置 `yamlConfig.MYSQL_CONF`，并准备可连接的数据库。默认接口前缀为 `/api`，健康检查地址为 `http://localhost:3000/api/health`。
|
|
45
|
+
|
|
35
46
|
## 3. 核心功能
|
|
36
47
|
|
|
37
48
|
### 3.1 命令行接口
|
|
@@ -98,25 +109,20 @@ export default DefineNserveConfig({
|
|
|
98
109
|
import { DefineGenRouter } from '@aicblock/nserve'
|
|
99
110
|
|
|
100
111
|
export default DefineGenRouter({
|
|
101
|
-
servicePath: '/
|
|
112
|
+
servicePath: '/user', // 模板在 /api 下挂载路由
|
|
102
113
|
serviceHandler: 'user', // 处理逻辑目录
|
|
103
114
|
routers: [
|
|
104
115
|
{
|
|
105
116
|
path: '/list', // 路由路径
|
|
106
117
|
method: 'GET', // HTTP 方法
|
|
107
|
-
name: 'list'
|
|
108
|
-
middleware: [] // 路由级中间件
|
|
118
|
+
name: 'list' // 处理函数名
|
|
109
119
|
},
|
|
110
120
|
{
|
|
111
121
|
path: '/create',
|
|
112
122
|
method: 'POST',
|
|
113
|
-
name: 'create'
|
|
114
|
-
session: {
|
|
115
|
-
/* session 配置 */
|
|
116
|
-
}
|
|
123
|
+
name: 'create'
|
|
117
124
|
}
|
|
118
|
-
]
|
|
119
|
-
middleware: ['auth'] // 全局中间件
|
|
125
|
+
]
|
|
120
126
|
})
|
|
121
127
|
```
|
|
122
128
|
|
|
@@ -181,7 +187,7 @@ project/
|
|
|
181
187
|
│ ├── router/ # 路由配置
|
|
182
188
|
│ └── model/ # 模型 SQL 文件
|
|
183
189
|
├── nserve.config.ts # NServe 配置文件
|
|
184
|
-
|
|
190
|
+
├── package.json # 项目配置
|
|
185
191
|
└── tsconfig.json # TypeScript 配置文件
|
|
186
192
|
```
|
|
187
193
|
|
|
@@ -191,16 +197,18 @@ project/
|
|
|
191
197
|
2. 运行 `nserve gen` 命令
|
|
192
198
|
3. NServe 会自动生成：
|
|
193
199
|
- 路由处理器文件 `src/handler/*.handler.ts`
|
|
194
|
-
- 业务逻辑模板文件 `src/logic
|
|
200
|
+
- 业务逻辑模板文件 `src/logic/<serviceHandler>/*.logic.ts`（已有文件不覆盖）
|
|
195
201
|
- 路由注册文件 `src/handler/router.ts`
|
|
196
202
|
|
|
203
|
+
handler、router、types 等生成文件会在再次执行 `gen` 时重写。
|
|
204
|
+
|
|
197
205
|
## 8. 模型生成流程
|
|
198
206
|
|
|
199
207
|
1. 创建 SQL 文件 `nserve-config/model/*.sql`
|
|
200
208
|
2. 运行 `nserve gen` 命令
|
|
201
209
|
3. NServe 会自动生成：
|
|
202
210
|
- 数据模型文件 `src/model/*.ts`
|
|
203
|
-
- 模型索引文件 `src/model/index.ts
|
|
211
|
+
- 模型索引文件 `src/model/index.ts`（默认导出模型数组）
|
|
204
212
|
|
|
205
213
|
## 9. 环境变量
|
|
206
214
|
|
|
@@ -210,7 +218,7 @@ NServe 支持 `.env` 文件和环境特定的配置文件（如 `.env.developmen
|
|
|
210
218
|
|
|
211
219
|
```
|
|
212
220
|
# yamlConfig 配置
|
|
213
|
-
YAML_CONFIG.
|
|
221
|
+
YAML_CONFIG.RUN_PORT=3000
|
|
214
222
|
YAML_CONFIG.MYSQL_CONF.host=localhost
|
|
215
223
|
YAML_CONFIG.MYSQL_CONF.port=3306
|
|
216
224
|
YAML_CONFIG.MYSQL_CONF.user=root
|
|
@@ -223,9 +231,11 @@ AICBLOCK_NSERVE_APP_ENTRY=app.ts
|
|
|
223
231
|
|
|
224
232
|
## 10. 中间件配置
|
|
225
233
|
|
|
226
|
-
在 `nserve.config.ts`
|
|
234
|
+
在 `nserve.config.ts` 中注册中间件：
|
|
227
235
|
|
|
228
236
|
```typescript
|
|
237
|
+
import { DefineNserveConfig } from '@aicblock/nserve'
|
|
238
|
+
|
|
229
239
|
export default DefineNserveConfig({
|
|
230
240
|
generateConfig: {
|
|
231
241
|
middleware: {
|
|
@@ -241,7 +251,11 @@ export default DefineNserveConfig({
|
|
|
241
251
|
在路由配置中使用中间件：
|
|
242
252
|
|
|
243
253
|
```typescript
|
|
254
|
+
import { DefineGenRouter } from '@aicblock/nserve'
|
|
255
|
+
|
|
244
256
|
export default DefineGenRouter({
|
|
257
|
+
servicePath: '/user',
|
|
258
|
+
serviceHandler: 'user',
|
|
245
259
|
routers: [
|
|
246
260
|
{
|
|
247
261
|
path: '/protected',
|
|
@@ -253,6 +267,8 @@ export default DefineGenRouter({
|
|
|
253
267
|
})
|
|
254
268
|
```
|
|
255
269
|
|
|
270
|
+
需在 `src/middleware/auth.ts` 中导出 `authMiddleware`；路由只能引用已注册的中间件。
|
|
271
|
+
|
|
256
272
|
## 11. 高级功能
|
|
257
273
|
|
|
258
274
|
### 11.1 自定义插件
|
|
@@ -274,10 +290,10 @@ export default DefineNserveConfig({
|
|
|
274
290
|
|
|
275
291
|
### 11.2 类型定义
|
|
276
292
|
|
|
277
|
-
NServe
|
|
293
|
+
NServe 的配置函数提供 TypeScript 类型推断，可以直接编写带类型检查的配置：
|
|
278
294
|
|
|
279
295
|
```typescript
|
|
280
|
-
import
|
|
296
|
+
import { DefineNserveConfig, DefineGenRouter } from '@aicblock/nserve'
|
|
281
297
|
```
|
|
282
298
|
|
|
283
299
|
## 12. 最佳实践
|
|
@@ -303,12 +319,14 @@ import type { Config, DefineGenRouterConfig } from '@aicblock/nserve'
|
|
|
303
319
|
|
|
304
320
|
### 13.1 端口被占用
|
|
305
321
|
|
|
306
|
-
|
|
322
|
+
脚手架模板读取 `RUN_PORT`。如果端口被占用，可在 `nserve.config.ts` 的 `yamlConfig.RUN_PORT` 中更改，或在 `.env` 中设置：
|
|
307
323
|
|
|
308
324
|
```
|
|
309
|
-
|
|
325
|
+
YAML_CONFIG.RUN_PORT=3001
|
|
310
326
|
```
|
|
311
327
|
|
|
328
|
+
也可在 `.env` 中设置 `RUN_PORT=3001`，它会优先于 `yamlConfig.RUN_PORT` 生效。
|
|
329
|
+
|
|
312
330
|
### 13.2 热重载不生效
|
|
313
331
|
|
|
314
332
|
确保：
|
|
@@ -325,6 +343,6 @@ PORT=3001
|
|
|
325
343
|
- 依赖是否安装正确
|
|
326
344
|
- 配置文件是否正确
|
|
327
345
|
|
|
328
|
-
##
|
|
346
|
+
## 14. 贡献
|
|
329
347
|
|
|
330
348
|
欢迎提交 Issue 和 Pull Request 来改进 NServe。
|
package/lib/commander.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
"use strict";var d=Object.create;var l=Object.defineProperty;var g=Object.getOwnPropertyDescriptor;var m=Object.getOwnPropertyNames;var y=Object.getPrototypeOf,h=Object.prototype.hasOwnProperty;var b=(e,n,t,s)=>{if(n&&typeof n=="object"||typeof n=="function")for(let r of m(n))!h.call(e,r)&&r!==t&&l(e,r,{get:()=>n[r],enumerable:!(s=g(n,r))||s.enumerable});return e};var O=(e,n,t)=>(t=e!=null?d(y(e)):{},b(n||!e||!e.__esModule?l(t,"default",{value:e,enumerable:!0}):t,e));var R=require("esbuild");var x=O(require("js-yaml"));function i(e,n="INFO"){let t=(p,f="green")=>`\x1B[${{green:"32m",red:"31m",blue:"34m",orange:"30m"}[f]}${p}\x1B[0m`,r={INFO:"blue",WARNING:"orange",ERROR:"red",SUCCESS:"green"}[n],u=t(n,r);console.log(`[${u}] - ${e}`)}var a=require("./runtime"),o=require("commander"),c=process.argv;c[2]===void 0&&c.push("serve");o.program.version("1.0.
|
|
2
|
+
"use strict";var d=Object.create;var l=Object.defineProperty;var g=Object.getOwnPropertyDescriptor;var m=Object.getOwnPropertyNames;var y=Object.getPrototypeOf,h=Object.prototype.hasOwnProperty;var b=(e,n,t,s)=>{if(n&&typeof n=="object"||typeof n=="function")for(let r of m(n))!h.call(e,r)&&r!==t&&l(e,r,{get:()=>n[r],enumerable:!(s=g(n,r))||s.enumerable});return e};var O=(e,n,t)=>(t=e!=null?d(y(e)):{},b(n||!e||!e.__esModule?l(t,"default",{value:e,enumerable:!0}):t,e));var R=require("esbuild");var x=O(require("js-yaml"));function i(e,n="INFO"){let t=(p,f="green")=>`\x1B[${{green:"32m",red:"31m",blue:"34m",orange:"30m"}[f]}${p}\x1B[0m`,r={INFO:"blue",WARNING:"orange",ERROR:"red",SUCCESS:"green"}[n],u=t(n,r);console.log(`[${u}] - ${e}`)}var a=require("./runtime"),o=require("commander"),c=process.argv;c[2]===void 0&&c.push("serve");o.program.version("1.0.8");o.program.on("command:*",function(){let e=o.program.args[0];if(["serve","build","gen"].includes(e)){(0,a.execRun)(e);return}i("See --help for a list of available commands."),i(`Invalid command: ${e}`,"ERROR"),process.exitCode=1});o.program.on("--help",function(){console.log("Commands:"),console.log(" serve Start Run the dev server"),console.log(" build Build the project"),console.log(" gen Generate code based on the configuration file")});o.program.parse(c);
|
package/lib/runtime.js
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
"use strict";var
|
|
2
|
-
${
|
|
1
|
+
"use strict";var Ae=Object.create;var W=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Le=Object.getPrototypeOf,je=Object.prototype.hasOwnProperty;var De=(t,r)=>{for(var n in r)W(t,n,{get:r[n],enumerable:!0})},pe=(t,r,n,c)=>{if(r&&typeof r=="object"||typeof r=="function")for(let i of Ce(r))!je.call(t,i)&&i!==n&&W(t,i,{get:()=>r[i],enumerable:!(c=we(r,i))||c.enumerable});return t};var te=(t,r,n)=>(n=t!=null?Ae(Le(t)):{},pe(r||!t||!t.__esModule?W(n,"default",{value:t,enumerable:!0}):n,t)),Ue=t=>pe(W({},"__esModule",{value:!0}),t);var Qe={};De(Qe,{default:()=>We,execRun:()=>Re});module.exports=Ue(Qe);var F=require("path");var fe=require("esbuild");var Y=require("path"),de=require("module"),ne=te(require("vm")),Me=te(require("js-yaml"));function S(t,r="INFO"){let n=(f,u="green")=>`\x1B[${{green:"32m",red:"31m",blue:"34m",orange:"30m"}[u]}${f}\x1B[0m`,i={INFO:"blue",WARNING:"orange",ERROR:"red",SUCCESS:"green"}[r],g=n(r,i);console.log(`[${g}] - ${t}`)}function re(t,r){let n=t.findIndex(i=>i===r);if(n<0||t.length-1===n)return;let c=t[n+1];if(c.indexOf("--")!==0)return c}function Q(t,r){try{let n=(0,Y.resolve)(t),c=(0,fe.buildSync)({entryPoints:[n],bundle:!0,packages:"external",write:!1,format:"cjs",platform:"node",target:"node18"}),i={module:{exports:{default:void 0}},require:(0,de.createRequire)(n),__dirname:(0,Y.dirname)(n),global,__filename:n,process},g=new ne.default.Script(c.outputFiles[0].text,{filename:n});return ne.default.createContext(i),g.runInContext(i),i.module.exports.default||i.module.exports}catch(n){throw n}}function U(t){return!t||typeof t!="string"?t:t.split(/[\-_]/g).map(n=>n.charAt(0).toUpperCase()+n.slice(1)).join("")}function me(t,r="_"){return!t||typeof t!="string"?t:t.replace(/([A-Z])([A-Z])(?=[a-z])/g,`$1${r}$2`).replace(/([a-z])([A-Z])/g,`$1${r}$2`).toLowerCase()}var se=require("fs"),Oe=require("child_process");var h=require("fs"),R=require("path");var ve=t=>{let r=[],n=new Map,c=new Map;function i(e){if(!c.has(e))return c.set(e,1),e;let o=c.get(e)+1;return c.set(e,o),`${e}${o}`}function g(e,o,T){let s=[];if(o.type==="array"){if(o.properties&&Object.keys(o.properties).length>0){let y=`${T||"Anonymous"}_${e}_Item`,p=o.name,a=p||y;if(p&&n.has(p)){let I=n.get(p),j=f(p,o.properties,o.description);if(I!==j)a=i(p);else return{type:`${p}[]`,generatedInterfaces:s}}let E=f(a,o.properties,o.description);return E&&(n.set(a,E),s.push(a)),{type:`${a}[]`,generatedInterfaces:s}}return{type:"any[]",generatedInterfaces:s}}if(o.type==="object"&&o.properties){let y=`${T||"Anonymous"}_${e}`,p=o.name,a=p||y;if(p&&n.has(p)){let I=n.get(p),j=f(p,o.properties,o.description);if(I!==j)a=i(p);else return{type:p,generatedInterfaces:s}}let E=f(a,o.properties,o.description);return E&&(n.set(a,E),s.push(a)),{type:a,generatedInterfaces:s}}return typeof o.type=="object"&&o.type.type==="enum"?{type:o.type.values.map(a=>typeof a=="string"?`'${a}'`:a).join(" | "),generatedInterfaces:s}:typeof o.type=="object"?{type:o.type.name,generatedInterfaces:s}:{type:o.type||"string",generatedInterfaces:s}}function f(e,o,T){let s=[];return T&&s.push(`// ${T}`),Object.entries(o).forEach(([y,p])=>{let a=g(y,p,e),E=p.description?` // ${p.description}`:"",I=` ${y}${p.required===!1?"?":""}: ${a.type};`;s.push(E?`${E}
|
|
2
|
+
${I}`:I)}),s.length===0?`interface ${e} {}`:`interface ${e} {
|
|
3
3
|
${s.join(`
|
|
4
4
|
`)}
|
|
5
|
-
}`}function
|
|
6
|
-
`)}Object.entries(e.properties||{}).forEach(([s,
|
|
7
|
-
${
|
|
5
|
+
}`}function u(e){if(e.type!==void 0){let s=[];return e.description&&s.push(`// ${e.description}`),s.push(`type ${e.name} = ${e.type};`),s.join(`
|
|
6
|
+
`)}Object.entries(e.properties||{}).forEach(([s,y])=>{g(s,y,e.name)});let o="";if(e.genericity)if(typeof e.genericity=="string"){let s=l(e);s?o=` extends ${e.genericity}<${s}>`:o=` extends ${e.genericity}`}else{let{name:s,typeParams:y}=e.genericity;o=` extends ${s}<${y.join(", ")}>`}else e.extends&&(Array.isArray(e.extends)?o=` extends ${e.extends.join(", ")}`:o=` extends ${e.extends}`);if(e.genericity)return`interface ${e.name}${o} {}`;let T=[];return Object.entries(e.properties||{}).forEach(([s,y])=>{let p=g(s,y,e.name),a=y.description?` // ${y.description}`:"",E=` ${s}${y.required===!1?"?":""}: ${p.type};`;T.push(a?`${a}
|
|
7
|
+
${E}`:E)}),`interface ${e.name}${o} {
|
|
8
8
|
${T.join(`
|
|
9
9
|
`)}
|
|
10
|
-
}`}function
|
|
10
|
+
}`}function l(e){let o=e.properties?.list;if(o&&o.type==="array"&&o.name)return o.name;for(let[T,s]of Object.entries(e.properties||{}))if(s.type==="array"&&s.name)return s.name;return null}let d=u(t);return n.forEach(e=>{r.push(e)}),r.push(d),r.join(`
|
|
11
11
|
|
|
12
|
-
`)},oe=ve;var
|
|
13
|
-
`),"utf-8")}let K=
|
|
14
|
-
${
|
|
12
|
+
`)},oe=ve;var Pe=(t,r,n,c="@")=>{let i=(0,R.join)(r,n,"handler"),g=(0,R.join)(r,n,"logic"),f=(0,R.join)(r,n,"types");!(0,h.existsSync)(i)&&(0,h.mkdirSync)(i,{recursive:!0}),!(0,h.existsSync)(g)&&(0,h.mkdirSync)(g,{recursive:!0}),!(0,h.existsSync)(f)&&(0,h.mkdirSync)(f,{recursive:!0});let l=Object.assign({},{genDir:"nserve-config",routerDir:"router",modelDir:"model"},t),{genDir:d,routerDir:e,middleware:o}=l,T=(0,R.join)(r,d),s=(0,R.join)(T,e||"");if(!(0,h.existsSync)(s)){console.log("[ERROR] API\u63CF\u8FF0\u6587\u4EF6\u4E0D\u5B58\u5728::",s);return}if(!(0,h.statSync)(s).isDirectory()){console.log("[ERROR] API\u63CF\u8FF0\u6587\u4EF6\u4E0D\u662F\u76EE\u5F55");return}let p=(0,h.readdirSync)(s).filter(A=>A.endsWith(".ts")||A.endsWith(".js"));if(p.length===0){console.log("[ERROR] API\u63CF\u8FF0\u6587\u4EF6\u76EE\u5F55\u4E0B\u6CA1\u6709\u63CF\u8FF0\u751F\u6210\u6587\u4EF6");return}let a=[],E=[];p.forEach(A=>{let B=Q((0,R.join)(s,A),__dirname);if(!B)return;let b=B,P=A.replace(".ts",".handler"),ie=U(A.replace(".ts",""))+"Server",Ie=(0,R.join)(i,[P,".ts"].join("")),be=[c,"handler",P].join("/");a.push(`import ${ie} from '${be}'`),E.push(ie);let X=[],ce=[],z=(0,R.join)(g,b.handler),H=(0,R.join)(f,b.handler);!(0,h.existsSync)(z)&&(0,h.mkdirSync)(z,{recursive:!0}),!(0,h.existsSync)(H)&&(0,h.mkdirSync)(H,{recursive:!0});let k={},V={};o&&Object.keys(o).forEach(m=>{let{libName:O,funcName:N}=o[m],w=N?`{${N} as ${m}}`:m;k[m]=`import ${w} from '${O}'`}),b.service?.forEach(m=>{let O=["import type { Request, Response } from 'express'"],N=["ErrorResponse","SuccessResponse"],w=me(m.handler,"-"),q=[];if(m.responseDataType&&q.push(oe(m.responseDataType)),m.requestDataType&&q.push(oe(m.requestDataType)),q.length>0){let C=(0,R.join)(H,`${w}.types.d.ts`);(0,h.writeFileSync)(C,q.join(`
|
|
13
|
+
`),"utf-8")}let K=m.method?.toLowerCase()||"get",J=U(m.handler),D=[];if(m.middleware&&l.middleware){let C=Array.isArray(m.middleware)?m.middleware:[m.middleware];if(!C.every(_=>{let $=typeof _=="string"?_:_.name;return!!k[$]}))throw new Error(`[ERROR] \u8DEF\u7531\u914D\u7F6E\u4E2D\u4F7F\u7528\u4E86\u4E0D\u5B58\u5728\u7684\u4E2D\u95F4\u4EF6::${C}`);let G=[];C.forEach(_=>{let $=typeof _=="string"?_:_.name;V[$]=k[$];let ue=(typeof _=="string"?void 0:Array.isArray(_.value)?_.value:[_.value])?.map(ee=>typeof ee=="string"?`'${ee}'`:ee),Se=ue?`${$}(${ue.join(",")})`:$;G.push(Se)}),D.push(...G)}let xe=[c,"logic",b.handler,w].join("/");X.push(`import ${J} from '${xe}.logic'`),ce.push(`Router.${K}('${m.path}',${D.join(",")}${D.length>0?",":""}${J})`),m.docRemark&&O.concat(`// ${m.docRemark}`);let ae=[];if(m.requestDataType&&m.requestDataType.properties){let C=m.requestDataType,M=C.properties,G=Object.keys(M).filter(_=>M[_].required!==!1).reduce((_,$)=>{let L=typeof M[$].type=="string"?M[$].type:"object";return _[$]={required:!0,type:L},_},{});if(Object.keys(G).length>0){let _=Object.values(M).filter(L=>L.source).map(L=>L.source),$=_.length>0&&_.every(L=>L===_[0])?_[0]:m.method==="GET"?"query":"body";ae.push(`const data = req.${$} as ${C.name}`,`CheckFieldRequired(data, ${JSON.stringify(G)})`),N.push("CheckFieldRequired")}}O.push(`import { ${N.join(",")} } from '@aicblock/nserve/lib/tools'`);let Ne=O.concat(`
|
|
14
|
+
${m.docRemark?`// ${m.docRemark}`:""}
|
|
15
15
|
export async function ServiceLogic(req: Request, res: Response) {
|
|
16
16
|
try {
|
|
17
17
|
// todo: \u63A5\u53E3\u670D\u52A1\u903B\u8F91\u5B9E\u73B0
|
|
@@ -23,9 +23,9 @@ ${T.join(`
|
|
|
23
23
|
}
|
|
24
24
|
}
|
|
25
25
|
export default ServiceLogic
|
|
26
|
-
`),le=(0,
|
|
27
|
-
`),"utf-8")});let Z=[]
|
|
28
|
-
`))});let
|
|
29
|
-
`)),console.log("[INFO] gen router file ",
|
|
30
|
-
`),"utf-8");let
|
|
31
|
-
`),"utf-8"),
|
|
26
|
+
`),le=(0,R.join)(z,`${w}.logic.ts`);!(0,h.existsSync)(le)&&(0,h.writeFileSync)(le,Ne.join(`
|
|
27
|
+
`),"utf-8")});let Z=[];b.middleware&&(Array.isArray(b.middleware)?b.middleware:[b.middleware]).forEach(O=>{let N=typeof O=="string"?O:O.name,w=k[N];if(!w)throw new Error(`[ERROR] \u8DEF\u7531\u914D\u7F6E\u4E2D\u4F7F\u7528\u4E86\u4E0D\u5B58\u5728\u7684\u4E2D\u95F4\u4EF6::${N}`);V[N]=w;let K=(typeof O=="string"?void 0:Array.isArray(O.value)?O.value:[O.value])?.map(D=>typeof D=="string"?`'${D}'`:D),J=K?`${N}(${K.join(",")})`:N;Z.push(J)}),Object.keys(V).forEach(m=>{X.push(V[m])});let $e=["// Code generated by plugin. Templates Edited by aicblock cli. DO NOT EDIT.","import express from 'express'",...X,"const app = express()","const Router = express.Router()",Z.length>0?`Router.use(${Z.join(",")})`:"",`app.use('${b.prefix}', Router)`,...ce,"export default app"];(0,h.writeFileSync)(Ie,$e.join(`
|
|
28
|
+
`))});let I=(0,R.join)(i,"router.ts"),j=["// Code generated by plugin. Templates Edited by aicblock cli. DO NOT EDIT.",...a,"export default [",E.join(","),"]"];(0,h.writeFileSync)(I,j.join(`
|
|
29
|
+
`)),console.log("[INFO] gen router file ",I)},ge=Pe;var x=require("fs"),v=require("path"),qe=new Set(["INT","BIGINT","BIT","DECIMAL","DOUBLE","FLOAT","INTEGER","MEDIUMINT","NUMERIC","REAL","SMALLINT","TINYINT"]);function Ge(t){let c=t.replace(/\/\*[\s\S]*?\*\//g,"").trim().replace(/--.*$/gm,"").replace(/\s+/g," "),i=c.match(/CREATE TABLE [`"]?([\w_]+)[`"]?\s*\(/i);if(!i)throw new Error("\u65E0\u6CD5\u89E3\u6790\u8868\u540D");let f={tableName:i[1],columns:[]},u=c.indexOf("("),l=c.lastIndexOf(")");if(u===-1||l===-1||l<=u)throw new Error("\u65E0\u6CD5\u627E\u5230\u5217\u5B9A\u4E49\u90E8\u5206");let d=c.substring(u+1,l);if(!d.trim())return f;let e=Ye(d),o=new Set,T=new Set,s=[];return e.forEach(y=>{let p=y.trim();if(p.toUpperCase().startsWith("PRIMARY KEY")){let a=ye(p,/^PRIMARY KEY\s*\(/i);if(!a)throw new Error(`Unsupported primary key: ${p}`);o.add(a[0]);return}if(p.toUpperCase().startsWith("UNIQUE")){let a=ye(p,/^UNIQUE(?:\s+(?:KEY|INDEX))?(?:\s+[`"]?[\w_]+[`"]?)?\s*\(/i);if(!a)throw new Error(`Unsupported unique index: ${p}`);if(a.length===1)T.add(a[0]);else{let E=p.match(/^UNIQUE(?:\s+(?:KEY|INDEX))?\s+[`"]?([\w_]+)[`"]?\s*\(/i);s.push({name:E?E[1]:`uk_${a.join("_")}`,columns:a})}return}/^(?:KEY|INDEX|FULLTEXT|SPATIAL)\b/i.test(p)||f.columns.push(Fe(p))}),f.columns.forEach(y=>{o.has(y.name)&&(y.primaryKey=!0),T.has(y.name)&&(y.unique=!0)}),s.length>0&&(f.uniqueIndex=s),f}function ye(t,r){if(!r.test(t))return null;let n=t.match(/\(\s*((?:[^()]|\(\s*\d+\s*\))*)\s*\)\s*(?:USING\s+\w+)?$/i);return n?n[1].split(",").map(c=>c.trim().replace(/\s*\(\s*\d+\s*\)/,"").replace(/\s+(?:ASC|DESC)$/i,"").replace(/^[`"]+|[`"]+$/g,"")):null}function Ye(t){let r=[],n="",c=!1,i=!1,g=0;for(let f=0;f<t.length;f++){let u=t[f],l=f+1<t.length?t[f+1]:"";u==="'"&&!i&&(c=!c),u==="-"&&l==="-"&&!c&&(i=!0),i&&(u===","||u===")")&&(i=!1),u==="("&&!c&&!i&&g++,u===")"&&!c&&!i&&g--,u===","&&!c&&!i&&g===0?(n.trim()&&r.push(n.trim()),n=""):n+=u}return n.trim()&&r.push(n.trim()),r}function Fe(t){let r=t.match(/^[`"]?([\w_]+)[`"]?\s+([a-zA-Z]+)(?:\s*\(\s*(\d+)\s*(?:,\s*(\d+)\s*)?\))?/);if(!r)throw new Error(`Unsupported SQL column definition: ${t}`);let[,n,c,i,g]=r,f=c.toUpperCase(),u={name:n,dataType:f};i&&(u.length=Number(i)),g&&(u.point=Number(g));let l=t.slice(r[0].length).trim();for(;l;){let d=null;if(!(d=l.match(/^(?:CHARACTER\s+SET|CHARSET|COLLATE)\s+\w+/i))){if(d=l.match(/^NOT\s+NULL\b/i))u.notNull=!0;else if(!(d=l.match(/^NULL\b/i))){if(d=l.match(/^PRIMARY\s+KEY\b/i))u.primaryKey=!0;else if(d=l.match(/^UNIQUE(?:\s+KEY)?\b/i))u.unique=!0;else if(d=l.match(/^AUTO_INCREMENT\b/i))u.autoIncrement=!0;else if(d=l.match(/^UNSIGNED\b/i))u.unsigned=!0;else if(d=l.match(/^ZEROFILL\b/i))u.zeroFill=!0;else if(d=l.match(/^DEFAULT\s+('(?:''|\\'|[^'])*'|"(?:\\"|[^"])*"|\S+)/i)){let e=d[1];if((e.startsWith("'")||e.startsWith('"'))&&(e=e.slice(1,-1).replace(/''/g,"'")),e.toUpperCase()!=="NULL"){let o=Number(e);u.defaultValue=qe.has(f)&&!isNaN(o)?o:e}}else if(d=l.match(/^COMMENT\s+'((?:''|\\'|[^'])*)'/i))u.comments=d[1].replace(/''/g,"'");else if(!(d=l.match(/^ON\s+UPDATE\s+\w+(?:\(\d*\))?/i)))throw new Error(`Unsupported SQL column option: ${l} in ${t}`)}}l=l.slice(d[0].length).trim()}return u}var Be=(t,r,n)=>{let c={genDir:"nserve-config",modelDir:"model"},{genDir:i,modelDir:g}=Object.assign({},c,t),f=(0,v.join)(r,i,g);if(!(0,x.existsSync)(f))return;let u=(0,x.readdirSync)(f).filter(s=>s.endsWith(".sql"));if(u.length===0)throw new Error(`The SQL model directory does not contain any SQL files::${f}`);let l=(0,v.join)(r,n,g);(0,x.existsSync)(l)||(0,x.mkdirSync)(l);let d=[],e=[];u.forEach(s=>{let y=(0,v.join)(f,s),p=(0,x.readFileSync)(y,"utf-8");try{let a=Ge(p),E=a.tableName,I=(0,v.join)(l,`${E}.ts`),j=a.columns.map(P=>`${U(P.name)} = '${P.name}'`),A=[a.tableName,"_Field"].join(""),B=["import { DefineTable } from '@aicblock/esql'",`const table = DefineTable(${JSON.stringify(a,null,2)})`,`export enum ${U(A)} { ${j.join(", ")}}`,"export default table"];(0,x.writeFileSync)(I,B.join(`
|
|
30
|
+
`),"utf-8");let b=U(E);e.push(b),d.push(`import ${b} from './${E}'`),S(`The model file ${E} has been generated::${I}`)}catch(a){throw new Error(`Invalid CREATE TABLE in ${y}: ${a instanceof Error?a.message:String(a)}`)}});let o=(0,v.join)(l,"index.ts"),T=[...d,`export default [${e.join(", ")}]`];(0,x.writeFileSync)(o,T.join(`
|
|
31
|
+
`),"utf-8"),S(`The model index file has been generated::${o}`)},he=Be;var Ee=require("child_process"),_e=require("path"),ke=(t,r,n)=>{let c=r||process.cwd();ge(t||{},c,n||"src"),he(t||{},c,n||"src");let i={semi:!1,singleQuote:!0,trailingComma:"none"},{semi:g,singleQuote:f,trailingComma:u}=Object.assign({},i,t?.codePrettier||{}),l=[];g===!1&&l.push("--no-semi"),f===!0&&l.push("--single-quote"),u&&l.push("--trailing-comma",u);let d=["logic/**/*.ts","handler/**/*.ts","model/**/*.ts","types/**/*.d.ts"];l.push("--no-error-on-unmatched-pattern","--write",...d);let e=(0,_e.join)(c,n||"src");console.log("[INFO] execRunGen::",e);let o=(0,Ee.spawnSync)(process.execPath,[require.resolve("prettier/bin/prettier.cjs"),...l],{cwd:e,stdio:"inherit"});if(o.error)throw o.error;if(o.status!==0)throw new Error(`Prettier failed with status ${o.status??o.signal}`);S("[INFO] execRunGen","SUCCESS")},Te=ke;function Ve(t,r){S(`${r?`The [${r}] app has been `:""}Build DONE. [Build time:${Date.now()-t} ms]`,"SUCCESS")}function Ke(t){S(t==="build"?"Build Fail.":"Serve process has exited.","ERROR")}function Je(){let t=process.cwd(),r=re(process.argv,"--config"),n=(0,F.join)(t,"nserve.config.ts"),c=(0,F.join)(t,"nserve.config.js"),i=r?(0,F.join)(t,r):(0,se.existsSync)(n)?n:c;if(!(0,se.existsSync)(i))throw Error(`The configuration file does not exist. [${i}]`);return i}function Re(t){try{let n=Je(),c=process.cwd(),i=t,g=re(process.argv,"--mode"),f=JSON.stringify(process.argv),u={AICBLOCK_NSERVE_RUN_CWD:c,AICBLOCK_NSERVE_RUN_CONFIG_PATH:n,AICBLOCK_NSERVE_RUN_MODE:i,AICBLOCK_NSERVE_ENV_MODE:g,AICBLOCK_NSERVE_RUN_ARGV:f};if(Object.keys(u).forEach(e=>{let o=u[e];o!==void 0&&(process.env[e]=o)}),t==="gen"){let{generateConfig:e,sourceDir:o}=Q(n,process.cwd());Te(e||{},c,o||"src");return}let l=Date.now();var r=void 0;let d=(0,Oe.spawn)(process.execPath,[(0,F.join)(__dirname,"core/run.js")],{cwd:c,stdio:t==="build"?"inherit":"pipe",env:Object.assign({},process.env,u)});d.stdout?.on("data",e=>{r&&r.stop(),console.log(e.toString("utf-8"))}),d.stdout?.on("error",e=>{r&&r.stop(),console.log(e.toString())}),d.stderr?.on("data",e=>{r&&r.stop(),console.log(e.toString("utf-8"))}),d.on("error",e=>{r&&r.stop(),console.error(e),process.exitCode=1}),d.on("exit",e=>{r&&r.stop(),e===0&&t==="build"&&Ve(l,g),e!==0&&Ke(t),e!==0&&(process.exitCode=e||1)})}catch(n){S("execRun fial::","ERROR"),console.error(n),process.exitCode=1}}var We=Re;0&&(module.exports={execRun});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aicblock/nserve",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.8",
|
|
4
4
|
"description": "🛠️ Description NodeJS Server-side development CLI",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -34,8 +34,10 @@
|
|
|
34
34
|
"@types/jest": "^29.5.12",
|
|
35
35
|
"@types/js-yaml": "^4.0.9",
|
|
36
36
|
"@types/node": "^16.4.10",
|
|
37
|
+
"fs-extra": "^11.3.3",
|
|
37
38
|
"husky": "9.0.11",
|
|
38
39
|
"jest": "29.7.0",
|
|
40
|
+
"prompts": "^2.4.2",
|
|
39
41
|
"ts-jest": "29.1.5",
|
|
40
42
|
"ts-node": "^10.9.2",
|
|
41
43
|
"typescript": "5.5.3"
|
|
@@ -46,7 +48,7 @@
|
|
|
46
48
|
}
|
|
47
49
|
},
|
|
48
50
|
"dependencies": {
|
|
49
|
-
"@aicblock/esql": "2.0.
|
|
51
|
+
"@aicblock/esql": "2.0.2",
|
|
50
52
|
"commander": "14.0.2",
|
|
51
53
|
"esbuild": "0.27.2",
|
|
52
54
|
"express": "5.2.1",
|