feat: midway

.editorconfig

@@ -0,0 +1,11 @@
+# 🎨 editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true

.eslintrc.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./node_modules/mwts/",
+  "ignorePatterns": ["node_modules", "dist", "test", "jest.config.js", "typings"],
+  "env": {
+    "jest": true
+  }
+}

.gitignore

@@ -1,3 +1,15 @@
-/node_modules
-/.next
-src/.umi
+logs/
+npm-debug.log
+yarn-error.log
+node_modules/
+package-lock.json
+yarn.lock
+coverage/
+dist/
+.idea/
+run/
+.DS_Store
+*.sw*
+*.un~
+.tsbuildinfo
+.tsbuildinfo.*

.prettierrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ...require('mwts/.prettierrc.json')
+}

README.md

@@ -1,34 +1,29 @@
-## 目前已有脚手架列表
+# my_midway_project
 
-| 名称    | 说明                        | 技术栈                |
-| ------- | --------------------------- | --------------------- |
-| nextJs  | 基于 React 的服务端渲染方案 | nextJs + axios + antd |
-| ReactJs | 基于 React 的业务型脚手架   | umiJs + axios + antd  |
-| TaroJs  | 基于 React 的多端适配方案   | TaroJs 全家桶         |
-| Vue     | 基于 Vue 的业务型脚手架     | vueJs 全家桶          |
-| Gulp    | 基于 Gulp 的清凉型脚手架    | --                    |
+## QuickStart
 
-## 快速上手
+<!-- add docs here for user -->
 
-### 1. 安装相关依赖
+see [midway docs][midway] for more detail.
 
-```js
-// 推荐
-yarn global add @nicecode/cli
+### Development
 
-// or
-// npm install @nicecode/cli -g
+```bash
+$ npm i
+$ npm run dev
+$ open http://localhost:7001/
 ```
 
-### 2. 运行命令
+### Deploy
 
-```js
-// 查看脚手架版本号，是否安装成功
-nice - V
+```bash
+$ npm start
 ```
 
-### 3. 创建项目
+### npm scripts
 
-```js
-nice create ${项目名称}
-```
+- Use `npm run lint` to check code style.
+- Use `npm test` to run unit test.
+
+
+[midway]: https://midwayjs.org

README.zh-CN.md

@@ -0,0 +1,29 @@
+# my_midway_project
+
+## 快速入门
+
+<!-- 在此次添加使用文档 -->
+
+如需进一步了解，参见 [midway 文档][midway]。
+
+### 本地开发
+
+```bash
+$ npm i
+$ npm run dev
+$ open http://localhost:7001/
+```
+
+### 部署
+
+```bash
+$ npm start
+```
+
+### 内置指令
+
+- 使用 `npm run lint` 来做代码风格检查。
+- 使用 `npm test` 来执行单元测试。
+
+
+[midway]: https://midwayjs.org

bootstrap.js

@@ -0,0 +1,2 @@
+const { Bootstrap } = require('@midwayjs/bootstrap');
+Bootstrap.run();

jest.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testPathIgnorePatterns: ['<rootDir>/test/fixtures'],
+  coveragePathIgnorePatterns: ['<rootDir>/test/'],
+};

package.json

