@eggjs/utils 3.0.1 → 4.0.1

package/dist/esm/import.js

@@ -0,0 +1,72 @@
+import { debuglog } from 'node:util';
+import { createRequire } from 'node:module';
+import { pathToFileURL } from 'node:url';
+const debug = debuglog('@eggjs/utils:loader');
+let _customRequire;
+export function importResolve(filepath, options) {
+    if (!_customRequire) {
+        if (typeof require !== 'undefined') {
+            _customRequire = require;
+        }
+        else {
+            _customRequire = createRequire(process.cwd());
+        }
+    }
+    const moduleFilePath = _customRequire.resolve(filepath, options);
+    debug('[importResolve] %o, options: %o => %o', filepath, options, moduleFilePath);
+    return moduleFilePath;
+}
+export async function importModule(filepath, options) {
+    const moduleFilePath = importResolve(filepath, options);
+    let obj;
+    if (typeof require === 'function') {
+        // commonjs
+        obj = require(moduleFilePath);
+        debug('[importModule] require %o => %o', filepath, obj);
+        if (obj?.__esModule === true && 'default' in obj) {
+            // 兼容 cjs 模拟 esm 的导出格式
+            // {
+            //   __esModule: true,
+            //   default: { fn: [Function: fn], foo: 'bar', one: 1 }
+            // }
+            obj = obj.default;
+        }
+    }
+    else {
+        // esm
+        debug('[importModule] await import start: %o', filepath);
+        const fileUrl = pathToFileURL(moduleFilePath).toString();
+        obj = await import(fileUrl);
+        debug('[importModule] await import end: %o => %o', filepath, obj);
+        // {
+        //   default: { foo: 'bar', one: 1 },
+        //   foo: 'bar',
+        //   one: 1,
+        //   [Symbol(Symbol.toStringTag)]: 'Module'
+        // }
+        if (obj?.__esModule === true && obj?.default?.__esModule === true) {
+            // 兼容 cjs 模拟 esm 的导出格式
+            // {
+            //   __esModule: true,
+            //   default: {
+            //     __esModule: true,
+            //     default: {
+            //       fn: [Function: fn] { [length]: 0, [name]: 'fn' },
+            //       foo: 'bar',
+            //       one: 1
+            //     }
+            //   },
+            //   [Symbol(Symbol.toStringTag)]: 'Module'
+            // }
+            obj = obj.default;
+        }
+        if (options?.importDefaultOnly) {
+            if ('default' in obj) {
+                obj = obj.default;
+            }
+        }
+    }
+    debug('[importModule] return %o => %o', filepath, obj);
+    return obj;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW1wb3J0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2ltcG9ydC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsUUFBUSxFQUFFLE1BQU0sV0FBVyxDQUFDO0FBQ3JDLE9BQU8sRUFBRSxhQUFhLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFDNUMsT0FBTyxFQUFFLGFBQWEsRUFBRSxNQUFNLFVBQVUsQ0FBQztBQUV6QyxNQUFNLEtBQUssR0FBRyxRQUFRLENBQUMscUJBQXFCLENBQUMsQ0FBQztBQUU5QyxJQUFJLGNBQTJCLENBQUM7QUFXaEMsTUFBTSxVQUFVLGFBQWEsQ0FBQyxRQUFnQixFQUFFLE9BQThCO0lBQzVFLElBQUksQ0FBQyxjQUFjLEVBQUUsQ0FBQztRQUNwQixJQUFJLE9BQU8sT0FBTyxLQUFLLFdBQVcsRUFBRSxDQUFDO1lBQ25DLGNBQWMsR0FBRyxPQUFPLENBQUM7UUFDM0IsQ0FBQzthQUFNLENBQUM7WUFDTixjQUFjLEdBQUcsYUFBYSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsQ0FBQyxDQUFDO1FBQ2hELENBQUM7SUFDSCxDQUFDO0lBQ0QsTUFBTSxjQUFjLEdBQUcsY0FBYyxDQUFDLE9BQU8sQ0FBQyxRQUFRLEVBQUUsT0FBTyxDQUFDLENBQUM7SUFDakUsS0FBSyxDQUFDLHVDQUF1QyxFQUFFLFFBQVEsRUFBRSxPQUFPLEVBQUUsY0FBYyxDQUFDLENBQUM7SUFDbEYsT0FBTyxjQUFjLENBQUM7QUFDeEIsQ0FBQztBQUVELE1BQU0sQ0FBQyxLQUFLLFVBQVUsWUFBWSxDQUFDLFFBQWdCLEVBQUUsT0FBNkI7SUFDaEYsTUFBTSxjQUFjLEdBQUcsYUFBYSxDQUFDLFFBQVEsRUFBRSxPQUFPLENBQUMsQ0FBQztJQUN4RCxJQUFJLEdBQVEsQ0FBQztJQUNiLElBQUksT0FBTyxPQUFPLEtBQUssVUFBVSxFQUFFLENBQUM7UUFDbEMsV0FBVztRQUNYLEdBQUcsR0FBRyxPQUFPLENBQUMsY0FBYyxDQUFDLENBQUM7UUFDOUIsS0FBSyxDQUFDLGlDQUFpQyxFQUFFLFFBQVEsRUFBRSxHQUFHLENBQUMsQ0FBQztRQUN4RCxJQUFJLEdBQUcsRUFBRSxVQUFVLEtBQUssSUFBSSxJQUFJLFNBQVMsSUFBSSxHQUFHLEVBQUUsQ0FBQztZQUNqRCxzQkFBc0I7WUFDdEIsSUFBSTtZQUNKLHNCQUFzQjtZQUN0Qix3REFBd0Q7WUFDeEQsSUFBSTtZQUNKLEdBQUcsR0FBRyxHQUFHLENBQUMsT0FBTyxDQUFDO1FBQ3BCLENBQUM7SUFDSCxDQUFDO1NBQU0sQ0FBQztRQUNOLE1BQU07UUFDTixLQUFLLENBQUMsdUNBQXVDLEVBQUUsUUFBUSxDQUFDLENBQUM7UUFDekQsTUFBTSxPQUFPLEdBQUcsYUFBYSxDQUFDLGNBQWMsQ0FBQyxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQ3pELEdBQUcsR0FBRyxNQUFNLE1BQU0sQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUM1QixLQUFLLENBQUMsMkNBQTJDLEVBQUUsUUFBUSxFQUFFLEdBQUcsQ0FBQyxDQUFDO1FBQ2xFLElBQUk7UUFDSixxQ0FBcUM7UUFDckMsZ0JBQWdCO1FBQ2hCLFlBQVk7UUFDWiwyQ0FBMkM7UUFDM0MsSUFBSTtRQUNKLElBQUksR0FBRyxFQUFFLFVBQVUsS0FBSyxJQUFJLElBQUksR0FBRyxFQUFFLE9BQU8sRUFBRSxVQUFVLEtBQUssSUFBSSxFQUFFLENBQUM7WUFDbEUsc0JBQXNCO1lBQ3RCLElBQUk7WUFDSixzQkFBc0I7WUFDdEIsZUFBZTtZQUNmLHdCQUF3QjtZQUN4QixpQkFBaUI7WUFDakIsMERBQTBEO1lBQzFELG9CQUFvQjtZQUNwQixlQUFlO1lBQ2YsUUFBUTtZQUNSLE9BQU87WUFDUCwyQ0FBMkM7WUFDM0MsSUFBSTtZQUNKLEdBQUcsR0FBRyxHQUFHLENBQUMsT0FBTyxDQUFDO1FBQ3BCLENBQUM7UUFDRCxJQUFJLE9BQU8sRUFBRSxpQkFBaUIsRUFBRSxDQUFDO1lBQy9CLElBQUksU0FBUyxJQUFJLEdBQUcsRUFBRSxDQUFDO2dCQUNyQixHQUFHLEdBQUcsR0FBRyxDQUFDLE9BQU8sQ0FBQztZQUNwQixDQUFDO1FBQ0gsQ0FBQztJQUNILENBQUM7SUFDRCxLQUFLLENBQUMsZ0NBQWdDLEVBQUUsUUFBUSxFQUFFLEdBQUcsQ0FBQyxDQUFDO0lBQ3ZELE9BQU8sR0FBRyxDQUFDO0FBQ2IsQ0FBQyJ9

package/dist/esm/index.d.ts

@@ -0,0 +1,15 @@
+import { getFrameworkPath } from './framework.js';
+import { getPlugins, getConfig, getLoadUnits } from './plugin.js';
+import { getFrameworkOrEggPath } from './deprecated.js';
+export { getFrameworkPath } from './framework.js';
+export { getPlugins, getConfig, getLoadUnits } from './plugin.js';
+export { getFrameworkOrEggPath } from './deprecated.js';
+export * from './import.js';
+declare const _default: {
+    getFrameworkPath: typeof getFrameworkPath;
+    getPlugins: typeof getPlugins;
+    getConfig: typeof getConfig;
+    getLoadUnits: typeof getLoadUnits;
+    getFrameworkOrEggPath: typeof getFrameworkOrEggPath;
+};
+export default _default;

package/dist/esm/index.js

@@ -0,0 +1,15 @@
+import { getFrameworkPath } from './framework.js';
+import { getPlugins, getConfig, getLoadUnits } from './plugin.js';
+import { getFrameworkOrEggPath } from './deprecated.js';
+// support import { getFrameworkPath } from '@eggjs/utils'
+export { getFrameworkPath } from './framework.js';
+export { getPlugins, getConfig, getLoadUnits } from './plugin.js';
+export { getFrameworkOrEggPath } from './deprecated.js';
+export * from './import.js';
+// support import utils from '@eggjs/utils'
+export default {
+    getFrameworkPath,
+    getPlugins, getConfig, getLoadUnits,
+    getFrameworkOrEggPath,
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLGdCQUFnQixFQUFFLE1BQU0sZ0JBQWdCLENBQUM7QUFDbEQsT0FBTyxFQUFFLFVBQVUsRUFBRSxTQUFTLEVBQUUsWUFBWSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBQ2xFLE9BQU8sRUFBRSxxQkFBcUIsRUFBRSxNQUFNLGlCQUFpQixDQUFDO0FBRXhELDBEQUEwRDtBQUMxRCxPQUFPLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxnQkFBZ0IsQ0FBQztBQUNsRCxPQUFPLEVBQUUsVUFBVSxFQUFFLFNBQVMsRUFBRSxZQUFZLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFDbEUsT0FBTyxFQUFFLHFCQUFxQixFQUFFLE1BQU0saUJBQWlCLENBQUM7QUFDeEQsY0FBYyxhQUFhLENBQUM7QUFFNUIsMkNBQTJDO0FBQzNDLGVBQWU7SUFDYixnQkFBZ0I7SUFDaEIsVUFBVSxFQUFFLFNBQVMsRUFBRSxZQUFZO0lBQ25DLHFCQUFxQjtDQUN0QixDQUFDIn0=

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/esm/plugin.d.ts

@@ -0,0 +1,30 @@
+export interface LoaderOptions {
+    framework: string;
+    baseDir: string;
+    env?: string;
+}
+export interface Plugin {
+    name: string;
+    version?: string;
+    enable: boolean;
+    implicitEnable: boolean;
+    path: string;
+    dependencies: string[];
+    optionalDependencies: string[];
+    env: string[];
+    from: string;
+}
+/**
+ * @see https://github.com/eggjs/egg-core/blob/2920f6eade07959d25f5c4f96b154d3fbae877db/lib/loader/mixin/plugin.js#L203
+ */
+export declare function getPlugins(options: LoaderOptions): Promise<Record<string, Plugin>>;
+interface Unit {
+    type: 'plugin' | 'framework' | 'app';
+    path: string;
+}
+/**
+ * @see https://github.com/eggjs/egg-core/blob/2920f6eade07959d25f5c4f96b154d3fbae877db/lib/loader/egg_loader.js#L348
+ */
+export declare function getLoadUnits(options: LoaderOptions): Promise<Unit[]>;
+export declare function getConfig(options: LoaderOptions): Promise<Record<string, any>>;
+export {};

package/dist/esm/plugin.js

@@ -0,0 +1,113 @@
+import { debuglog } from 'node:util';
+import path from 'node:path';
+import assert from 'node:assert';
+import os from 'node:os';
+import { stat, mkdir, writeFile, realpath } from 'node:fs/promises';
+import { importModule } from './import.js';
+const debug = debuglog('@eggjs/utils:plugin');
+const tmpDir = os.tmpdir();
+function noop() { }
+const logger = {
+    debug: noop,
+    info: noop,
+    warn: noop,
+    error: noop,
+};
+/**
+ * @see https://github.com/eggjs/egg-core/blob/2920f6eade07959d25f5c4f96b154d3fbae877db/lib/loader/mixin/plugin.js#L203
+ */
+export async function getPlugins(options) {
+    const loader = await getLoader(options);
+    await loader.loadPlugin();
+    return loader.allPlugins;
+}
+/**
+ * @see https://github.com/eggjs/egg-core/blob/2920f6eade07959d25f5c4f96b154d3fbae877db/lib/loader/egg_loader.js#L348
+ */
+export async function getLoadUnits(options) {
+    const loader = await getLoader(options);
+    await loader.loadPlugin();
+    return loader.getLoadUnits();
+}
+export async function getConfig(options) {
+    const loader = await getLoader(options);
+    await loader.loadPlugin();
+    await loader.loadConfig();
+    return loader.config;
+}
+async function exists(filepath) {
+    try {
+        await stat(filepath);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+async function getLoader(options) {
+    assert(options.framework, 'framework is required');
+    assert(await exists(options.framework), `${options.framework} should exist`);
+    if (!(options.baseDir && await exists(options.baseDir))) {
+        options.baseDir = path.join(tmpDir, 'egg_utils', `${Date.now()}`, 'tmp_app');
+        await mkdir(options.baseDir, { recursive: true });
+        await writeFile(path.join(options.baseDir, 'package.json'), JSON.stringify({
+            name: 'tmp_app',
+        }));
+        debug('[getLoader] create baseDir: %o', options.baseDir);
+    }
+    const { EggCore, EggLoader } = await findEggCore(options);
+    const mod = await importModule(options.framework);
+    const Application = mod.Application ?? mod.default?.Application;
+    assert(Application, `Application not export on ${options.framework}`);
+    if (options.env) {
+        process.env.EGG_SERVER_ENV = options.env;
+    }
+    return new EggLoader({
+        baseDir: options.baseDir,
+        logger,
+        app: Object.create(Application.prototype),
+        EggCoreClass: EggCore,
+    });
+}
+async function findEggCore(options) {
+    const baseDirRealpath = await realpath(options.baseDir);
+    const frameworkRealpath = await realpath(options.framework);
+    const paths = [frameworkRealpath, baseDirRealpath];
+    // custom framework => egg => @eggjs/core
+    try {
+        const { EggCore, EggLoader } = await importModule('egg', { paths });
+        if (EggLoader) {
+            return { EggCore, EggLoader };
+        }
+    }
+    catch (err) {
+        debug('[findEggCore] import "egg" from paths:%o error: %o', paths, err);
+    }
+    const name = '@eggjs/core';
+    // egg => egg-core
+    try {
+        const { EggCore, EggLoader } = await importModule(name, { paths });
+        if (EggLoader) {
+            return { EggCore, EggLoader };
+        }
+    }
+    catch (err) {
+        debug('[findEggCore] import "%s" from paths:%o error: %o', name, paths, err);
+    }
+    try {
+        const { EggCore, EggLoader } = await importModule(name);
+        if (EggLoader) {
+            return { EggCore, EggLoader };
+        }
+    }
+    catch (err) {
+        debug('[findEggCore] import "%s" error: %o', name, err);
+    }
+    let eggCorePath = path.join(options.baseDir, `node_modules/${name}`);
+    if (!(await exists(eggCorePath))) {
+        eggCorePath = path.join(options.framework, `node_modules/${name}`);
+    }
+    assert(await exists(eggCorePath), `Can't find ${name} from ${options.baseDir} and ${options.framework}`);
+    return await importModule(eggCorePath);
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGx1Z2luLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3BsdWdpbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsUUFBUSxFQUFFLE1BQU0sV0FBVyxDQUFDO0FBQ3JDLE9BQU8sSUFBSSxNQUFNLFdBQVcsQ0FBQztBQUM3QixPQUFPLE1BQU0sTUFBTSxhQUFhLENBQUM7QUFDakMsT0FBTyxFQUFFLE1BQU0sU0FBUyxDQUFDO0FBQ3pCLE9BQU8sRUFBRSxJQUFJLEVBQUUsS0FBSyxFQUFFLFNBQVMsRUFBRSxRQUFRLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUNwRSxPQUFPLEVBQUUsWUFBWSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBRTNDLE1BQU0sS0FBSyxHQUFHLFFBQVEsQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDO0FBRTlDLE1BQU0sTUFBTSxHQUFHLEVBQUUsQ0FBQyxNQUFNLEVBQUUsQ0FBQztBQUUzQixTQUFTLElBQUksS0FBSSxDQUFDO0FBRWxCLE1BQU0sTUFBTSxHQUFHO0lBQ2IsS0FBSyxFQUFFLElBQUk7SUFDWCxJQUFJLEVBQUUsSUFBSTtJQUNWLElBQUksRUFBRSxJQUFJO0lBQ1YsS0FBSyxFQUFFLElBQUk7Q0FDWixDQUFDO0FBb0JGOztHQUVHO0FBQ0gsTUFBTSxDQUFDLEtBQUssVUFBVSxVQUFVLENBQUMsT0FBc0I7SUFDckQsTUFBTSxNQUFNLEdBQUcsTUFBTSxTQUFTLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDeEMsTUFBTSxNQUFNLENBQUMsVUFBVSxFQUFFLENBQUM7SUFDMUIsT0FBTyxNQUFNLENBQUMsVUFBVSxDQUFDO0FBQzNCLENBQUM7QUFPRDs7R0FFRztBQUNILE1BQU0sQ0FBQyxLQUFLLFVBQVUsWUFBWSxDQUFDLE9BQXNCO0lBQ3ZELE1BQU0sTUFBTSxHQUFHLE1BQU0sU0FBUyxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQ3hDLE1BQU0sTUFBTSxDQUFDLFVBQVUsRUFBRSxDQUFDO0lBQzFCLE9BQU8sTUFBTSxDQUFDLFlBQVksRUFBRSxDQUFDO0FBQy9CLENBQUM7QUFFRCxNQUFNLENBQUMsS0FBSyxVQUFVLFNBQVMsQ0FBQyxPQUFzQjtJQUNwRCxNQUFNLE1BQU0sR0FBRyxNQUFNLFNBQVMsQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUN4QyxNQUFNLE1BQU0sQ0FBQyxVQUFVLEVBQUUsQ0FBQztJQUMxQixNQUFNLE1BQU0sQ0FBQyxVQUFVLEVBQUUsQ0FBQztJQUMxQixPQUFPLE1BQU0sQ0FBQyxNQUFNLENBQUM7QUFDdkIsQ0FBQztBQUVELEtBQUssVUFBVSxNQUFNLENBQUMsUUFBZ0I7SUFDcEMsSUFBSSxDQUFDO1FBQ0gsTUFBTSxJQUFJLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDckIsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBQUMsTUFBTSxDQUFDO1FBQ1AsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0FBQ0gsQ0FBQztBQW1CRCxLQUFLLFVBQVUsU0FBUyxDQUFDLE9BQXNCO0lBQzdDLE1BQU0sQ0FBQyxPQUFPLENBQUMsU0FBUyxFQUFFLHVCQUF1QixDQUFDLENBQUM7SUFDbkQsTUFBTSxDQUFDLE1BQU0sTUFBTSxDQUFDLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxHQUFHLE9BQU8sQ0FBQyxTQUFTLGVBQWUsQ0FBQyxDQUFDO0lBQzdFLElBQUksQ0FBQyxDQUFDLE9BQU8sQ0FBQyxPQUFPLElBQUksTUFBTSxNQUFNLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQUFDLEVBQUUsQ0FBQztRQUN4RCxPQUFPLENBQUMsT0FBTyxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLFdBQVcsRUFBRSxHQUFHLElBQUksQ0FBQyxHQUFHLEVBQUUsRUFBRSxFQUFFLFNBQVMsQ0FBQyxDQUFDO1FBQzdFLE1BQU0sS0FBSyxDQUFDLE9BQU8sQ0FBQyxPQUFPLEVBQUUsRUFBRSxTQUFTLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQztRQUNsRCxNQUFNLFNBQVMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLEVBQUUsY0FBYyxDQUFDLEVBQUUsSUFBSSxDQUFDLFNBQVMsQ0FBQztZQUN6RSxJQUFJLEVBQUUsU0FBUztTQUNoQixDQUFDLENBQUMsQ0FBQztRQUNKLEtBQUssQ0FBQyxnQ0FBZ0MsRUFBRSxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDM0QsQ0FBQztJQUVELE1BQU0sRUFBRSxPQUFPLEVBQUUsU0FBUyxFQUFFLEdBQUcsTUFBTSxXQUFXLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDMUQsTUFBTSxHQUFHLEdBQUcsTUFBTSxZQUFZLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQ2xELE1BQU0sV0FBVyxHQUFHLEdBQUcsQ0FBQyxXQUFXLElBQUksR0FBRyxDQUFDLE9BQU8sRUFBRSxXQUFXLENBQUM7SUFDaEUsTUFBTSxDQUFDLFdBQVcsRUFBRSw2QkFBNkIsT0FBTyxDQUFDLFNBQVMsRUFBRSxDQUFDLENBQUM7SUFDdEUsSUFBSSxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUM7UUFDaEIsT0FBTyxDQUFDLEdBQUcsQ0FBQyxjQUFjLEdBQUcsT0FBTyxDQUFDLEdBQUcsQ0FBQztJQUMzQyxDQUFDO0lBQ0QsT0FBTyxJQUFJLFNBQVMsQ0FBQztRQUNuQixPQUFPLEVBQUUsT0FBTyxDQUFDLE9BQU87UUFDeEIsTUFBTTtRQUNOLEdBQUcsRUFBRSxNQUFNLENBQUMsTUFBTSxDQUFDLFdBQVcsQ0FBQyxTQUFTLENBQUM7UUFDekMsWUFBWSxFQUFFLE9BQU87S0FDdEIsQ0FBQyxDQUFDO0FBQ0wsQ0FBQztBQUVELEtBQUssVUFBVSxXQUFXLENBQUMsT0FBc0I7SUFDL0MsTUFBTSxlQUFlLEdBQUcsTUFBTSxRQUFRLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQ3hELE1BQU0saUJBQWlCLEdBQUcsTUFBTSxRQUFRLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQzVELE1BQU0sS0FBSyxHQUFHLENBQUUsaUJBQWlCLEVBQUUsZUFBZSxDQUFFLENBQUM7SUFDckQseUNBQXlDO0lBQ3pDLElBQUksQ0FBQztRQUNILE1BQU0sRUFBRSxPQUFPLEVBQUUsU0FBUyxFQUFFLEdBQUcsTUFBTSxZQUFZLENBQUMsS0FBSyxFQUFFLEVBQUUsS0FBSyxFQUFFLENBQUMsQ0FBQztRQUNwRSxJQUFJLFNBQVMsRUFBRSxDQUFDO1lBQ2QsT0FBTyxFQUFFLE9BQU8sRUFBRSxTQUFTLEVBQUUsQ0FBQztRQUNoQyxDQUFDO0lBQ0gsQ0FBQztJQUFDLE9BQU8sR0FBUSxFQUFFLENBQUM7UUFDbEIsS0FBSyxDQUFDLG9EQUFvRCxFQUFFLEtBQUssRUFBRSxHQUFHLENBQUMsQ0FBQztJQUMxRSxDQUFDO0lBRUQsTUFBTSxJQUFJLEdBQUcsYUFBYSxDQUFDO0lBQzNCLGtCQUFrQjtJQUNsQixJQUFJLENBQUM7UUFDSCxNQUFNLEVBQUUsT0FBTyxFQUFFLFNBQVMsRUFBRSxHQUFHLE1BQU0sWUFBWSxDQUFDLElBQUksRUFBRSxFQUFFLEtBQUssRUFBRSxDQUFDLENBQUM7UUFDbkUsSUFBSSxTQUFTLEVBQUUsQ0FBQztZQUNkLE9BQU8sRUFBRSxPQUFPLEVBQUUsU0FBUyxFQUFFLENBQUM7UUFDaEMsQ0FBQztJQUNILENBQUM7SUFBQyxPQUFPLEdBQVEsRUFBRSxDQUFDO1FBQ2xCLEtBQUssQ0FBQyxtREFBbUQsRUFBRSxJQUFJLEVBQUUsS0FBSyxFQUFFLEdBQUcsQ0FBQyxDQUFDO0lBQy9FLENBQUM7SUFFRCxJQUFJLENBQUM7UUFDSCxNQUFNLEVBQUUsT0FBTyxFQUFFLFNBQVMsRUFBRSxHQUFHLE1BQU0sWUFBWSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ3hELElBQUksU0FBUyxFQUFFLENBQUM7WUFDZCxPQUFPLEVBQUUsT0FBTyxFQUFFLFNBQVMsRUFBRSxDQUFDO1FBQ2hDLENBQUM7SUFDSCxDQUFDO0lBQUMsT0FBTyxHQUFRLEVBQUUsQ0FBQztRQUNsQixLQUFLLENBQUMscUNBQXFDLEVBQUUsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFDO0lBQzFELENBQUM7SUFFRCxJQUFJLFdBQVcsR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLEVBQUUsZ0JBQWdCLElBQUksRUFBRSxDQUFDLENBQUM7SUFDckUsSUFBSSxDQUFDLENBQUMsTUFBTSxNQUFNLENBQUMsV0FBVyxDQUFDLENBQUMsRUFBRSxDQUFDO1FBQ2pDLFdBQVcsR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxTQUFTLEVBQUUsZ0JBQWdCLElBQUksRUFBRSxDQUFDLENBQUM7SUFDckUsQ0FBQztJQUNELE1BQU0sQ0FBQyxNQUFNLE1BQU0sQ0FBQyxXQUFXLENBQUMsRUFBRSxjQUFjLElBQUksU0FBUyxPQUFPLENBQUMsT0FBTyxRQUFRLE9BQU8sQ0FBQyxTQUFTLEVBQUUsQ0FBQyxDQUFDO0lBQ3pHLE9BQU8sTUFBTSxZQUFZLENBQUMsV0FBVyxDQUFDLENBQUM7QUFDekMsQ0FBQyJ9

package/dist/esm/utils.d.ts

@@ -0,0 +1 @@
+export declare function readJSONSync(file: string): any;

package/dist/esm/utils.js

@@ -0,0 +1,8 @@
+import { existsSync, readFileSync } from 'node:fs';
+export function readJSONSync(file) {
+    if (!existsSync(file)) {
+        throw new Error(`${file} is not found`);
+    }
+    return JSON.parse(readFileSync(file, 'utf-8'));
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdXRpbHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFVBQVUsRUFBRSxZQUFZLEVBQUUsTUFBTSxTQUFTLENBQUM7QUFFbkQsTUFBTSxVQUFVLFlBQVksQ0FBQyxJQUFZO0lBQ3ZDLElBQUksQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQztRQUN0QixNQUFNLElBQUksS0FBSyxDQUFDLEdBQUcsSUFBSSxlQUFlLENBQUMsQ0FBQztJQUMxQyxDQUFDO0lBQ0QsT0FBTyxJQUFJLENBQUMsS0FBSyxDQUFDLFlBQVksQ0FBQyxJQUFJLEVBQUUsT0FBTyxDQUFDLENBQUMsQ0FBQztBQUNqRCxDQUFDIn0=

package/package.json

@@ -1,22 +1,22 @@
 {
   "name": "@eggjs/utils",
-  "version": "3.0.1",
+  "version": "4.0.1",
+  "engine": {
+    "node": ">=18.19.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
   "description": "Utils for all egg projects",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "files": [
-    "lib"
-  ],
   "scripts": {
-    "lint": "eslint .",
-    "pretest": "npm run lint && npm run tsc",
-    "test": "egg-bin test",
-    "preci": "npm run lint && npm run tsc",
-    "ci": "egg-bin cov",
-    "tsc": "tsc",
-    "clean": "tsc --build --clean",
-    "prepublishOnly": "npm run clean && npm run tsc",
-    "contributor": "git-contributor"
+    "lint": "eslint src test --ext ts",
+    "pretest": "npm run prepublishOnly",
+    "test": "npm run lint -- --fix && npm run test-local",
+    "test-local": "egg-bin test",
+    "preci": "npm run prepublishOnly",
+    "ci": "npm run lint && egg-bin cov && npm run prepublishOnly",
+    "contributor": "git-contributor",
+    "prepublishOnly": "tshy && tshy-after"
   },
   "keywords": [
     "egg",
@@ -25,29 +25,52 @@
   "author": "fengmk2 <fengmk2@gmail.com> (https://github.com/fengmk2)",
   "repository": {
     "type": "git",
-    "url": "https://github.com/eggjs/egg-utils.git"
+    "url": "git://github.com/eggjs/egg-utils.git"
   },
   "license": "MIT",
   "dependencies": {},
   "devDependencies": {
-    "@eggjs/tsconfig": "^1.3.3",
-    "@types/mocha": "^10.0.1",
-    "@types/node": "^20.2.5",
-    "coffee": "^5.5.0",
-    "egg-bin": "^6.4.0",
-    "eslint": "^8.41.0",
-    "eslint-config-egg": "^12.2.1",
-    "git-contributor": "^2.1.5",
-    "mm": "^3.3.0",
-    "npm": "^9.6.7",
-    "npminstall": "^7.9.0",
-    "runscript": "^1.5.3",
-    "typescript": "^5.0.4"
+    "@eggjs/tsconfig": "1",
+    "@types/mocha": "10",
+    "@types/node": "20",
+    "coffee": "5",
+    "egg-bin": "6",
+    "eslint": "8",
+    "eslint-config-egg": "13",
+    "git-contributor": "2",
+    "mm": "3",
+    "npminstall": "7",
+    "runscript": "1",
+    "tshy": "1",
+    "tshy-after": "1",
+    "typescript": "5"
   },
-  "engine": {
-    "node": ">=16.13.0"
+  "files": [
+    "dist",
+    "src"
+  ],
+  "type": "module",
+  "tshy": {
+    "exports": {
+      "./package.json": "./package.json",
+      ".": "./src/index.ts"
+    }
   },
-  "publishConfig": {
-    "access": "public"
-  }
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "source": "./src/index.ts",
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "source": "./src/index.ts",
+        "types": "./dist/commonjs/index.d.ts",
+        "default": "./dist/commonjs/index.js"
+      }
+    }
+  },
+  "main": "./dist/commonjs/index.js",
+  "types": "./dist/commonjs/index.d.ts"
 }

package/src/deprecated.ts

@@ -0,0 +1,58 @@
+import path from 'node:path';
+import { existsSync, readdirSync } from 'node:fs';
+import { readJSONSync } from './utils.js';
+
+/**
+ * Try to get framework dir path
+ * If can't find any framework, try to find egg dir path
+ *
+ * @param {String} cwd - current work path
+ * @param {Array} [eggNames] - egg names, default is ['egg']
+ * @return {String} framework or egg dir path
+ * @deprecated
+ */
+export function getFrameworkOrEggPath(cwd: string, eggNames?: string[]): string {
+  eggNames = eggNames || [ 'egg' ];
+  const moduleDir = path.join(cwd, 'node_modules');
+  if (!existsSync(moduleDir)) {
+    return '';
+  }
+
+  // try to get framework
+
+  // 1. try to read egg.framework property on package.json
+  const pkgFile = path.join(cwd, 'package.json');
+  if (existsSync(pkgFile)) {
+    const pkg = readJSONSync(pkgFile);
+    if (pkg.egg && pkg.egg.framework) {
+      return path.join(moduleDir, pkg.egg.framework);
+    }
+  }
+
+  // 2. try the module dependencies includes eggNames
+  const names = readdirSync(moduleDir);
+  for (const name of names) {
+    const pkgfile = path.join(moduleDir, name, 'package.json');
+    if (!existsSync(pkgfile)) {
+      continue;
+    }
+    const pkg = readJSONSync(pkgfile);
+    if (pkg.dependencies) {
+      for (const eggName of eggNames) {
+        if (pkg.dependencies[eggName]) {
+          return path.join(moduleDir, name);
+        }
+      }
+    }
+  }
+
+  // try to get egg
+  for (const eggName of eggNames) {
+    const pkgfile = path.join(moduleDir, eggName, 'package.json');
+    if (existsSync(pkgfile)) {
+      return path.join(moduleDir, eggName);
+    }
+  }
+
+  return '';
+}

package/src/framework.ts

@@ -0,0 +1,87 @@
+import path from 'node:path';
+import assert from 'node:assert';
+import { existsSync } from 'node:fs';
+import { readJSONSync } from './utils.js';
+
+const initCwd = process.cwd();
+
+interface Options {
+  baseDir: string;
+  framework?: string;
+}
+
+/**
+ * Find the framework directory, lookup order
+ * - specify framework path
+ * - get framework name from
+ * - use egg by default
+ * @param {Object} options - options
+ * @param  {String} options.baseDir - the current directory of application
+ * @param  {String} [options.framework] - the directory of framework
+ * @return {String} frameworkPath
+ */
+export function getFrameworkPath(options: Options): string {
+  const { framework, baseDir } = options;
+  const pkgPath = path.join(baseDir, 'package.json');
+  assert(existsSync(pkgPath), `${pkgPath} should exist`);
+  const moduleDir = path.join(baseDir, 'node_modules');
+
+  // 1. pass framework or customEgg
+  if (framework) {
+    // 1.1 framework is an absolute path
+    // framework: path.join(baseDir, 'node_modules/${frameworkName}')
+    if (path.isAbsolute(framework)) {
+      assert(existsSync(framework), `${framework} should exist`);
+      return framework;
+    }
+    // 1.2 framework is a npm package that required by application
+    // framework: 'frameworkName'
+    return assertAndReturn(framework, moduleDir);
+  }
+
+  const pkg = readJSONSync(pkgPath);
+  // 2. framework is not specified
+  // 2.1 use framework name from pkg.egg.framework
+  if (pkg.egg?.framework) {
+    return assertAndReturn(pkg.egg.framework, moduleDir);
+  }
+
+  // 2.2 use egg by default
+  return assertAndReturn('egg', moduleDir);
+}
+
+function assertAndReturn(frameworkName: string, moduleDir: string) {
+  const moduleDirs = new Set([
+    moduleDir,
+    // find framework from process.cwd, especially for test,
+    // the application is in test/fixtures/app,
+    // and framework is install in ${cwd}/node_modules
+    path.join(process.cwd(), 'node_modules'),
+    // prevent from mocking process.cwd
+    path.join(initCwd, 'node_modules'),
+  ]);
+  try {
+    // find framework from global, especially for monorepo
+    let globalModuleDir;
+    // if frameworkName is scoped package, like @ali/egg
+    if (frameworkName.startsWith('@') && frameworkName.includes('/')) {
+      globalModuleDir = path.join(
+        require.resolve(`${frameworkName}/package.json`),
+        '../../..',
+      );
+    } else {
+      globalModuleDir = path.join(
+        require.resolve(`${frameworkName}/package.json`),
+        '../..',
+      );
+    }
+    moduleDirs.add(globalModuleDir);
+  } catch (err) {
+    // ignore
+  }
+  for (const moduleDir of moduleDirs) {
+    const frameworkPath = path.join(moduleDir, frameworkName);
+    if (existsSync(frameworkPath)) return frameworkPath;
+  }
+  throw new Error(`${frameworkName} is not found in ${Array.from(moduleDirs)}`);
+}

package/src/import.ts

@@ -0,0 +1,82 @@
+import { debuglog } from 'node:util';
+import { createRequire } from 'node:module';
+import { pathToFileURL } from 'node:url';
+
+const debug = debuglog('@eggjs/utils:loader');
+
+let _customRequire: NodeRequire;
+
+export interface ImportResolveOptions {
+  paths?: string[];
+}
+
+export interface ImportModuleOptions extends ImportResolveOptions {
+  // only import export default object
+  importDefaultOnly?: boolean;
+}
+
+export function importResolve(filepath: string, options?: ImportResolveOptions) {
+  if (!_customRequire) {
+    if (typeof require !== 'undefined') {
+      _customRequire = require;
+    } else {
+      _customRequire = createRequire(process.cwd());
+    }
+  }
+  const moduleFilePath = _customRequire.resolve(filepath, options);
+  debug('[importResolve] %o, options: %o => %o', filepath, options, moduleFilePath);
+  return moduleFilePath;
+}
+
+export async function importModule(filepath: string, options?: ImportModuleOptions) {
+  const moduleFilePath = importResolve(filepath, options);
+  let obj: any;
+  if (typeof require === 'function') {
+    // commonjs
+    obj = require(moduleFilePath);
+    debug('[importModule] require %o => %o', filepath, obj);
+    if (obj?.__esModule === true && 'default' in obj) {
+      // 兼容 cjs 模拟 esm 的导出格式
+      // {
+      //   __esModule: true,
+      //   default: { fn: [Function: fn], foo: 'bar', one: 1 }
+      // }
+      obj = obj.default;
+    }
+  } else {
+    // esm
+    debug('[importModule] await import start: %o', filepath);
+    const fileUrl = pathToFileURL(moduleFilePath).toString();
+    obj = await import(fileUrl);
+    debug('[importModule] await import end: %o => %o', filepath, obj);
+    // {
+    //   default: { foo: 'bar', one: 1 },
+    //   foo: 'bar',
+    //   one: 1,
+    //   [Symbol(Symbol.toStringTag)]: 'Module'
+    // }
+    if (obj?.__esModule === true && obj?.default?.__esModule === true) {
+      // 兼容 cjs 模拟 esm 的导出格式
+      // {
+      //   __esModule: true,
+      //   default: {
+      //     __esModule: true,
+      //     default: {
+      //       fn: [Function: fn] { [length]: 0, [name]: 'fn' },
+      //       foo: 'bar',
+      //       one: 1
+      //     }
+      //   },
+      //   [Symbol(Symbol.toStringTag)]: 'Module'
+      // }
+      obj = obj.default;
+    }
+    if (options?.importDefaultOnly) {
+      if ('default' in obj) {
+        obj = obj.default;
+      }
+    }
+  }
+  debug('[importModule] return %o => %o', filepath, obj);
+  return obj;
+}

package/src/index.ts

@@ -0,0 +1,16 @@
+import { getFrameworkPath } from './framework.js';
+import { getPlugins, getConfig, getLoadUnits } from './plugin.js';
+import { getFrameworkOrEggPath } from './deprecated.js';
+
+// support import { getFrameworkPath } from '@eggjs/utils'
+export { getFrameworkPath } from './framework.js';
+export { getPlugins, getConfig, getLoadUnits } from './plugin.js';
+export { getFrameworkOrEggPath } from './deprecated.js';
+export * from './import.js';
+
+// support import utils from '@eggjs/utils'
+export default {
+  getFrameworkPath,
+  getPlugins, getConfig, getLoadUnits,
+  getFrameworkOrEggPath,
+};