@eggjs/utils 2.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-present Alibaba Group Holding Limited and other contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,51 @@
+egg-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
+[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
+
+Utils for all egg projects.
+
+## Installation
+
+```bash
+$ npm i egg-utils
+```
+
+## API
+
+### `getPlugins(options)`
+
+- {String} baseDir - the current directory of application
+- {String} framework - the directory of framework
+- {String} env - egg environment
+
+### `getLoadUnits(options)`
+
+- {String} baseDir - the current directory of application
+- {String} framework - the directory of framework
+- {String} env - egg environment
+
+### `getConfig(options)`
+
+- {String} baseDir - the current directory of application
+- {String} framework - the directory of framework
+- {String} env - egg environment
+
+### `getFrameworkPath(options)`
+
+- {String} baseDir - the current directory of application
+- {String} framework - the directory of framework
+
+## License
+
+[MIT](LICENSE)

package/index.js

@@ -0,0 +1,67 @@
+'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 '';
+}

package/lib/framework.js

@@ -0,0 +1,74 @@
+'use strict';
+
+const path = require('path');
+const assert = require('assert');
+const fs = require('fs');
+const utility = require('utility');
+
+const initCwd = process.cwd();
+
+module.exports = { getFrameworkPath };
+
+/**
+ * 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
+ */
+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;
+    }
+    // 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);
+}
+
+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)}`);
+}

package/lib/plugin.js

@@ -0,0 +1,69 @@
+'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;
+};
+
+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;
+};
+
+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),
+  });
+}
+
+function findEggCore({ baseDir, framework }) {
+  try {
+    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');
+    }
+    assert(fs.existsSync(eggCorePath), `Can't find egg-core from ${baseDir} and ${framework}`);
+    return require(eggCorePath);
+  }
+}
+
+function noop() {}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@eggjs/utils",
+  "version": "2.5.0",
+  "description": "Utils for all egg projects",
+  "main": "index.js",
+  "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"
+  },
+  "keywords": [
+    "egg",
+    "utils"
+  ],
+  "author": "fengmk2 <fengmk2@gmail.com> (https://github.com/fengmk2)",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/eggjs/egg-utils.git"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "mkdirp": "^0.5.1",
+    "utility": "^1.15.0"
+  },
+  "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"
+  },
+  "engine": {
+    "node": ">=6.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}