@@ -0,0 +1,56 @@
+{
+  "name": "my-midway-template",
+  "version": "1.0.0",
+  "description": "",
+  "private": true,
+  "dependencies": {
+    "@midwayjs/bootstrap": "^3.0.0",
+    "@midwayjs/core": "^3.0.0",
+    "@midwayjs/cross-domain": "^3.5.3",
+    "@midwayjs/decorator": "^3.0.0",
+    "@midwayjs/info": "^3.0.0",
+    "@midwayjs/koa": "^3.0.0",
+    "@midwayjs/logger": "^2.14.0",
+    "@midwayjs/swagger": "^3.5.3",
+    "@midwayjs/typegoose": "^3.5.3",
+    "@midwayjs/validate": "^3.0.0"
+  },
+  "devDependencies": {
+    "@midwayjs/cli": "^1.2.90",
+    "@midwayjs/mock": "^3.0.0",
+    "@typegoose/typegoose": "^9.12.1",
+    "@types/jest": "^26.0.10",
+    "@types/koa": "^2.13.4",
+    "@types/node": "14",
+    "cross-env": "^6.0.0",
+    "jest": "^26.4.0",
+    "mongoose": "^6.6.2",
+    "mwts": "^1.0.5",
+    "swagger-ui-dist": "^4.14.1",
+    "ts-jest": "^26.2.0",
+    "typescript": "~4.6.0"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "scripts": {
+    "start": "NODE_ENV=production node ./bootstrap.js",
+    "dev": "cross-env NODE_ENV=local midway-bin dev --ts",
+    "test": "midway-bin test --ts",
+    "cov": "midway-bin cov --ts",
+    "lint": "mwts check",
+    "lint:fix": "mwts fix",
+    "ci": "npm run cov",
+    "build": "midway-bin build -c"
+  },
+  "midway-bin-clean": [
+    ".vscode/.tsbuildinfo",
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "author": "dev",
+  "license": "MIT"
+}

src/config/config.default.ts

@@ -0,0 +1,27 @@
+import { MidwayConfig } from '@midwayjs/core';
+
+export default {
+  // use for cookie sign key, should change to your own and keep security
+  keys: '1664331917250_5937',
+  koa: {
+    port: 7001,
+  },
+  cors: {
+    credentials: false,
+  },
+  // mongoose: {
+  //   dataSource: {
+  //     default: {
+  //       uri: 'mongodb://localhost:27017/test',
+  //       options: {
+  //         useNewUrlParser: true,
+  //         useUnifiedTopology: true,
+  //         user: '***********',
+  //         pass: '***********'
+  //       },
+  //       // 关联实体
+  //       entities: []
+  //     }
+  //   }
+  // },
+} as MidwayConfig;

src/config/config.unittest.ts

@@ -0,0 +1,7 @@
+import { MidwayConfig } from '@midwayjs/core';
+
+export default {
+  koa: {
+    port: null,
+  },
+} as MidwayConfig;

src/configuration.ts

@@ -0,0 +1,37 @@
+import { Configuration, App } from '@midwayjs/decorator';
+import * as koa from '@midwayjs/koa';
+import * as validate from '@midwayjs/validate';
+import * as info from '@midwayjs/info';
+import { join } from 'path';
+import * as crossDomain from '@midwayjs/cross-domain';
+import * as swagger from '@midwayjs/swagger';
+// import * as typegoose from '@midwayjs/typegoose';
+// import { DefaultErrorFilter } from './filter/default.filter';
+// import { NotFoundFilter } from './filter/notfound.filter';
+import { ReportMiddleware } from './middleware/report.middleware';
+
+@Configuration({
+  imports: [
+    crossDomain,
+    koa,
+    validate,
+    // typegoose,   // mongodb开关
+    {
+      component: info,
+      enabledEnvironment: ['local'],
+    },
+    swagger
+  ],
+  importConfigs: [join(__dirname, './config')],
+})
+export class ContainerLifeCycle {
+  @App()
+  app: koa.Application;
+
+  async onReady() {
+    // add middleware
+    this.app.useMiddleware([ReportMiddleware]);
+    // add filter
+    // this.app.useFilter([NotFoundFilter, DefaultErrorFilter]);
+  }
+}

src/controller/api.controller.ts

@@ -0,0 +1,36 @@
+import { Inject, Controller, Get, Query, Body, Post, Param } from '@midwayjs/decorator';
+import { Context } from '@midwayjs/koa';
+import { ApiBody, BodyContentType } from '@midwayjs/swagger'
+import { UserService } from '../service/user.service';
+import { CatIo, CreateCatDto } from '../interface'
+
+@Controller('/api')
+export class APIController {
+  @Inject()
+  ctx: Context;
+
+  @Inject()
+  userService: UserService;
+
+  @Get('/get_user')
+  @Post('/get_user')
+  async getUser(
+    @Query('uid') uid: number,
+    @Body() createCatDto: CreateCatDto
+  ) {
+    const user = await this.userService.getUser({ uid });
+    return { success: true, message: 'OK', data: user };
+  }
+
+  @Post('/upload')
+  @ApiBody({
+    description: 'this is body',
+    contentType: BodyContentType.Multipart
+  })
+  async upload(
+    @Body() createCatDto: CatIo,
+    @Param('breed') breed: string
+  ) {
+    return { success: true, message: 'OK', data: 'hh' };
+  }
+}

src/controller/home.controller.ts

@@ -0,0 +1,9 @@
+import { Controller, Get } from '@midwayjs/decorator';
+
+@Controller('/')
+export class HomeController {
+  @Get('/')
+  async home(): Promise<string> {
+    return 'Hello Midwayjs!';
+  }
+}

src/entity/user.ts

@@ -0,0 +1,9 @@
+import { prop } from '@typegoose/typegoose';
+
+export class User {
+  @prop()
+  public name?: string;
+
+  @prop({ type: () => [String] })
+  public jobs?: string[];
+}

src/filter/default.filter.ts

@@ -0,0 +1,13 @@
+import { Catch } from '@midwayjs/decorator';
+import { Context } from '@midwayjs/koa';
+
+@Catch()
+export class DefaultErrorFilter {
+  async catch(err: Error, ctx: Context) {
+    // 所有的未分类错误会到这里
+    return {
+      success: false,
+      message: err.message,
+    };
+  }
+}

src/filter/notfound.filter.ts

@@ -0,0 +1,11 @@
+import { Catch } from '@midwayjs/decorator';
+import { httpError, MidwayHttpError } from '@midwayjs/core';
+import { Context } from '@midwayjs/koa';
+
+@Catch(httpError.NotFoundError)
+export class NotFoundFilter {
+  async catch(err: MidwayHttpError, ctx: Context) {
+    // 404 错误会到这里
+    ctx.redirect('/404.html');
+  }
+}

src/interface.ts

@@ -0,0 +1,31 @@
+/**
+ * @description User-Service parameters
+ */
+import { ApiProperty } from "@midwayjs/swagger";
+
+export interface IUserOptions {
+  uid: number;
+}
+
+export class CreateCatDto {
+  @ApiProperty({ example: 'Kitty', description: '名称'})
+  name: string;
+
+  @ApiProperty({ example: '1', description: '年龄'})
+  age: number;
+
+  @ApiProperty({ example: 'bbbb', description: '职位'})
+  breed: string;
+}
+
+export class CatIo {
+  @ApiProperty({ example: 'bbbb', description: '职位'})
+  breed: string;
+
+  @ApiProperty({
+    type: 'string',
+    format: 'binary',
+    description: '文件上传'
+  })
+  file: any;
+}

src/middleware/report.middleware.ts

@@ -0,0 +1,28 @@
+import { IMiddleware } from '@midwayjs/core';
+import { Middleware } from '@midwayjs/decorator';
+import { NextFunction, Context } from '@midwayjs/koa';
+
+@Middleware()
+export class ReportMiddleware implements IMiddleware<Context, NextFunction> {
+  resolve() {
+    return async (ctx: Context, next: NextFunction) => {
+      // 控制器前执行的逻辑
+      const startTime = Date.now();
+      // 执行下一个 Web 中间件，最后执行到控制器
+      // 这里可以拿到下一个中间件或者控制器的返回值
+      const result = await next();
+      // 控制器之后执行的逻辑
+      ctx.logger.info(
+        `Report in "src/middleware/report.middleware.ts", rt = ${
+          Date.now() - startTime
+        }ms`
+      );
+      // 返回给上一个中间件的结果
+      return result;
+    };
+  }
+
+  static getName(): string {
+    return 'report';
+  }
+}

src/service/user.service.ts

@@ -0,0 +1,14 @@
+import { Provide } from '@midwayjs/decorator';
+import { IUserOptions } from '../interface';
+
+@Provide()
+export class UserService {
+  async getUser(options: IUserOptions) {
+    return {
+      uid: options.uid,
+      username: 'mockedName',
+      phone: '12345678901',
+      email: 'xxx.xxx@xxx.com',
+    };
+  }
+}

test/controller/api.test.ts

@@ -0,0 +1,20 @@
+import { createApp, close, createHttpRequest } from '@midwayjs/mock';
+import { Framework } from '@midwayjs/koa';
+
+describe('test/controller/home.test.ts', () => {
+
+  it('should POST /api/get_user', async () => {
+    // create app
+    const app = await createApp<Framework>();
+
+    // make request
+    const result = await createHttpRequest(app).get('/api/get_user').query({ uid: 123 });
+
+    // use expect by jest
+    expect(result.status).toBe(200);
+    expect(result.body.message).toBe('OK');
+
+    // close app
+    await close(app);
+  });
+});

test/controller/home.test.ts

@@ -0,0 +1,21 @@
+import { createApp, close, createHttpRequest } from '@midwayjs/mock';
+import { Framework } from '@midwayjs/koa';
+
+describe('test/controller/home.test.ts', () => {
+
+  it('should GET /', async () => {
+    // create app
+    const app = await createApp<Framework>();
+
+    // make request
+    const result = await createHttpRequest(app).get('/');
+
+    // use expect by jest
+    expect(result.status).toBe(200);
+    expect(result.text).toBe('Hello Midwayjs!');
+
+    // close app
+    await close(app);
+  });
+
+});

tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compileOnSave": true,
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "inlineSourceMap":true,
+    "noImplicitThis": true,
+    "noUnusedLocals": true,
+    "stripInternal": true,
+    "skipLibCheck": true,
+    "pretty": true,
+    "declaration": true,
+    "forceConsistentCasingInFileNames": true,
+    "typeRoots": [ "./typings", "./node_modules/@types"],
+    "outDir": "dist"
+  },
+  "exclude": [
+    "dist",
+    "node_modules",
+    "test"
+  ]
+}