[RFC] customLoader

[popomore]

背景

Egg 支持自定义 loader，通过 app.loader 的 API 可以自定义加载某个目录的文件到 app 或 ctx。

但是通过 API 调用比较麻烦

1. 非声明式的，使用不友好
2. loader 属于内部 API，透出重构成本高
3. 如果使用 ts 还得重新定义一遍

思路

在 config.default.js 增加 customLoader 的配置，不需要再使用 API

exports.customLoader = {
  service: {
    directory: 'app/service',
    inject: 'ctx', // or app
    loadunit: false, // 是否加载框架和插件目录
    // other loads options
  },
};

egg-ts-helper 也可以读这个配置来生成 typing

在 didLoad 加载自定义 loader

跟进

• egg-core feat: add new mixin loadCustomLoader in Loader  core#202
• egg feat: support customLoader #3484
• egg-ts-helper feat: add custom loader support egg-ts-helper#41
• egg-mock 自动生成 mock API feat: add mock API for customLoader mock#95
• 插件改造
  • egg-mongoose
  • egg-sequelize

[atian25]

在哪个生命周期加载？

[popomore]

didLoad 吧

[popomore]

有个问题，需要区分 app/agent 吗，一般都在 app 里面

[whxaxes]

可以区分一下吧，inject 里可以填 app 或者 agent ？

[whxaxes]

存不存在这种场景，需要同时 load 到 app 和 agent 上？那这样 inject 是否也可以支持传个数组？

[popomore]

inject 只有 app/ctx，如果要支持可以加个 type

[popomore]

eggjs/mock#95

[whxaxes]

eggjs/egg-ts-helper#41

[skyitachi]

great work