@eggjs/utils 2.5.0 → 3.0.1

package/README.md

@@ -1,24 +1,23 @@
-egg-utils
----------------
+# @eggjs/utils
 
 [![NPM version][npm-image]][npm-url]
 [![CI](https://github.com/eggjs/egg-utils/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/egg-utils/actions/workflows/nodejs.yml)
 [![Test coverage][codecov-image]][codecov-url]
 [![npm download][download-image]][download-url]
 
-[npm-image]: https://img.shields.io/npm/v/egg-utils.svg?style=flat-square
-[npm-url]: https://npmjs.org/package/egg-utils
+[npm-image]: https://img.shields.io/npm/v/@eggjs/utils.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@eggjs/utils
 [codecov-image]: https://codecov.io/github/eggjs/egg-utils/coverage.svg?branch=master
 [codecov-url]: https://codecov.io/github/eggjs/egg-utils?branch=master
-[download-image]: https://img.shields.io/npm/dm/egg-utils.svg?style=flat-square
-[download-url]: https://npmjs.org/package/egg-utils
+[download-image]: https://img.shields.io/npm/dm/@eggjs/utils.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@eggjs/utils
 
 Utils for all egg projects.
 
 ## Installation
 
 ```bash
-$ npm i egg-utils
+npm i @eggjs/utils
 ```
 
 ## API
@@ -49,3 +48,15 @@ $ npm i egg-utils
 ## License
 
 [MIT](LICENSE)
+
+<!-- GITCONTRIBUTOR_START -->
+
+## Contributors
+
+|[<img src="https://avatars.githubusercontent.com/u/360661?v=4" width="100px;"/><br/><sub><b>popomore</b></sub>](https://github.com/popomore)<br/>|[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/><br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/32174276?v=4" width="100px;"/><br/><sub><b>semantic-release-bot</b></sub>](https://github.com/semantic-release-bot)<br/>|[<img src="https://avatars.githubusercontent.com/u/5345266?v=4" width="100px;"/><br/><sub><b>a526672351</b></sub>](https://github.com/a526672351)<br/>|[<img src="https://avatars.githubusercontent.com/u/2842176?v=4" width="100px;"/><br/><sub><b>XadillaX</b></sub>](https://github.com/XadillaX)<br/>|[<img src="https://avatars.githubusercontent.com/u/1974254?v=4" width="100px;"/><br/><sub><b>maqic</b></sub>](https://github.com/maqic)<br/>|
+| :---: | :---: | :---: | :---: | :---: | :---: |
+[<img src="https://avatars.githubusercontent.com/u/7284558?v=4" width="100px;"/><br/><sub><b>duncup</b></sub>](https://github.com/duncup)<br/>
+
+This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Mon May 29 2023 14:07:36 GMT+0800`.
+
+<!-- GITCONTRIBUTOR_END -->

package/lib/deprecated.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 declare function getFrameworkOrEggPath(cwd: string, eggNames?: string[]): string;

package/lib/deprecated.js

@@ -0,0 +1,59 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFrameworkOrEggPath = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const node_fs_1 = require("node:fs");
+const utils_1 = require("./utils");
+/**
+ * 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
+ */
+function getFrameworkOrEggPath(cwd, eggNames) {
+    eggNames = eggNames || ['egg'];
+    const moduleDir = node_path_1.default.join(cwd, 'node_modules');
+    if (!(0, node_fs_1.existsSync)(moduleDir)) {
+        return '';
+    }
+    // try to get framework
+    // 1. try to read egg.framework property on package.json
+    const pkgFile = node_path_1.default.join(cwd, 'package.json');
+    if ((0, node_fs_1.existsSync)(pkgFile)) {
+        const pkg = (0, utils_1.readJSONSync)(pkgFile);
+        if (pkg.egg && pkg.egg.framework) {
+            return node_path_1.default.join(moduleDir, pkg.egg.framework);
+        }
+    }
+    // 2. try the module dependencies includes eggNames
+    const names = (0, node_fs_1.readdirSync)(moduleDir);
+    for (const name of names) {
+        const pkgfile = node_path_1.default.join(moduleDir, name, 'package.json');
+        if (!(0, node_fs_1.existsSync)(pkgfile)) {
+            continue;
+        }
+        const pkg = (0, utils_1.readJSONSync)(pkgfile);
+        if (pkg.dependencies) {
+            for (const eggName of eggNames) {
+                if (pkg.dependencies[eggName]) {
+                    return node_path_1.default.join(moduleDir, name);
+                }
+            }
+        }
+    }
+    // try to get egg
+    for (const eggName of eggNames) {
+        const pkgfile = node_path_1.default.join(moduleDir, eggName, 'package.json');
+        if ((0, node_fs_1.existsSync)(pkgfile)) {
+            return node_path_1.default.join(moduleDir, eggName);
+        }
+    }
+    return '';
+}
+exports.getFrameworkOrEggPath = getFrameworkOrEggPath;

package/lib/framework.d.ts

@@ -0,0 +1,16 @@
+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 declare function getFrameworkPath(options: Options): string;
+export {};

package/lib/framework.js

@@ -1,14 +1,14 @@
-'use strict';
-
-const path = require('path');
-const assert = require('assert');
-const fs = require('fs');
-const utility = require('utility');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFrameworkPath = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const node_assert_1 = __importDefault(require("node:assert"));
+const node_fs_1 = require("node:fs");
+const utils_1 = require("./utils");
 const initCwd = process.cwd();
-
-module.exports = { getFrameworkPath };
-
 /**
  * Find the framework directory, lookup order
  * - specify framework path
@@ -19,56 +19,62 @@ module.exports = { getFrameworkPath };
  * @param  {String} [options.framework] - the directory of framework
  * @return {String} frameworkPath
  */
-function getFrameworkPath({ framework, baseDir }) {
-  const pkgPath = path.join(baseDir, 'package.json');
-  assert(fs.existsSync(pkgPath), `${pkgPath} should exist`);
-
-  const moduleDir = path.join(baseDir, 'node_modules');
-  const pkg = utility.readJSONSync(pkgPath);
-
-  // 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(fs.existsSync(framework), `${framework} should exist`);
-      return framework;
+function getFrameworkPath(options) {
+    const { framework, baseDir } = options;
+    const pkgPath = node_path_1.default.join(baseDir, 'package.json');
+    (0, node_assert_1.default)((0, node_fs_1.existsSync)(pkgPath), `${pkgPath} should exist`);
+    const moduleDir = node_path_1.default.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 (node_path_1.default.isAbsolute(framework)) {
+            (0, node_assert_1.default)((0, node_fs_1.existsSync)(framework), `${framework} should exist`);
+            return framework;
+        }
+        // 1.2 framework is a npm package that required by application
+        // framework: 'frameworkName'
+        return assertAndReturn(framework, moduleDir);
     }
-    // 1.2 framework is a npm package that required by application
-    // framework: 'frameworkName'
-    return assertAndReturn(framework, moduleDir);
-  }
-
-  // 2. framework is not specified
-  // 2.1 use framework name from pkg.egg.framework
-  if (pkg.egg && pkg.egg.framework) {
-    return assertAndReturn(pkg.egg.framework, moduleDir);
-  }
-
-  // 2.2 use egg by default
-  return assertAndReturn('egg', moduleDir);
+    const pkg = (0, utils_1.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);
 }
-
+exports.getFrameworkPath = getFrameworkPath;
 function assertAndReturn(frameworkName, moduleDir) {
-  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
-    const 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 (fs.existsSync(frameworkPath)) return frameworkPath;
-  }
-  throw new Error(`${frameworkName} is not found in ${Array.from(moduleDirs)}`);
+    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
+        node_path_1.default.join(process.cwd(), 'node_modules'),
+        // prevent from mocking process.cwd
+        node_path_1.default.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 = node_path_1.default.join(require.resolve(`${frameworkName}/package.json`), '../../..');
+        }
+        else {
+            globalModuleDir = node_path_1.default.join(require.resolve(`${frameworkName}/package.json`), '../..');
+        }
+        moduleDirs.add(globalModuleDir);
+    }
+    catch (err) {
+        // ignore
+    }
+    for (const moduleDir of moduleDirs) {
+        const frameworkPath = node_path_1.default.join(moduleDir, frameworkName);
+        if ((0, node_fs_1.existsSync)(frameworkPath))
+            return frameworkPath;
+    }
+    throw new Error(`${frameworkName} is not found in ${Array.from(moduleDirs)}`);
 }

package/lib/index.d.ts

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

package/lib/index.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFrameworkOrEggPath = exports.getLoadUnits = exports.getConfig = exports.getPlugins = exports.getFrameworkPath = void 0;
+const framework_1 = require("./framework");
+const plugin_1 = require("./plugin");
+const deprecated_1 = require("./deprecated");
+// support import { getFrameworkPath } from '@eggjs/utils'
+var framework_2 = require("./framework");
+Object.defineProperty(exports, "getFrameworkPath", { enumerable: true, get: function () { return framework_2.getFrameworkPath; } });
+var plugin_2 = require("./plugin");
+Object.defineProperty(exports, "getPlugins", { enumerable: true, get: function () { return plugin_2.getPlugins; } });
+Object.defineProperty(exports, "getConfig", { enumerable: true, get: function () { return plugin_2.getConfig; } });
+Object.defineProperty(exports, "getLoadUnits", { enumerable: true, get: function () { return plugin_2.getLoadUnits; } });
+var deprecated_2 = require("./deprecated");
+Object.defineProperty(exports, "getFrameworkOrEggPath", { enumerable: true, get: function () { return deprecated_2.getFrameworkOrEggPath; } });
+// support import utils from '@eggjs/utils'
+exports.default = {
+    getFrameworkPath: framework_1.getFrameworkPath,
+    getPlugins: plugin_1.getPlugins, getConfig: plugin_1.getConfig, getLoadUnits: plugin_1.getLoadUnits,
+    getFrameworkOrEggPath: deprecated_1.getFrameworkOrEggPath,
+};

package/lib/plugin.d.ts

@@ -0,0 +1,30 @@
+interface LoaderOptions {
+    framework: string;
+    baseDir: string;
+    env?: string;
+}
+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): 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): Unit[];
+export declare function getConfig(options: LoaderOptions): Record<string, any>;
+export {};

package/lib/plugin.js

@@ -1,69 +1,98 @@
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
-const assert = require('assert');
-const os = require('os');
-const mkdirp = require('mkdirp');
-
-const tmpDir = os.tmpdir();
-const logger = {
-  debug: noop,
-  info: noop,
-  warn: noop,
-  error: noop,
-};
-
-exports.getPlugins = opt => {
-  const loader = getLoader(opt);
-  loader.loadPlugin();
-  return loader.allPlugins;
+"use strict";
+/* eslint-disable @typescript-eslint/no-var-requires */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-
-exports.getLoadUnits = opt => {
-  const loader = getLoader(opt);
-  loader.loadPlugin();
-  return loader.getLoadUnits();
-};
-
-exports.getConfig = opt => {
-  const loader = getLoader(opt);
-  loader.loadPlugin();
-  loader.loadConfig();
-  return loader.config;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConfig = exports.getLoadUnits = exports.getPlugins = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const node_assert_1 = __importDefault(require("node:assert"));
+const node_os_1 = __importDefault(require("node:os"));
+const node_fs_1 = require("node:fs");
+const tmpDir = node_os_1.default.tmpdir();
+// eslint-disable-next-line @typescript-eslint/no-empty-function
+function noop() { }
+const logger = {
+    debug: noop,
+    info: noop,
+    warn: noop,
+    error: noop,
 };
-
-function getLoader({ framework, baseDir, env }) {
-  assert(framework, 'framework is required');
-  assert(fs.existsSync(framework), `${framework} should exist`);
-  if (!(baseDir && fs.existsSync(baseDir))) {
-    baseDir = path.join(tmpDir, String(Date.now()), 'tmpapp');
-    mkdirp.sync(baseDir);
-    fs.writeFileSync(path.join(baseDir, 'package.json'), JSON.stringify({ name: 'tmpapp' }));
-  }
-
-  const EggLoader = findEggCore({ baseDir, framework }).EggLoader;
-  const { Application } = require(framework);
-  if (env) process.env.EGG_SERVER_ENV = env;
-  return new EggLoader({
-    baseDir,
-    logger,
-    app: Object.create(Application.prototype),
-  });
+/**
+ * @see https://github.com/eggjs/egg-core/blob/2920f6eade07959d25f5c4f96b154d3fbae877db/lib/loader/mixin/plugin.js#L203
+ */
+function getPlugins(options) {
+    const loader = getLoader(options);
+    loader.loadPlugin();
+    return loader.allPlugins;
+}
+exports.getPlugins = getPlugins;
+/**
+ * @see https://github.com/eggjs/egg-core/blob/2920f6eade07959d25f5c4f96b154d3fbae877db/lib/loader/egg_loader.js#L348
+ */
+function getLoadUnits(options) {
+    const loader = getLoader(options);
+    loader.loadPlugin();
+    return loader.getLoadUnits();
+}
+exports.getLoadUnits = getLoadUnits;
+function getConfig(options) {
+    const loader = getLoader(options);
+    loader.loadPlugin();
+    loader.loadConfig();
+    return loader.config;
+}
+exports.getConfig = getConfig;
+function getLoader(options) {
+    let { framework, baseDir, env } = options;
+    (0, node_assert_1.default)(framework, 'framework is required');
+    (0, node_assert_1.default)((0, node_fs_1.existsSync)(framework), `${framework} should exist`);
+    if (!(baseDir && (0, node_fs_1.existsSync)(baseDir))) {
+        baseDir = node_path_1.default.join(tmpDir, String(Date.now()), 'tmpapp');
+        (0, node_fs_1.mkdirSync)(baseDir, { recursive: true });
+        (0, node_fs_1.writeFileSync)(node_path_1.default.join(baseDir, 'package.json'), JSON.stringify({ name: 'tmpapp' }));
+    }
+    const EggLoader = findEggCore({ baseDir, framework });
+    const { Application } = require(framework);
+    if (env)
+        process.env.EGG_SERVER_ENV = env;
+    return new EggLoader({
+        baseDir,
+        logger,
+        app: Object.create(Application.prototype),
+    });
 }
-
 function findEggCore({ baseDir, framework }) {
-  try {
+    const baseDirRealpath = (0, node_fs_1.realpathSync)(baseDir);
+    const frameworkRealpath = (0, node_fs_1.realpathSync)(framework);
+    // custom framework => egg => egg/lib/loader/index.js
+    try {
+        return require(require.resolve('egg/lib/loader', {
+            paths: [frameworkRealpath, baseDirRealpath],
+        })).EggLoader;
+    }
+    catch {
+        // ignore
+    }
     const name = 'egg-core';
-    return require(name);
-  } catch (_) {
-    let eggCorePath = path.join(baseDir, 'node_modules/egg-core');
-    if (!fs.existsSync(eggCorePath)) {
-      eggCorePath = path.join(framework, 'node_modules/egg-core');
+    // egg => egg-core
+    try {
+        return require(require.resolve(name, {
+            paths: [frameworkRealpath, baseDirRealpath],
+        })).EggLoader;
+    }
+    catch {
+        // ignore
+    }
+    try {
+        return require(name).EggLoader;
+    }
+    catch {
+        let eggCorePath = node_path_1.default.join(baseDir, `node_modules/${name}`);
+        if (!(0, node_fs_1.existsSync)(eggCorePath)) {
+            eggCorePath = node_path_1.default.join(framework, `node_modules/${name}`);
+        }
+        (0, node_assert_1.default)((0, node_fs_1.existsSync)(eggCorePath), `Can't find ${name} from ${baseDir} and ${framework}`);
+        return require(eggCorePath).EggLoader;
     }
-    assert(fs.existsSync(eggCorePath), `Can't find egg-core from ${baseDir} and ${framework}`);
-    return require(eggCorePath);
-  }
 }
-
-function noop() {}

package/lib/utils.d.ts

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

package/lib/utils.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readJSONSync = void 0;
+const node_fs_1 = require("node:fs");
+function readJSONSync(file) {
+    if (!(0, node_fs_1.existsSync)(file)) {
+        throw new Error(`${file} is not found`);
+    }
+    return JSON.parse((0, node_fs_1.readFileSync)(file, 'utf-8'));
+}
+exports.readJSONSync = readJSONSync;

package/package.json

@@ -1,17 +1,22 @@
 {
   "name": "@eggjs/utils",
-  "version": "2.5.0",
+  "version": "3.0.1",
   "description": "Utils for all egg projects",
-  "main": "index.js",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "files": [
-    "index.js",
     "lib"
   ],
   "scripts": {
     "lint": "eslint .",
-    "test": "npm run lint && egg-bin test",
-    "cov": "egg-bin cov",
-    "ci": "npm run lint && npm run cov"
+    "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"
   },
   "keywords": [
     "egg",
@@ -23,24 +28,24 @@
     "url": "https://github.com/eggjs/egg-utils.git"
   },
   "license": "MIT",
-  "dependencies": {
-    "mkdirp": "^0.5.1",
-    "utility": "^1.15.0"
-  },
+  "dependencies": {},
   "devDependencies": {
-    "coffee": "^5.1.0",
-    "cpy": "^7.0.1",
-    "egg-bin": "^4.9.0",
-    "eslint": "^5.9.0",
-    "eslint-config-egg": "^7.1.0",
-    "mm": "^2.4.1",
-    "mz-modules": "^2.1.0",
-    "npm": "^6.4.1",
-    "npminstall": "^3.15.0",
-    "runscript": "^1.3.0"
+    "@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"
   },
   "engine": {
-    "node": ">=6.0.0"
+    "node": ">=16.13.0"
   },
   "publishConfig": {
     "access": "public"

package/index.js

@@ -1,67 +0,0 @@
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
-const utility = require('utility');
-
-[
-  require('./lib/framework'),
-  require('./lib/plugin'),
-  { getFrameworkOrEggPath },
-]
-  .forEach(obj => Object.assign(exports, obj));
-
-/**
- * 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
- */
-function getFrameworkOrEggPath(cwd, eggNames) {
-  eggNames = eggNames || [ 'egg' ];
-  const moduleDir = path.join(cwd, 'node_modules');
-  if (!fs.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 (fs.existsSync(pkgFile)) {
-    const pkg = utility.readJSONSync(pkgFile);
-    if (pkg.egg && pkg.egg.framework) {
-      return path.join(moduleDir, pkg.egg.framework);
-    }
-  }
-
-  // 2. try the module dependencies includes eggNames
-  const names = fs.readdirSync(moduleDir);
-  for (const name of names) {
-    const pkgfile = path.join(moduleDir, name, 'package.json');
-    if (!fs.existsSync(pkgfile)) {
-      continue;
-    }
-    const pkg = utility.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 (fs.existsSync(pkgfile)) {
-      return path.join(moduleDir, eggName);
-    }
-  }
-
-  return '';
-}