@eggjs/utils 4.1.6 → 4.2.0

package/README.md

@@ -4,6 +4,8 @@
 [![CI](https://github.com/eggjs/utils/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/utils/actions/workflows/nodejs.yml)
 [![Test coverage][codecov-image]][codecov-url]
 [![npm download][download-image]][download-url]
+[![Node.js Version](https://img.shields.io/node/v/@eggjs/utils.svg?style=flat)](https://nodejs.org/en/download/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
 
 [npm-image]: https://img.shields.io/npm/v/@eggjs/utils.svg?style=flat-square
 [npm-url]: https://npmjs.org/package/@eggjs/utils

package/dist/commonjs/index.d.ts

@@ -13,3 +13,13 @@ declare const _default: {
     getFrameworkOrEggPath: typeof getFrameworkOrEggPath;
 };
 export default _default;
+export declare enum EggType {
+    framework = "framework",
+    plugin = "plugin",
+    application = "application",
+    unknown = "unknown"
+}
+/**
+ * Detect the type of egg project
+ */
+export declare function detectType(baseDir: string): Promise<EggType>;

package/dist/commonjs/index.js

@@ -13,8 +13,14 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFrameworkOrEggPath = exports.getLoadUnits = exports.getConfig = exports.getPlugins = exports.getFrameworkPath = void 0;
+exports.EggType = exports.getFrameworkOrEggPath = exports.getLoadUnits = exports.getConfig = exports.getPlugins = exports.getFrameworkPath = void 0;
+exports.detectType = detectType;
+const node_path_1 = __importDefault(require("node:path"));
+const promises_1 = __importDefault(require("node:fs/promises"));
 const framework_js_1 = require("./framework.js");
 const plugin_js_1 = require("./plugin.js");
 const deprecated_js_1 = require("./deprecated.js");
@@ -34,4 +40,37 @@ exports.default = {
     getPlugins: plugin_js_1.getPlugins, getConfig: plugin_js_1.getConfig, getLoadUnits: plugin_js_1.getLoadUnits,
     getFrameworkOrEggPath: deprecated_js_1.getFrameworkOrEggPath,
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSxpREFBa0Q7QUFDbEQsMkNBQWtFO0FBQ2xFLG1EQUF3RDtBQUV4RCwwREFBMEQ7QUFDMUQsK0NBQWtEO0FBQXpDLGdIQUFBLGdCQUFnQixPQUFBO0FBQ3pCLHlDQUFrRTtBQUF6RCx1R0FBQSxVQUFVLE9BQUE7QUFBRSxzR0FBQSxTQUFTLE9BQUE7QUFBRSx5R0FBQSxZQUFZLE9BQUE7QUFDNUMsaURBQXdEO0FBQS9DLHNIQUFBLHFCQUFxQixPQUFBO0FBQzlCLDhDQUE0QjtBQUU1QiwyQ0FBMkM7QUFDM0Msa0JBQWU7SUFDYixnQkFBZ0IsRUFBaEIsK0JBQWdCO0lBQ2hCLFVBQVUsRUFBVixzQkFBVSxFQUFFLFNBQVMsRUFBVCxxQkFBUyxFQUFFLFlBQVksRUFBWix3QkFBWTtJQUNuQyxxQkFBcUIsRUFBckIscUNBQXFCO0NBQ3RCLENBQUMifQ==
+var EggType;
+(function (EggType) {
+    EggType["framework"] = "framework";
+    EggType["plugin"] = "plugin";
+    EggType["application"] = "application";
+    EggType["unknown"] = "unknown";
+})(EggType || (exports.EggType = EggType = {}));
+/**
+ * Detect the type of egg project
+ */
+async function detectType(baseDir) {
+    const pkgFile = node_path_1.default.join(baseDir, 'package.json');
+    let pkg;
+    try {
+        await promises_1.default.access(pkgFile);
+    }
+    catch {
+        return EggType.unknown;
+    }
+    try {
+        pkg = JSON.parse(await promises_1.default.readFile(pkgFile, 'utf-8'));
+    }
+    catch {
+        return EggType.unknown;
+    }
+    if (pkg.egg?.framework) {
+        return EggType.framework;
+    }
+    if (pkg.eggPlugin?.name) {
+        return EggType.plugin;
+    }
+    return EggType.application;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUE2QkEsZ0NBMkJDO0FBeERELDBEQUE2QjtBQUM3QixnRUFBa0M7QUFDbEMsaURBQWtEO0FBQ2xELDJDQUFrRTtBQUNsRSxtREFBd0Q7QUFFeEQsMERBQTBEO0FBQzFELCtDQUFrRDtBQUF6QyxnSEFBQSxnQkFBZ0IsT0FBQTtBQUN6Qix5Q0FBa0U7QUFBekQsdUdBQUEsVUFBVSxPQUFBO0FBQUUsc0dBQUEsU0FBUyxPQUFBO0FBQUUseUdBQUEsWUFBWSxPQUFBO0FBQzVDLGlEQUF3RDtBQUEvQyxzSEFBQSxxQkFBcUIsT0FBQTtBQUM5Qiw4Q0FBNEI7QUFFNUIsMkNBQTJDO0FBQzNDLGtCQUFlO0lBQ2IsZ0JBQWdCLEVBQWhCLCtCQUFnQjtJQUNoQixVQUFVLEVBQVYsc0JBQVUsRUFBRSxTQUFTLEVBQVQscUJBQVMsRUFBRSxZQUFZLEVBQVosd0JBQVk7SUFDbkMscUJBQXFCLEVBQXJCLHFDQUFxQjtDQUN0QixDQUFDO0FBRUYsSUFBWSxPQUtYO0FBTEQsV0FBWSxPQUFPO0lBQ2pCLGtDQUF1QixDQUFBO0lBQ3ZCLDRCQUFpQixDQUFBO0lBQ2pCLHNDQUEyQixDQUFBO0lBQzNCLDhCQUFtQixDQUFBO0FBQ3JCLENBQUMsRUFMVyxPQUFPLHVCQUFQLE9BQU8sUUFLbEI7QUFFRDs7R0FFRztBQUNJLEtBQUssVUFBVSxVQUFVLENBQUMsT0FBZTtJQUM5QyxNQUFNLE9BQU8sR0FBRyxtQkFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsY0FBYyxDQUFDLENBQUM7SUFDbkQsSUFBSSxHQU9ILENBQUM7SUFDRixJQUFJLENBQUM7UUFDSCxNQUFNLGtCQUFFLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQzNCLENBQUM7SUFBQyxNQUFNLENBQUM7UUFDUCxPQUFPLE9BQU8sQ0FBQyxPQUFPLENBQUM7SUFDekIsQ0FBQztJQUNELElBQUksQ0FBQztRQUNILEdBQUcsR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sa0JBQUUsQ0FBQyxRQUFRLENBQUMsT0FBTyxFQUFFLE9BQU8sQ0FBQyxDQUFDLENBQUM7SUFDeEQsQ0FBQztJQUFDLE1BQU0sQ0FBQztRQUNQLE9BQU8sT0FBTyxDQUFDLE9BQU8sQ0FBQztJQUN6QixDQUFDO0lBQ0QsSUFBSSxHQUFHLENBQUMsR0FBRyxFQUFFLFNBQVMsRUFBRSxDQUFDO1FBQ3ZCLE9BQU8sT0FBTyxDQUFDLFNBQVMsQ0FBQztJQUMzQixDQUFDO0lBQ0QsSUFBSSxHQUFHLENBQUMsU0FBUyxFQUFFLElBQUksRUFBRSxDQUFDO1FBQ3hCLE9BQU8sT0FBTyxDQUFDLE1BQU0sQ0FBQztJQUN4QixDQUFDO0lBQ0QsT0FBTyxPQUFPLENBQUMsV0FBVyxDQUFDO0FBQzdCLENBQUMifQ==

package/dist/esm/index.d.ts

@@ -13,3 +13,13 @@ declare const _default: {
     getFrameworkOrEggPath: typeof getFrameworkOrEggPath;
 };
 export default _default;
+export declare enum EggType {
+    framework = "framework",
+    plugin = "plugin",
+    application = "application",
+    unknown = "unknown"
+}
+/**
+ * Detect the type of egg project
+ */
+export declare function detectType(baseDir: string): Promise<EggType>;

package/dist/esm/index.js

@@ -1,3 +1,5 @@
+import path from 'node:path';
+import fs from 'node:fs/promises';
 import { getFrameworkPath } from './framework.js';
 import { getPlugins, getConfig, getLoadUnits } from './plugin.js';
 import { getFrameworkOrEggPath } from './deprecated.js';
@@ -12,4 +14,37 @@ export default {
     getPlugins, getConfig, getLoadUnits,
     getFrameworkOrEggPath,
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLGdCQUFnQixFQUFFLE1BQU0sZ0JBQWdCLENBQUM7QUFDbEQsT0FBTyxFQUFFLFVBQVUsRUFBRSxTQUFTLEVBQUUsWUFBWSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBQ2xFLE9BQU8sRUFBRSxxQkFBcUIsRUFBRSxNQUFNLGlCQUFpQixDQUFDO0FBRXhELDBEQUEwRDtBQUMxRCxPQUFPLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxnQkFBZ0IsQ0FBQztBQUNsRCxPQUFPLEVBQUUsVUFBVSxFQUFFLFNBQVMsRUFBRSxZQUFZLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFDbEUsT0FBTyxFQUFFLHFCQUFxQixFQUFFLE1BQU0saUJBQWlCLENBQUM7QUFDeEQsY0FBYyxhQUFhLENBQUM7QUFFNUIsMkNBQTJDO0FBQzNDLGVBQWU7SUFDYixnQkFBZ0I7SUFDaEIsVUFBVSxFQUFFLFNBQVMsRUFBRSxZQUFZO0lBQ25DLHFCQUFxQjtDQUN0QixDQUFDIn0=
+export var EggType;
+(function (EggType) {
+    EggType["framework"] = "framework";
+    EggType["plugin"] = "plugin";
+    EggType["application"] = "application";
+    EggType["unknown"] = "unknown";
+})(EggType || (EggType = {}));
+/**
+ * Detect the type of egg project
+ */
+export async function detectType(baseDir) {
+    const pkgFile = path.join(baseDir, 'package.json');
+    let pkg;
+    try {
+        await fs.access(pkgFile);
+    }
+    catch {
+        return EggType.unknown;
+    }
+    try {
+        pkg = JSON.parse(await fs.readFile(pkgFile, 'utf-8'));
+    }
+    catch {
+        return EggType.unknown;
+    }
+    if (pkg.egg?.framework) {
+        return EggType.framework;
+    }
+    if (pkg.eggPlugin?.name) {
+        return EggType.plugin;
+    }
+    return EggType.application;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxJQUFJLE1BQU0sV0FBVyxDQUFDO0FBQzdCLE9BQU8sRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBQ2xDLE9BQU8sRUFBRSxnQkFBZ0IsRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBQ2xELE9BQU8sRUFBRSxVQUFVLEVBQUUsU0FBUyxFQUFFLFlBQVksRUFBRSxNQUFNLGFBQWEsQ0FBQztBQUNsRSxPQUFPLEVBQUUscUJBQXFCLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQztBQUV4RCwwREFBMEQ7QUFDMUQsT0FBTyxFQUFFLGdCQUFnQixFQUFFLE1BQU0sZ0JBQWdCLENBQUM7QUFDbEQsT0FBTyxFQUFFLFVBQVUsRUFBRSxTQUFTLEVBQUUsWUFBWSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBQ2xFLE9BQU8sRUFBRSxxQkFBcUIsRUFBRSxNQUFNLGlCQUFpQixDQUFDO0FBQ3hELGNBQWMsYUFBYSxDQUFDO0FBRTVCLDJDQUEyQztBQUMzQyxlQUFlO0lBQ2IsZ0JBQWdCO0lBQ2hCLFVBQVUsRUFBRSxTQUFTLEVBQUUsWUFBWTtJQUNuQyxxQkFBcUI7Q0FDdEIsQ0FBQztBQUVGLE1BQU0sQ0FBTixJQUFZLE9BS1g7QUFMRCxXQUFZLE9BQU87SUFDakIsa0NBQXVCLENBQUE7SUFDdkIsNEJBQWlCLENBQUE7SUFDakIsc0NBQTJCLENBQUE7SUFDM0IsOEJBQW1CLENBQUE7QUFDckIsQ0FBQyxFQUxXLE9BQU8sS0FBUCxPQUFPLFFBS2xCO0FBRUQ7O0dBRUc7QUFDSCxNQUFNLENBQUMsS0FBSyxVQUFVLFVBQVUsQ0FBQyxPQUFlO0lBQzlDLE1BQU0sT0FBTyxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxFQUFFLGNBQWMsQ0FBQyxDQUFDO0lBQ25ELElBQUksR0FPSCxDQUFDO0lBQ0YsSUFBSSxDQUFDO1FBQ0gsTUFBTSxFQUFFLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQzNCLENBQUM7SUFBQyxNQUFNLENBQUM7UUFDUCxPQUFPLE9BQU8sQ0FBQyxPQUFPLENBQUM7SUFDekIsQ0FBQztJQUNELElBQUksQ0FBQztRQUNILEdBQUcsR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sRUFBRSxDQUFDLFFBQVEsQ0FBQyxPQUFPLEVBQUUsT0FBTyxDQUFDLENBQUMsQ0FBQztJQUN4RCxDQUFDO0lBQUMsTUFBTSxDQUFDO1FBQ1AsT0FBTyxPQUFPLENBQUMsT0FBTyxDQUFDO0lBQ3pCLENBQUM7SUFDRCxJQUFJLEdBQUcsQ0FBQyxHQUFHLEVBQUUsU0FBUyxFQUFFLENBQUM7UUFDdkIsT0FBTyxPQUFPLENBQUMsU0FBUyxDQUFDO0lBQzNCLENBQUM7SUFDRCxJQUFJLEdBQUcsQ0FBQyxTQUFTLEVBQUUsSUFBSSxFQUFFLENBQUM7UUFDeEIsT0FBTyxPQUFPLENBQUMsTUFBTSxDQUFDO0lBQ3hCLENBQUM7SUFDRCxPQUFPLE9BQU8sQ0FBQyxXQUFXLENBQUM7QUFDN0IsQ0FBQyJ9

package/dist/package.json

@@ -1,4 +1,4 @@
 {
   "name": "@eggjs/utils",
-  "version": "4.1.6"
+  "version": "4.2.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eggjs/utils",
-  "version": "4.1.6",
+  "version": "4.2.0",
   "engine": {
     "node": ">=18.19.0"
   },
@@ -12,9 +12,11 @@
     "lint": "eslint src test --ext ts",
     "pretest": "npm run clean && npm run lint -- --fix && npm run prepublishOnly",
     "test": "npm run test-local",
+    "posttest": "npm run clean",
     "test-local": "egg-bin test",
     "preci": "npm run clean && npm run lint && npm run prepublishOnly",
     "ci": "egg-bin cov",
+    "postci": "npm run clean",
     "clean": "rimraf dist",
     "prepublishOnly": "tshy && tshy-after && attw --pack"
   },

package/src/index.ts

@@ -1,3 +1,5 @@
+import path from 'node:path';
+import fs from 'node:fs/promises';
 import { getFrameworkPath } from './framework.js';
 import { getPlugins, getConfig, getLoadUnits } from './plugin.js';
 import { getFrameworkOrEggPath } from './deprecated.js';
@@ -14,3 +16,42 @@ export default {
   getPlugins, getConfig, getLoadUnits,
   getFrameworkOrEggPath,
 };
+
+export enum EggType {
+  framework = 'framework',
+  plugin = 'plugin',
+  application = 'application',
+  unknown = 'unknown',
+}
+
+/**
+ * Detect the type of egg project
+ */
+export async function detectType(baseDir: string): Promise<EggType> {
+  const pkgFile = path.join(baseDir, 'package.json');
+  let pkg: {
+    egg?: {
+      framework?: boolean;
+    };
+    eggPlugin?: {
+      name: string;
+    };
+  };
+  try {
+    await fs.access(pkgFile);
+  } catch {
+    return EggType.unknown;
+  }
+  try {
+    pkg = JSON.parse(await fs.readFile(pkgFile, 'utf-8'));
+  } catch {
+    return EggType.unknown;
+  }
+  if (pkg.egg?.framework) {
+    return EggType.framework;
+  }
+  if (pkg.eggPlugin?.name) {
+    return EggType.plugin;
+  }
+  return EggType.application;
+}