feat: loader support custom extension

.gitignore

@@ -3,4 +3,5 @@ coverage
 .logs
 npm-debug.log
 .vscode
-.DS_Store
+.DS_Store
+yarn.lock

lib/loader/egg_loader.js

@@ -282,7 +282,7 @@ class EggLoader {
    * @since 1.0.0
    */
   loadFile(filepath, ...inject) {
-    if (!fs.existsSync(filepath)) {
+    if (!filepath || !fs.existsSync(filepath)) {
       return null;
     }
 
@@ -391,12 +391,12 @@ class EggLoader {
   }
 
   getTypeFiles(filename) {
-    const files = [ `${filename}.default.js` ];
-    if (this.serverScope) files.push(`${filename}.${this.serverScope}.js`);
+    const files = [ `${filename}.default` ];
+    if (this.serverScope) files.push(`${filename}.${this.serverScope}`);
     if (this.serverEnv === 'default') return files;
 
-    files.push(`${filename}.${this.serverEnv}.js`);
-    if (this.serverScope) files.push(`${filename}.${this.serverScope}_${this.serverEnv}.js`);
+    files.push(`${filename}.${this.serverEnv}`);
+    if (this.serverScope) files.push(`${filename}.${this.serverScope}_${this.serverEnv}`);
     return files;
   }
 }

lib/loader/file_loader.js

@@ -10,6 +10,7 @@ const deprecate = require('depd')('egg');
 const utils = require('../utils');
 const FULLPATH = Symbol('EGG_LOADER_ITEM_FULLPATH');
 const EXPORTS = Symbol('EGG_LOADER_ITEM_EXPORTS');
+const MATCH = Symbol('EGG_LOADER_ITEM_MATCH');
 
 const defaults = {
   directory: null,
@@ -57,6 +58,22 @@ class FileLoader {
     }
   }
 
+  /**
+   * default glob used to match files, creating by require.extensions.
+   * @return {Array} match
+   */
+  get defaultMatch() {
+    if (!this[MATCH]) {
+      // cache the default match
+      const extensions = Object.keys(require.extensions).map(ext => ext.substring(1));
+      this[MATCH] = [ '**/*.(' + extensions.join('|') + ')' ];
+      if (extensions.includes('ts')) {
+        this[MATCH].push('!**/*.d.ts');
+      }
+    }
+    return this[MATCH];
+  }
+
   /**
    * attach items to target object. Mapping the directory to properties.
    * `app/controller/group/repository.js` => `target.group.repository`
@@ -120,8 +137,12 @@ class FileLoader {
    * @since 1.0.0
    */
   parse() {
-    let files = this.options.match || [ '**/*.js' ];
-    files = Array.isArray(files) ? files : [ files ];
+    let files = this.options.match;
+    if (!files) {
+      files = this.defaultMatch;
+    } else {
+      files = Array.isArray(files) ? files : [ files ];
+    }
 
     let ignore = this.options.ignore;
     if (ignore) {

lib/loader/mixin/config.js

@@ -1,10 +1,10 @@
 'use strict';
 
 const debug = require('debug')('egg-core:config');
-const fs = require('fs');
 const path = require('path');
 const extend = require('extend2');
 const assert = require('assert');
+const utils = require('../../utils');
 
 const SET_CONFIG_META = Symbol('Loader#setConfigMeta');
 
@@ -55,8 +55,8 @@ module.exports = {
 
   _preloadAppConfig() {
     const names = [
-      'config.default.js',
-      `config.${this.serverEnv}.js`,
+      'config.default',
+      `config.${this.serverEnv}`,
     ];
     const target = {};
     for (const filename of names) {
@@ -70,12 +70,13 @@ module.exports = {
     const isPlugin = type === 'plugin';
     const isApp = type === 'app';
 
-    let filepath = path.join(dirpath, 'config', filename);
+    let filepath = utils.resolveModule(path.join(dirpath, 'config', filename));
     // let config.js compatible
-    if (filename === 'config.default.js' && !fs.existsSync(filepath)) {
-      filepath = path.join(dirpath, 'config/config.js');
+    if (filename === 'config.default' && !filepath) {
+      filepath = utils.resolveModule(path.join(dirpath, 'config/config'));
     }
     const config = this.loadFile(filepath, this.appInfo, extraInject);
+
     if (!config) return null;
 
     if (isPlugin || isApp) {

lib/loader/mixin/custom.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const path = require('path');
+const utils = require('../../utils');
 
 module.exports = {
 
@@ -22,15 +23,15 @@ module.exports = {
    */
   loadCustomApp() {
     this.getLoadUnits()
-      .forEach(unit => this.loadFile(path.join(unit.path, 'app.js')));
+      .forEach(unit => this.loadFile(utils.resolveModule(path.join(unit.path, 'app'))));
   },
 
   /**
    * Load agent.js, same as {@link EggLoader#loadCustomApp}
    */
   loadCustomAgent() {
     this.getLoadUnits()
-      .forEach(unit => this.loadFile(path.join(unit.path, 'agent.js')));
+      .forEach(unit => this.loadFile(utils.resolveModule(path.join(unit.path, 'agent'))));
   },
 
 };

lib/loader/mixin/extend.js

@@ -96,8 +96,8 @@ module.exports = {
     const isAddUnittest = 'EGG_MOCK_SERVER_ENV' in process.env && this.serverEnv !== 'unittest';
     for (let i = 0, l = filepaths.length; i < l; i++) {
       const filepath = filepaths[i];
-      filepaths.push(filepath + `.${this.serverEnv}.js`);
-      if (isAddUnittest) filepaths.push(filepath + '.unittest.js');
+      filepaths.push(filepath + `.${this.serverEnv}`);
+      if (isAddUnittest) filepaths.push(filepath + '.unittest');
     }
 
     const mergeRecord = new Map();

lib/loader/mixin/plugin.js

@@ -5,6 +5,7 @@ const path = require('path');
 const debug = require('debug')('egg-core:plugin');
 const sequencify = require('../../utils/sequencify');
 const loadFile = require('../../utils').loadFile;
+const utils = require('../../utils');
 
 module.exports = {
 
@@ -56,11 +57,11 @@ module.exports = {
    */
   loadPlugin() {
     // loader plugins from application
-    const appPlugins = this.readPluginConfigs(path.join(this.options.baseDir, 'config/plugin.default.js'));
+    const appPlugins = this.readPluginConfigs(path.join(this.options.baseDir, 'config/plugin.default'));
     debug('Loaded app plugins: %j', Object.keys(appPlugins));
 
     // loader plugins from framework
-    const eggPluginConfigPaths = this.eggPaths.map(eggPath => path.join(eggPath, 'config/plugin.default.js'));
+    const eggPluginConfigPaths = this.eggPaths.map(eggPath => path.join(eggPath, 'config/plugin.default'));
     const eggPlugins = this.readPluginConfigs(eggPluginConfigPaths);
     debug('Loaded egg plugins: %j', Object.keys(eggPlugins));
 
@@ -159,20 +160,22 @@ module.exports = {
     }
 
     const plugins = {};
-    for (let configPath of newConfigPaths) {
+    for (const configPath of newConfigPaths) {
+      let filepath = utils.resolveModule(configPath);
+
       // let plugin.js compatible
-      if (configPath.endsWith('plugin.default.js') && !fs.existsSync(configPath)) {
-        configPath = configPath.replace(/plugin\.default\.js$/, 'plugin.js');
+      if (configPath.endsWith('plugin.default') && !filepath) {
+        filepath = utils.resolveModule(configPath.replace(/plugin\.default$/, 'plugin'));
       }
 
-      if (!fs.existsSync(configPath)) {
+      if (!filepath) {
         continue;
       }
 
-      const config = loadFile(configPath);
+      const config = loadFile(filepath);
 
       for (const name in config) {
-        this.normalizePluginConfig(config, name, configPath);
+        this.normalizePluginConfig(config, name, filepath);
       }
 
       this._extendPlugins(plugins, config);

lib/loader/mixin/router.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const path = require('path');
+const utils = require('../../utils');
 
 module.exports = {
 
@@ -12,6 +13,6 @@ module.exports = {
    */
   loadRouter() {
     // 加载 router.js
-    this.loadFile(path.join(this.options.baseDir, 'app/router.js'));
+    this.loadFile(utils.resolveModule(path.join(this.options.baseDir, 'app/router')));
   },
 };

lib/utils/index.js

@@ -12,7 +12,7 @@ module.exports = {
     try {
       // if not js module, just return content buffer
       const extname = path.extname(filepath);
-      if (![ '.js', '.node', '.json', '' ].includes(extname)) {
+      if (extname && !require.extensions[extname]) {
         return fs.readFileSync(filepath);
       }
       // require js module

package.json

@@ -35,6 +35,7 @@
   "devDependencies": {
     "autod": "^3.0.1",
     "coffee": "^4.1.0",
+    "egg": "^2.5.0",
     "egg-bin": "^4.3.7",
     "egg-ci": "^1.8.0",
     "eslint": "^4.18.2",
@@ -45,7 +46,9 @@
     "pedding": "^1.1.0",
     "rimraf": "^2.6.2",
     "spy": "^1.0.0",
-    "supertest": "^3.0.0"
+    "supertest": "^3.0.0",
+    "ts-node": "^5.0.1",
+    "typescript": "^2.7.2"
   },
   "dependencies": {
     "co": "^4.6.0",

test/egg-ts.test.js

@@ -0,0 +1,57 @@
+'use strict';
+
+const request = require('supertest');
+const assert = require('assert');
+const utils = require('./utils');
+const tsNode = require('ts-node');
+
+describe('test/egg-ts.test.js', () => {
+  let app;
+
+  it('should support ts-node', async () => {
+    tsNode.register({
+      typeCheck: true,
+      compilerOptions: {
+        target: 'es2017',
+        module: 'commonjs',
+        moduleResolution: 'node',
+      },
+    });
+
+    app = utils.createApp('egg-ts');
+    app.Helper = class Helper {};
+    app.loader.loadPlugin();
+    app.loader.loadConfig();
+    app.loader.loadApplicationExtend();
+    app.loader.loadAgentExtend();
+    app.loader.loadRequestExtend();
+    app.loader.loadResponseExtend();
+    app.loader.loadContextExtend();
+    app.loader.loadHelperExtend();
+    app.loader.loadService();
+    app.loader.loadController();
+    app.loader.loadRouter();
+    app.loader.loadPlugin();
+    app.loader.loadMiddleware();
+    app.loader.loadCustomApp();
+    app.loader.loadCustomAgent();
+
+    await request(app.callback())
+      .get('/')
+      .expect(res => {
+        assert(res.text.includes('from extend context'));
+        assert(res.text.includes('from extend application'));
+        assert(res.text.includes('from extend request'));
+        assert(res.text.includes('from extend agent'));
+        assert(res.text.includes('from extend helper'));
+        assert(res.text.includes('from extend response'));
+        assert(res.text.includes('from custom app'));
+        assert(res.text.includes('from custom agent'));
+        assert(res.text.includes('from plugins'));
+        assert(res.text.includes('from config.default'));
+        assert(res.text.includes('from middleware'));
+        assert(res.text.includes('from service'));
+      })
+      .expect(200);
+  });
+});

test/fixtures/egg-ts/agent.ts

@@ -0,0 +1,11 @@
+import { Application } from 'egg';
+
+export default (app: Application) => {
+  app.fromCustomAgent = 'from custom agent';
+};
+
+declare module 'egg' {
+  interface Application {
+    fromCustomAgent: string;
+  }
+}

test/fixtures/egg-ts/app.ts

@@ -0,0 +1,12 @@
+import { Application } from 'egg';
+
+export default (app: Application) => {
+  app.fromCustomApp = 'from custom app';
+};
+
+declare module 'egg' {
+  interface Application {
+    Helper: any;
+    fromCustomApp: string;
+  }
+}

test/fixtures/egg-ts/app/controller/home.ts

@@ -0,0 +1,24 @@
+import { Controller } from 'egg';
+
+export default class HomeController extends Controller {
+  public async index() {
+    const { ctx, app } = this;
+    const serviceText = ctx.service.test.getTest();
+    const helper = new ctx.app.Helper();
+
+    ctx.body = [
+      ctx.contextShow(),
+      ctx.app.applicationShow(),
+      ctx.request.requestShow(),
+      ctx.response.responseShow(),
+      ctx.app.agentShow(),
+      helper.helperShow(),
+      app.fromCustomApp,
+      app.fromCustomAgent,
+      app.config.test,
+      app.config.testFromA,
+      ctx.mid,
+      serviceText
+    ].join(',');
+  }
+}

test/fixtures/egg-ts/app/controller/index.d.ts

@@ -0,0 +1,7 @@
+import Home from './home';
+
+declare module 'egg' {
+  interface IController {
+    home: Home;
+  }
+}

test/fixtures/egg-ts/app/extend/agent.ts

@@ -0,0 +1,5 @@
+export default {
+  agentShow() {
+    return 'from extend agent';
+  }
+}

test/fixtures/egg-ts/app/extend/application.ts

@@ -0,0 +1,5 @@
+export default {
+  applicationShow() {
+    return 'from extend application';
+  }
+}

test/fixtures/egg-ts/app/extend/context.ts

@@ -0,0 +1,5 @@
+export default {
+  contextShow() {
+    return 'from extend context';
+  }
+}

test/fixtures/egg-ts/app/extend/helper.ts

@@ -0,0 +1,5 @@
+export default {
+  helperShow() {
+    return 'from extend helper';
+  }
+}