@eggjs/core 6.2.11 → 6.2.13

package/src/loader/egg_loader.ts

@@ -5,12 +5,16 @@ import { debuglog, inspect } from 'node:util';
 import { homedir } from 'node-homedir';
 import { isAsyncFunction, isClass, isGeneratorFunction, isObject, isPromise } from 'is-type-of';
 import type { Logger } from 'egg-logger';
-import { getParamNames, readJSONSync, readJSON } from 'utility';
+import {
+  getParamNames, readJSONSync, readJSON, exists,
+} from 'utility';
 import { extend } from 'extend2';
 import { Request, Response, Application, Context as KoaContext } from '@eggjs/koa';
+import { register as tsconfigPathsRegister } from 'tsconfig-paths';
+import { isESM, isSupportTypeScript } from '@eggjs/utils';
 import { pathMatching, type PathMatchingOptions } from 'egg-path-matching';
 import { now, diff } from 'performance-ms';
-import { FULLPATH, FileLoader, FileLoaderOptions } from './file_loader.js';
+import { CaseStyle, FULLPATH, FileLoader, FileLoaderOptions } from './file_loader.js';
 import { ContextLoader, ContextLoaderOptions } from './context_loader.js';
 import utils, { Fun } from '../utils/index.js';
 import sequencify from '../utils/sequencify.js';
@@ -19,6 +23,7 @@ import type {
   Context, EggCore, MiddlewareFunc,
 } from '../egg.js';
 import type { BaseContextClass } from '../base_context_class.js';
+import type { EggAppConfig, EggAppInfo, EggPluginInfo } from '../types.js';
 
 const debug = debuglog('@eggjs/core/loader/egg_loader');
 
@@ -29,44 +34,6 @@ const originalPrototypes: Record<string, any> = {
   application: Application.prototype,
 };
 
