feat: loader support custom extension

eggjs · Mar 20, 2018 · 7c202b2 · 7c202b2
1 parent 9370f86
commit 7c202b2
Show file tree

Hide file tree

Showing 9 changed files with 43 additions and 28 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,4 +3,5 @@ coverage
 .logs
 npm-debug.log
 .vscode
-.DS_Store
+.DS_Store
+yarn.lock
diff --git a/lib/loader/egg_loader.js b/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;
   }
 }

diff --git a/lib/loader/file_loader.js b/lib/loader/file_loader.js
@@ -120,8 +120,16 @@ 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) {
+      const extensions = Object.keys(require.extensions).map(ext => ext.substring(1));
+      files = [ '**/*.(' + extensions.join('|') + ')' ];
+      if (extensions.includes('ts')) {
+        files.push('!**/*.d.ts');
+      }
+    } else {
+      files = Array.isArray(files) ? files : [ files ];
+    }
 
     let ignore = this.options.ignore;
     if (ignore) {

diff --git a/lib/loader/mixin/config.js b/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) {

diff --git a/lib/loader/mixin/custom.js b/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'))));
   },
 
 };
diff --git a/lib/loader/mixin/extend.js b/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();

diff --git a/lib/loader/mixin/plugin.js b/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);

diff --git a/lib/loader/mixin/router.js b/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')));
   },
 };
diff --git a/lib/utils/index.js b/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