Egg TS 脚手架
发布于 2 个月前 作者 MiYogurt 418 次浏览 来自 分享

自用的ts脚手架,内置了一些功能,比如 typeorm 等等,根据路由名字查找schema,进行字段校验,路径重写。依赖注入等等。 https://github.com/MiYogurt/egg-up

快速创建 controller

npx plop controller

输入你控制器的名字,小写就行,更多 Model、Service 模板,可以自定义,参考 plop 文档。

自动验证

会找到 home.yml 里面的规则,并验证。

const r = ProxyRouter(router)
r.get('home', '/', controller.home.index);

依赖注入

import { Service } from 'egg';
import { context } from 'egg-aop';

/**
 * Test Service
 */
@context()
export default class Test extends Service {
  /**
   * sayHi to you
   * @param name - your name
   */
  public async sayHi(name: string) {
    return `hi, ${name}`;
  }
}
import TestService from '@service/test';
import { lazyInject } from 'egg-aop';

export default class HomeController extends Controller {
  @lazyInject()
  private testService: TestService;
}

路径重写

import Photo from '@model/photo';

需要配置 package.json

  "_moduleAliases": {
    "@model": "app/model",
    "@framework": "app/framework",
    "@middleware": "app/middleware",
    "@service": "app/service"
  },

tsconfig.json

"paths": {
    "@model/*": ["app/model/*"],
    "@framework/*": ["app/framework/*"],
    "@*":["app/*"]
}
1 回复

顶 ~ Readme 文档什么的完善下~

回到顶部