-export interface EggAppInfo {
-  /** package.json */
-  pkg: Record<string, any>;
-  /** the application name from package.json */
-  name: string;
-  /** current directory of application */
-  baseDir: string;
-  /** equals to serverEnv */
-  env: string;
-  /** equals to serverScope */
-  scope: string;
-  /** home directory of the OS */
-  HOME: string;
-  /** baseDir when local and unittest, HOME when other environment */
-  root: string;
-}
-
-export interface EggPluginInfo {
-  /** the plugin name, it can be used in `dep` */
-  name: string;
-  /** the package name of plugin */
-  package?: string;
-  version?: string;
-  /** whether enabled */
-  enable: boolean;
-  implicitEnable?: boolean;
-  /** the directory of the plugin package */
-  path?: string;
-  /** the dependent plugins, you can use the plugin name */
-  dependencies: string[];
-  /** the optional dependent plugins. */
-  optionalDependencies: string[];
-  dependents?: string[];
-  /** specify the serverEnv that only enable the plugin in it */
-  env: string[];
-  /** the file plugin config in. */
-  from: string;
-}
 
 export interface EggLoaderOptions {
   /** server env */
@@ -102,7 +69,6 @@ export class EggLoader {
   readonly appInfo: EggAppInfo;
   dirs?: EggDirInfo[];
 
-
   /**
    * @class
    * @param {Object} options - options
@@ -132,12 +98,11 @@ export class EggLoader {
     if (process.env.EGG_TYPESCRIPT === 'true' || (this.pkg.egg && this.pkg.egg.typescript)) {
       // skip require tsconfig-paths if tsconfig.json not exists
       const tsConfigFile = path.join(this.options.baseDir, 'tsconfig.json');
-      // FIXME: support esm
-      if (fs.existsSync(tsConfigFile) && typeof require === 'function') {
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
-        require('tsconfig-paths').register({ cwd: this.options.baseDir });
+      if (fs.existsSync(tsConfigFile)) {
+        tsconfigPathsRegister({ cwd: this.options.baseDir } as any);
       } else {
-        this.logger.info('[@eggjs/core/egg_loader] skip register "tsconfig-paths" because tsconfig.json not exists at %s',
+        this.logger.info(
+          '[@eggjs/core/egg_loader] skip register "tsconfig-paths" because tsconfig.json not exists at %s',
           tsConfigFile);
       }
     }
@@ -636,7 +601,7 @@ export class EggLoader {
         plugin.version = pkg.version;
       }
       // support commonjs and esm dist files
-      plugin.path = this.#formatPluginPathFromPackageJSON(plugin.path!, pkg);
+      plugin.path = await this.#formatPluginPathFromPackageJSON(plugin.path!, pkg);
     }
 
     const logger = this.options.logger;
@@ -790,26 +755,36 @@ export class EggLoader {
     }
   }
 
-  #formatPluginPathFromPackageJSON(pluginPath: string, pluginPkg: {
+  async #formatPluginPathFromPackageJSON(pluginPath: string, pluginPkg: {
     eggPlugin?: {
       exports?: {
         import?: string;
         require?: string;
+        typescript?: string;
       };
     };
-  }) {
-    if (pluginPkg.eggPlugin?.exports) {
-      if (typeof require === 'function') {
-        if (pluginPkg.eggPlugin.exports.require) {
-          pluginPath = path.join(pluginPath, pluginPkg.eggPlugin.exports.require);
+  }): Promise<string> {
+    let realPluginPath = pluginPath;
+    const exports = pluginPkg.eggPlugin?.exports;
+    if (exports) {
+      if (isESM) {
+        if (exports.import) {
+          realPluginPath = path.join(pluginPath, exports.import);
         }
       } else {
-        if (pluginPkg.eggPlugin.exports.import) {
-          pluginPath = path.join(pluginPath, pluginPkg.eggPlugin.exports.import);
+        if (exports.require) {
+          realPluginPath = path.join(pluginPath, exports.require);
+        }
+      }
+      if (exports.typescript && isSupportTypeScript()) {
+        if (!(await exists(realPluginPath))) {
+          // if require/import path not exists, use typescript path for development stage
+          realPluginPath = path.join(pluginPath, exports.typescript);
+          debug('[formatPluginPathFromPackageJSON] use typescript path %o', realPluginPath);
         }
       }
     }
-    return pluginPath;
+    return realPluginPath;
   }
 
   #extendPlugins(targets: Record<string, EggPluginInfo>, plugins: Record<string, EggPluginInfo>) {
@@ -845,7 +820,7 @@ export class EggLoader {
 
   /** start Config loader */
   configMeta: Record<string, any>;
-  config: Record<string, any>;
+  config: EggAppConfig;
 
   /**
    * Load config/config.js
@@ -859,7 +834,10 @@ export class EggLoader {
     this.timing.start('Load Config');
     this.configMeta = {};
 
-    const target: Record<string, any> = {};
+    const target: EggAppConfig = {
+      middleware: [],
+      coreMiddleware: [],
+    };
 
     // Load Application config first
     const appConfig = await this.#preloadAppConfig();
@@ -1208,7 +1186,7 @@ export class EggLoader {
     const servicePaths = this.getLoadUnits().map(unit => path.join(unit.path, 'app/service'));
     options = {
       call: true,
-      caseStyle: 'lower',
+      caseStyle: CaseStyle.lower,
       fieldClass: 'serviceClasses',
       directory: servicePaths,
       ...options,
@@ -1248,7 +1226,7 @@ export class EggLoader {
     opt = {
       call: false,
       override: true,
-      caseStyle: 'lower',
+      caseStyle: CaseStyle.lower,
       directory: middlewarePaths,
       ...opt,
     };
@@ -1323,7 +1301,7 @@ export class EggLoader {
     this.timing.start('Load Controller');
     const controllerBase = path.join(this.options.baseDir, 'app/controller');
     opt = {
-      caseStyle: 'lower',
+      caseStyle: CaseStyle.lower,
       directory: controllerBase,
       initializer: (obj, opt) => {
         // return class if it exports a function
@@ -1403,7 +1381,7 @@ export class EggLoader {
         case 'ctx': {
           assert(!(property in this.app.context), `customLoader should not override ctx.${property}`);
           const options = {
-            caseStyle: 'lower',
+            caseStyle: CaseStyle.lower,
             fieldClass: `${property}Classes`,
             ...loaderConfig,
             directory,
@@ -1414,7 +1392,7 @@ export class EggLoader {
         case 'app': {
           assert(!(property in this.app), `customLoader should not override app.${property}`);
           const options = {
-            caseStyle: 'lower',
+            caseStyle: CaseStyle.lower,
             initializer: (Clazz: unknown) => {
               return isClass(Clazz) ? new Clazz(this.app) : Clazz;
             },
@@ -1533,10 +1511,11 @@ export class EggLoader {
    * @param {Object} options - see {@link FileLoader}
    * @since 1.0.0
    */
-  async loadToApp(directory: string | string[], property: string | symbol, options?: FileLoaderOptions) {
+  async loadToApp(directory: string | string[], property: string | symbol,
+    options?: Omit<FileLoaderOptions, 'inject' | 'target'>) {
     const target = {};
     Reflect.set(this.app, property, target);
-    options = {
+    const loadOptions: FileLoaderOptions = {
       ...options,
       directory: options?.directory ?? directory,
       target,
@@ -1545,7 +1524,7 @@ export class EggLoader {
 
     const timingKey = `Load "${String(property)}" to Application`;
     this.timing.start(timingKey);
-    await new FileLoader(options).load();
+    await new FileLoader(loadOptions).load();
     this.timing.end(timingKey);
   }
 
@@ -1556,8 +1535,9 @@ export class EggLoader {
    * @param {Object} options - see {@link ContextLoader}
    * @since 1.0.0
    */
-  async loadToContext(directory: string | string[], property: string | symbol, options?: ContextLoaderOptions) {
-    options = {
+  async loadToContext(directory: string | string[], property: string | symbol,
+    options?: Omit<ContextLoaderOptions, 'inject' | 'property'>) {
+    const loadOptions: ContextLoaderOptions = {
       ...options,
       directory: options?.directory || directory,
       property,
@@ -1566,7 +1546,7 @@ export class EggLoader {
 
     const timingKey = `Load "${String(property)}" to Context`;
     this.timing.start(timingKey);
-    await new ContextLoader(options).load();
+    await new ContextLoader(loadOptions).load();
     this.timing.end(timingKey);
   }
 

package/src/loader/file_loader.ts

@@ -11,7 +11,12 @@ const debug = debuglog('@eggjs/core/file_loader');
 export const FULLPATH = Symbol('EGG_LOADER_ITEM_FULLPATH');
 export const EXPORTS = Symbol('EGG_LOADER_ITEM_EXPORTS');
 
-export type CaseStyle = 'camel' | 'lower' | 'upper';
+export enum CaseStyle {
+  camel = 'camel',
+  lower = 'lower',
+  upper = 'upper',
+}
+
 export type CaseStyleFunction = (filepath: string) => string[];
 export type FileLoaderInitializer = (exports: unknown, options: { path: string; pathName: string }) => unknown;
 export type FileLoaderFilter = (exports: unknown) => boolean;
@@ -79,7 +84,7 @@ export class FileLoader {
     assert(options.directory, 'options.directory is required');
     assert(options.target, 'options.target is required');
     this.options = {
-      caseStyle: 'camel',
+      caseStyle: CaseStyle.camel,
       call: true,
       override: false,
       ...options,
@@ -88,7 +93,7 @@ export class FileLoader {
     // compatible old options _lowercaseFirst_
     if (this.options.lowercaseFirst === true) {
       utils.deprecated('lowercaseFirst is deprecated, use caseStyle instead');
-      this.options.caseStyle = 'lower';
+      this.options.caseStyle = CaseStyle.lower;
     }
   }
 

package/src/types.ts

@@ -0,0 +1,56 @@
+export interface EggAppInfo {
+  /** package.json */
+  pkg: Record<string, any>;
+  /** the application name from package.json */
+  name: string;
+  /** current directory of application */
+  baseDir: string;
+  /** equals to serverEnv */
+  env: string;
+  /** equals to serverScope */
+  scope: string;
+  /** home directory of the OS */
+  HOME: string;
+  /** baseDir when local and unittest, HOME when other environment */
+  root: string;
+}
+
+export interface EggPluginInfo {
+  /** the plugin name, it can be used in `dep` */
+  name: string;
+  /** the package name of plugin */
+  package?: string;
+  version?: string;
+  /** whether enabled */
+  enable: boolean;
+  implicitEnable?: boolean;
+  /** the directory of the plugin package */
+  path?: string;
+  /** the dependent plugins, you can use the plugin name */
+  dependencies: string[];
+  /** the optional dependent plugins. */
+  optionalDependencies: string[];
+  dependents?: string[];
+  /** specify the serverEnv that only enable the plugin in it */
+  env: string[];
+  /** the file plugin config in. */
+  from: string;
+}
+
+export interface CustomLoaderConfigItem {
+  /** the directory of the custom loader */
+  directory: string;
+  /** the inject object, it can be app or ctx */
+  inject: string;
+  /** whether load unit files */
+  loadunit?: boolean;
+}
+
+export interface EggAppConfig extends Record<string, any> {
+  coreMiddleware: string[];
+  middleware: string[];
+  customLoader?: Record<string, CustomLoaderConfigItem>;
+  controller?: {
+    supportParams?: boolean;
+  };
+}