create-aomex 0.0.16 → 0.0.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-aomex",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "repository": "git@github.com:aomex/create-aomex.git",
   "license": "MIT",
   "type": "module",
@@ -23,6 +23,7 @@
   "files": [
     "dist",
     "templates",
+    "templates/.gitignore",
     "LICENSE",
     "package.json",
     "README.md"

package/templates/.eslintrc.yml

@@ -14,9 +14,13 @@ rules:
   '@typescript-eslint/no-unsafe-return': 'error'
 
   '@typescript-eslint/await-thenable': 'error'
-  # Number String Object
-  '@typescript-eslint/ban-types': 'error'
-  '@typescript-eslint/ban-ts-comments': 'error'
+  # Number String Object Boolean BigInt Symbol
+  '@typescript-eslint/no-wrapper-object-types': 'error'
+  # Function
+  '@typescript-eslint/no-unsafe-function-type': 'error'
+  # no  @ts-ignore @ts-nocheck @ts-check
+  # yes @ts-expect-error: WITH_YOUR_DESCRIPTION
+  '@typescript-eslint/ban-ts-comments': ['error', { 'ts-expect-error': 'allow-with-description' }]
   '@typescript-eslint/no-duplicate-type-constituents': 'error'
   '@typescript-eslint/no-non-null-asserted-nullish-coalescing': 'error'
   # foo?.bar!

package/templates/.gitignore

@@ -0,0 +1,9 @@
+node_modules/
+.idea/
+dist/
+build/
+.npmrc
+coverage/
+.DS_Store
+*.log
+volumes/

package/templates/.vscode/extensions.json

@@ -1,3 +1,8 @@
 {
-  "recommendations": ["esbenp.prettier-vscode", "Prisma.prisma"]
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "Prisma.prisma",
+    "dbaeumer.vscode-eslint",
+    "ms-azuretools.vscode-docker"
+  ]
 }

package/templates/src/cli.ts

@@ -10,7 +10,7 @@ const app = new ConsoleApp({
       commanders: './src/commanders',
       cache: cache,
     }),
-    traceMiddleware('生命周期', async (record) => {
+    traceMiddleware('生命周期', async (_record) => {
       // 根据 record.delta 上报慢日志
       // console.log(record);
     }),

package/templates/src/commanders/schedule.cmd.ts

@@ -5,6 +5,10 @@ import { schedule } from '@aomex/cron';
 export const commander = new Commander();
 
 commander.create('schedule', {
+  docs: {
+    summary: '执行 npx aomex -h 可以看到我',
+    description: '执行 npx aomex schedule -h 可以看到我',
+  },
   mount: [
     // schedule({
     //   second: '*/15',

package/templates/src/routers/{index.router.ts → hello.router.ts}

@@ -1,10 +1,17 @@
-import { Router } from '@aomex/web';
+import { rule } from '@aomex/core';
+import { response, Router } from '@aomex/web';
 import { hello } from '@middleware/hello.middleware';
 
 export const router = new Router();
 
 router.get('/', {
-  mount: [hello],
+  mount: [
+    hello,
+    response({
+      statusCode: 200,
+      content: rule.string(),
+    }),
+  ],
   action: (ctx) => {
     ctx.send(`hello world, ${ctx.visitCount}`);
   },

package/templates/src/routers/user.router.ts

@@ -1,5 +1,5 @@
 import { services } from '@services';
-import { body, params, Router } from '@aomex/web';
+import { body, params, response, Router } from '@aomex/web';
 import { rule } from '@aomex/core';
 
 export const router = new Router({
@@ -7,6 +7,16 @@ export const router = new Router({
 });
 
 router.get('/', {
+  mount: [
+    response({
+      statusCode: 200,
+      content: rule.array({
+        id: rule.int(),
+        name: rule.string(),
+        age: rule.int(),
+      }),
+    }),
+  ],
   action: async (ctx) => {
     const users = await services.user.findAll();
     ctx.send(200, users);
@@ -18,12 +28,24 @@ router.get('/:id', {
     params({
       id: rule.int().min(1),
     }),
+    response({
+      statusCode: 200,
+      content: {
+        id: rule.int(),
+        name: rule.string(),
+        age: rule.int(),
+      },
+    }),
+    response({
+      statusCode: 404,
+      description: '用户不存在',
+    }),
   ],
   action: async (ctx) => {
     const { id } = ctx.params;
     const user = await services.user.findById(id);
     if (!user) {
-      return void ctx.throw(404, 'user not found');
+      return ctx.throw(404, '用户不存在');
     }
     ctx.send(user);
   },
@@ -35,10 +57,13 @@ router.post('/', {
       name: rule.string(),
       age: rule.number(),
     }),
+    response({
+      statusCode: 201,
+    }),
   ],
   action: async (ctx) => {
     const { name, age } = ctx.body;
     await services.user.createUser(name, age);
-    ctx.send(201);
+    ctx.send(201, null);
   },
 });

package/templates/src/services/{db.ts → prisma.ts}

@@ -1,5 +1,5 @@
 import { PrismaClient } from '@prisma/client';
 
-export const db = new PrismaClient({
+export const prisma = new PrismaClient({
   log: ['info'],
 });

package/templates/src/services/user.service.ts

@@ -1,12 +1,12 @@
 import { Service } from '@aomex/core';
-import { db } from './db';
+import { prisma } from './prisma';
 import { Prisma } from '@prisma/client';
 import { traceMethod } from '@aomex/async-trace';
 
 export class UserService extends Service {
   @traceMethod('User.findAll')
   async findAll() {
-    return db.user.findMany({
+    return prisma.user.findMany({
       orderBy: [
         {
           id: Prisma.SortOrder.desc,
@@ -17,11 +17,11 @@ export class UserService extends Service {
 
   @traceMethod((userId) => `User.find(${userId})`)
   async findById(userId: number) {
-    return db.user.findUnique({ where: { id: userId } });
+    return prisma.user.findUnique({ where: { id: userId } });
   }
 
   async createUser(name: string, age: number) {
-    await db.user.create({
+    await prisma.user.create({
       data: {
         name,
         age,

package/templates/src/web.ts

@@ -12,8 +12,9 @@ import { generateOpenapi } from '@aomex/openapi';
 export const app = new WebApp({
   locale: 'zh_CN',
   mount: [
+    httpLogger(),
     responseTime,
-    traceMiddleware('生命周期', async (record) => {
+    traceMiddleware('生命周期', async (_record) => {
       // 根据 record.delta 上报慢日志
       // console.log(record);
     }),
@@ -32,7 +33,6 @@ export const app = new WebApp({
       },
     }),
     helmet(),
-    httpLogger(),
     routers('./src/routers'),
   ],
 });