@eggjs/bin 7.3.1 → 7.4.0-beta.10

package/dist/commands/test.js

@@ -0,0 +1,168 @@
+import { BaseCommand } from "../baseCommand.js";
+import { debuglog } from "node:util";
+import path from "node:path";
+import os from "node:os";
+import fs from "node:fs/promises";
+import { Args, Flags } from "@oclif/core";
+import globby from "globby";
+import { EggType, detectType, importResolve } from "@eggjs/utils";
+import { getChangedFilesForRoots } from "jest-changed-files";
+import ciParallelVars from "ci-parallel-vars";
+
+//#region src/commands/test.ts
+const debug = debuglog("egg-bin/commands/test");
+var Test = class extends BaseCommand {
+	static args = { file: Args.string({ description: "file(s) to test" }) };
+	static description = "Run the test";
+	static examples = [
+		"<%= config.bin %> <%= command.id %>",
+		"<%= config.bin %> <%= command.id %> test/index.test.ts",
+		"<%= config.bin %> <%= command.id %> test/index.test.ts,test/user.test.ts,...",
+		"<%= config.bin %> <%= command.id %> --json",
+		"<%= config.bin %> <%= command.id %> --log-level debug"
+	];
+	static flags = {
+		bail: Flags.boolean({
+			description: "bbort (\"bail\") after first test failure",
+			default: false,
+			char: "b"
+		}),
+		timeout: Flags.integer({
+			char: "t",
+			description: "set test-case timeout in milliseconds",
+			default: parseInt(process.env.TEST_TIMEOUT ?? "60000")
+		}),
+		"no-timeout": Flags.boolean({ description: "disable timeout" }),
+		grep: Flags.string({
+			char: "g",
+			description: "only run tests matching <pattern>"
+		}),
+		changed: Flags.boolean({
+			description: "only test with changed files and match test/**/*.test.(js|ts)",
+			char: "c"
+		}),
+		mochawesome: Flags.boolean({
+			description: "[default: true] enable mochawesome reporter",
+			default: true,
+			allowNo: true
+		}),
+		parallel: Flags.boolean({
+			description: "mocha parallel mode",
+			default: false,
+			char: "p"
+		}),
+		jobs: Flags.integer({
+			char: "t",
+			description: "number of jobs to run in parallel",
+			default: os.cpus().length - 1
+		}),
+		"auto-agent": Flags.boolean({
+			description: "[default: true] auto bootstrap agent in mocha master process",
+			default: true,
+			allowNo: true
+		})
+	};
+	async run() {
+		const { flags } = this;
+		try {
+			await fs.access(flags.base);
+		} catch (err) {
+			console.error("baseDir: %o not exists", flags.base);
+			throw err;
+		}
+		const mochaFile = process.env.MOCHA_FILE || importResolve("mocha/bin/_mocha");
+		if (flags.parallel) {
+			this.env.ENABLE_MOCHA_PARALLEL = "true";
+			if (flags["auto-agent"]) this.env.AUTO_AGENT = "true";
+		}
+		this.env.NODE_ENV = "test";
+		if (flags["no-timeout"]) flags.timeout = 0;
+		debug("run test: %s %o flags: %o", mochaFile, this.args, flags);
+		const mochaArgs = await this.formatMochaArgs();
+		if (!mochaArgs) return;
+		await this.runMocha(mochaFile, mochaArgs);
+	}
+	async runMocha(mochaFile, mochaArgs) {
+		await this.forkNode(mochaFile, mochaArgs, { execArgv: [...process.execArgv, "--unhandled-rejections=strict"] });
+	}
+	async formatMochaArgs() {
+		const { args, flags } = this;
+		const requires = await this.formatRequires();
+		const eggType = await detectType(flags.base);
+		debug("eggType: %s", eggType);
+		if (eggType === EggType.application) try {
+			const eggMockRegister = importResolve("@eggjs/mock/register", { paths: [flags.base] });
+			requires.push(eggMockRegister);
+			debug("auto register @eggjs/mock/register: %o", eggMockRegister);
+		} catch (err) {
+			debug("auto register @eggjs/mock fail, can not require @eggjs/mock on %o, error: %s", flags.base, err.message);
+		}
+		let reporter = this.env.TEST_REPORTER;
+		let reporterOptions = "";
+		if (!reporter && flags.mochawesome) {
+			reporter = importResolve("mochawesome-with-mocha", { paths: [flags.base] });
+			reporterOptions = "reportDir=node_modules/.mochawesome-reports";
+			if (flags.parallel) requires.push(path.join(reporter, "../register.js"));
+		}
+		const ext = flags.typescript ? "ts" : "js";
+		let pattern = args.file ? args.file.split(",") : [];
+		if (flags.changed) {
+			pattern = await this.getChangedTestFiles(flags.base, ext);
+			if (!pattern.length) {
+				console.log("No changed test files");
+				return;
+			}
+			debug("changed files: %o", pattern);
+		}
+		if (!pattern.length && process.env.TESTS) pattern = process.env.TESTS.split(",");
+		if (!pattern.length) pattern = [`test/**/*.test.${ext}`];
+		pattern = pattern.concat(["!test/fixtures", "!test/node_modules"]);
+		let files = globby.sync(pattern, { cwd: flags.base });
+		files.sort();
+		if (files.length === 0) {
+			console.log("No test files found with pattern %o", pattern);
+			return;
+		}
+		if (ciParallelVars) {
+			const { index: currentIndex, total: totalRuns } = ciParallelVars;
+			const fileCount = files.length;
+			const each = Math.floor(fileCount / totalRuns);
+			const remainder = fileCount % totalRuns;
+			const offset = Math.min(currentIndex, remainder) + currentIndex * each;
+			const currentFileCount = each + (currentIndex < remainder ? 1 : 0);
+			files = files.slice(offset, offset + currentFileCount);
+			console.log("# Split test files in parallel CI jobs: %d/%d, files: %d/%d", currentIndex + 1, totalRuns, files.length, fileCount);
+		}
+		const setupFile = path.join(flags.base, `test/.setup.${ext}`);
+		try {
+			await fs.access(setupFile);
+			files.unshift(setupFile);
+		} catch {}
+		const grep = flags.grep ? flags.grep.split(",") : [];
+		return [
+			"--exit",
+			flags.bail ? "--bail" : "",
+			grep.map((pattern$1) => `--grep='${pattern$1}'`).join(" "),
+			flags.timeout ? `--timeout=${flags.timeout}` : "--no-timeout",
+			flags.parallel ? "--parallel" : "",
+			flags.parallel && flags.jobs ? `--jobs=${flags.jobs}` : "",
+			reporter ? `--reporter=${reporter}` : "",
+			reporterOptions ? `--reporter-options=${reporterOptions}` : "",
+			...requires.map((r) => `--require=${r}`),
+			...files,
+			flags["dry-run"] ? "--dry-run" : ""
+		].filter((a) => a.trim());
+	}
+	async getChangedTestFiles(dir, ext) {
+		const changedFiles = (await getChangedFilesForRoots([path.join(dir, "test")], {})).changedFiles;
+		const files = [];
+		for (let cf of changedFiles) if (cf.endsWith(`.test.${ext}`)) {
+			if (process.platform === "win32") cf = cf.replace(/\\/g, "/");
+			files.push(cf);
+		}
+		return files;
+	}
+};
+
+//#endregion
+export { Test as default };

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import { PackageEgg } from "./types.js";
+import { BaseCommand, ForkError, ForkNodeOptions } from "./baseCommand.js";
+import { Test } from "./commands/test.js";
+import { Cov } from "./commands/cov.js";
+import { Dev } from "./commands/dev.js";
+export * from "@oclif/core";
+export { BaseCommand, Cov, Dev, ForkError, ForkNodeOptions, PackageEgg, Test };

package/dist/index.js

@@ -0,0 +1,8 @@
+import { BaseCommand, ForkError } from "./baseCommand.js";
+import Test from "./commands/test.js";
+import Cov from "./commands/cov.js";
+import Dev from "./commands/dev.js";
+
+export * from "@oclif/core"
+
+export { BaseCommand, Cov, Dev, ForkError, Test };

package/dist/scripts/postinstall.mjs

@@ -1,11 +1,12 @@
 import { debuglog } from 'node:util';
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
+
 import { runScript } from 'runscript';
 import { readJSON, exists } from 'utility';
 import { importResolve } from '@eggjs/utils';
 
-const debug = debuglog('@eggjs/bin/scripts/postinstall');
+const debug = debuglog('egg-bin/scripts/postinstall');
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -13,9 +14,11 @@ const rootDir = path.dirname(__dirname);
 
 async function main() {
   // node postintall.js </path/to/egg-ts-helper/dist/bin> <framework-package-name>
-  const etsBinFile = process.argv[2] || importResolve('egg-ts-helper/dist/bin.js', {
-    paths: [ rootDir ],
-  });
+  const etsBinFile =
+    process.argv[2] ||
+    importResolve('egg-ts-helper/dist/bin.js', {
+      paths: [rootDir],
+    });
   const frameworkPackageName = process.argv[3] || 'egg';
 
   // try to use INIT_CWD env https://docs.npmjs.com/cli/v9/commands/npm-run-script
@@ -52,9 +55,9 @@ async function main() {
       // https://github.com/eggjs/egg-ts-helper/pull/104
       process.env.ETS_SCRIPT_FRAMEWORK = frameworkPackageName;
       console.log('[@eggjs/bin/postinstall] run %s on %s', etsBinFile, npmRunRoot);
-      runScript(`node "${etsBinFile}"`);
+      await runScript(`node "${etsBinFile}"`);
     }
   }
 }
 
-main();
+void main();

package/dist/scripts/start-cluster.cjs

@@ -1,8 +1,9 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 const { debuglog } = require('node:util');
+
 const { importModule } = require('@eggjs/utils');
 
-const debug = debuglog('@eggjs/bin/scripts/start-cluster');
+const debug = debuglog('egg-bin/scripts/start-cluster');
 
 async function main() {
   debug('argv: %o', process.argv);
@@ -12,4 +13,4 @@ async function main() {
   await startCluster(options);
 }
 
-main();
+void main();

package/dist/scripts/start-cluster.mjs

@@ -1,7 +1,8 @@
 import { debuglog } from 'node:util';
+
 import { importModule } from '@eggjs/utils';
 
-const debug = debuglog('@eggjs/bin/scripts/start-cluster');
+const debug = debuglog('egg-bin/scripts/start-cluster');
 
 async function main() {
   debug('argv: %o', process.argv);
@@ -11,4 +12,4 @@ async function main() {
   await startCluster(options);
 }
 
-main();
+void main();

package/{src/types.ts → dist/types.d.ts}

@@ -1,4 +1,5 @@
-export interface PackageEgg {
+//#region src/types.d.ts
+interface PackageEgg {
   framework?: boolean;
   typescript?: boolean;
   tscompiler?: string;
@@ -7,3 +8,5 @@ export interface PackageEgg {
   require?: string | string[];
   import?: string | string[];
 }
+//#endregion
+export { PackageEgg };

package/dist/utils.js

@@ -0,0 +1,34 @@
+import path from "node:path";
+import fs from "node:fs/promises";
+import { fileURLToPath } from "node:url";
+
+//#region src/utils.ts
+async function readPackageJSON(baseDir) {
+	const pkgFile = path.join(baseDir, "package.json");
+	try {
+		const pkgJSON = await fs.readFile(pkgFile, "utf8");
+		return JSON.parse(pkgJSON);
+	} catch {
+		return {};
+	}
+}
+async function hasTsConfig(baseDir) {
+	const pkgFile = path.join(baseDir, "tsconfig.json");
+	try {
+		await fs.access(pkgFile);
+		return true;
+	} catch {
+		return false;
+	}
+}
+function getSourceDirname() {
+	if (typeof __dirname === "string") return __dirname;
+	const __filename = fileURLToPath(import.meta.url);
+	return path.dirname(__filename);
+}
+function getSourceFilename(filename) {
+	return path.join(getSourceDirname(), filename);
+}
+
+//#endregion
+export { getSourceDirname, getSourceFilename, hasTsConfig, readPackageJSON };

package/package.json

@@ -1,42 +1,43 @@
 {
   "name": "@eggjs/bin",
-  "version": "7.3.1",
+  "version": "7.4.0-beta.10",
   "publishConfig": {
     "access": "public"
   },
   "description": "egg developer tool",
   "repository": {
     "type": "git",
-    "url": "git@github.com:eggjs/bin.git"
+    "url": "git://github.com/eggjs/egg.git",
+    "directory": "tools/egg-bin"
   },
-  "bug": {
+  "bugs": {
     "url": "https://github.com/eggjs/egg/issues"
   },
-  "homepage": "https://github.com/eggjs/bin",
+  "homepage": "https://github.com/eggjs/egg/tree/next/tools/egg-bin",
   "author": "fengmk2 <fengmk2@gmail.com> (https://github.com/fengmk2)",
   "engines": {
-    "node": ">= 18.19.0"
+    "node": ">= 20.19.0"
   },
   "dependencies": {
-    "@eggjs/utils": "^4.2.0",
     "@oclif/core": "^4.2.0",
     "@types/mocha": "^10.0.10",
-    "@types/supertest": "^6.0.2",
-    "c8": "^10.0.0",
+    "c8": "10.1.3",
     "ci-parallel-vars": "^1.0.1",
-    "detect-port": "^2.0.0",
+    "detect-port": "^2.1.0",
     "egg-ts-helper": "^3.0.0",
-    "globby": "^11.1.0",
-    "jest-changed-files": "^29.4.2",
-    "mocha": "^11.0.1",
-    "mochawesome-with-mocha": "^8.0.0",
-    "runscript": "^2.0.0",
+    "globby": "^11.0.2",
+    "jest-changed-files": "^30.0.0",
+    "mocha": "11.7.2",
+    "mochawesome-with-mocha": "8.0.0",
+    "runscript": "^2.0.1",
     "ts-node": "^10.9.2",
-    "tsconfig-paths": "^4.1.2",
-    "utility": "^2.4.0"
+    "tsconfig-paths": "^4.2.0",
+    "utility": "^2.5.0",
+    "@eggjs/utils": "4.5.0-beta.10",
+    "@eggjs/supertest": "8.3.0-beta.10"
   },
   "peerDependencies": {
-    "@eggjs/mock": "6"
+    "@eggjs/mock": "6.1.0-beta.10"
   },
   "peerDependenciesMeta": {
     "@eggjs/mock": {
@@ -44,80 +45,60 @@
     }
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.17.1",
-    "@eggjs/mock": "6",
-    "@eggjs/tsconfig": "1",
-    "@swc-node/register": "^1.6.1",
-    "@swc/core": "^1.3.35",
-    "@types/node": "22",
-    "assert-file": "^1.0.0",
-    "coffee": "^5.5.1",
-    "cpy": "^8.1.2",
-    "cpy-cli": "^5.0.0",
-    "cross-env": "^7.0.3",
-    "egg": "^4.0.7",
+    "@swc-node/register": "^1.11.1",
+    "@swc/core": "^1.13.5",
+    "@types/node": "24.5.2",
+    "assert-file": "1",
+    "coffee": "5",
+    "cpy": "^12.0.0",
+    "cpy-cli": "^6.0.0",
+    "cross-env": "^10.0.0",
     "esbuild": "^0.25.0",
     "esbuild-register": "^3.6.0",
-    "eslint": "8",
-    "eslint-config-egg": "14",
     "npminstall": "^7.12.0",
-    "rimraf": "6",
-    "supertest": "^7.0.0",
-    "tshy": "3",
-    "tshy-after": "1",
-    "typescript": "5"
-  },
-  "scripts": {
-    "postinstall": "node scripts/postinstall.mjs",
-    "lint": "eslint --cache src test --ext .ts",
-    "pretest": "npm run clean && npm run lint -- --fix && npm run prepublishOnly",
-    "test": "node bin/run.js test",
-    "cov": "c8 --temp-directory node_modules/.c8_output -r text-summary -r json-summary -r json -r lcov -r cobertura node bin/run.js test",
-    "preci": "npm run clean && npm run lint && npm run prepublishOnly",
-    "ci": "npm run cov",
-    "clean": "rimraf dist",
-    "copyScripts": "rimraf dist/scripts && cpy scripts dist",
-    "prepublishOnly": "tshy && tshy-after && attw --pack && npm run copyScripts"
+    "rimraf": "^6.0.1",
+    "typescript": "5.9.2",
+    "tsdown": "^0.15.4",
+    "@eggjs/mock": "6.1.0-beta.10",
+    "@eggjs/tsconfig": "3.1.0-beta.10",
+    "egg": "4.1.0-beta.10"
   },
   "type": "module",
-  "tshy": {
-    "exports": {
-      ".": "./src/index.ts",
-      "./package.json": "./package.json"
-    }
-  },
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/esm/index.d.ts",
-        "default": "./dist/esm/index.js"
-      },
-      "require": {
-        "types": "./dist/commonjs/index.d.ts",
-        "default": "./dist/commonjs/index.js"
-      }
-    },
-    "./package.json": "./package.json"
-  },
   "files": [
     "bin",
     "dist",
-    "src",
     "scripts"
   ],
   "bin": {
     "egg-bin": "./bin/run.js"
   },
-  "types": "./dist/commonjs/index.d.ts",
-  "main": "./dist/commonjs/index.js",
-  "module": "./dist/esm/index.js",
   "oclif": {
     "bin": "egg-bin",
-    "commands": "./dist/esm/commands",
+    "commands": "./dist/commands",
     "dirname": "egg-bin",
     "topicSeparator": " ",
     "additionalHelpFlags": [
       "-h"
     ]
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "postinstall": "node scripts/postinstall.mjs",
+    "lint": "oxlint --type-aware",
+    "typecheck": "tsc --noEmit",
+    "pretest": "npm run clean && npm run lint -- --fix && npm run prepublishOnly",
+    "test": "node bin/run.js test",
+    "cov": "c8 --temp-directory node_modules/.c8_output -r text-summary -r json-summary -r json -r lcov -r cobertura node bin/run.js test",
+    "preci": "npm run clean && npm run lint && npm run prepublishOnly",
+    "ci": "npm run cov",
+    "clean": "rimraf dist",
+    "copyScripts": "rimraf dist/scripts && cpy scripts dist",
+    "build": "tsdown"
   }
-}
+}

package/scripts/postinstall.mjs

@@ -1,11 +1,12 @@
 import { debuglog } from 'node:util';
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
+
 import { runScript } from 'runscript';
 import { readJSON, exists } from 'utility';
 import { importResolve } from '@eggjs/utils';
 
-const debug = debuglog('@eggjs/bin/scripts/postinstall');
+const debug = debuglog('egg-bin/scripts/postinstall');
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -13,9 +14,11 @@ const rootDir = path.dirname(__dirname);
 
 async function main() {
   // node postintall.js </path/to/egg-ts-helper/dist/bin> <framework-package-name>
-  const etsBinFile = process.argv[2] || importResolve('egg-ts-helper/dist/bin.js', {
-    paths: [ rootDir ],
-  });
+  const etsBinFile =
+    process.argv[2] ||
+    importResolve('egg-ts-helper/dist/bin.js', {
+      paths: [rootDir],
+    });
   const frameworkPackageName = process.argv[3] || 'egg';
 
   // try to use INIT_CWD env https://docs.npmjs.com/cli/v9/commands/npm-run-script
@@ -52,9 +55,9 @@ async function main() {
       // https://github.com/eggjs/egg-ts-helper/pull/104
       process.env.ETS_SCRIPT_FRAMEWORK = frameworkPackageName;
       console.log('[@eggjs/bin/postinstall] run %s on %s', etsBinFile, npmRunRoot);
-      runScript(`node "${etsBinFile}"`);
+      await runScript(`node "${etsBinFile}"`);
     }
   }
 }
 
-main();
+void main();

package/scripts/start-cluster.cjs

@@ -1,8 +1,9 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 const { debuglog } = require('node:util');
+
 const { importModule } = require('@eggjs/utils');
 
-const debug = debuglog('@eggjs/bin/scripts/start-cluster');
+const debug = debuglog('egg-bin/scripts/start-cluster');
 
 async function main() {
   debug('argv: %o', process.argv);
@@ -12,4 +13,4 @@ async function main() {
   await startCluster(options);
 }
 
-main();
+void main();

package/scripts/start-cluster.mjs

@@ -1,7 +1,8 @@
 import { debuglog } from 'node:util';
+
 import { importModule } from '@eggjs/utils';
 
-const debug = debuglog('@eggjs/bin/scripts/start-cluster');
+const debug = debuglog('egg-bin/scripts/start-cluster');
 
 async function main() {
   debug('argv: %o', process.argv);
@@ -11,4 +12,4 @@ async function main() {
   await startCluster(options);
 }
 
-main();
+void main();

package/dist/commonjs/baseCommand.d.ts

@@ -1,49 +0,0 @@
-import { ForkOptions } from 'node:child_process';
-import { Command, Flags, Interfaces } from '@oclif/core';
-import { PackageEgg } from './types.js';
-export declare class ForkError extends Error {
-    code: number | null;
-    constructor(message: string, code: number | null);
-}
-export interface ForkNodeOptions extends ForkOptions {
-    dryRun?: boolean;
-}
-type Flags<T extends typeof Command> = Interfaces.InferredFlags<typeof BaseCommand['baseFlags'] & T['flags']>;
-type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
-export declare abstract class BaseCommand<T extends typeof Command> extends Command {
-    #private;
-    static enableJsonFlag: boolean;
-    static baseFlags: {
-        'dry-run': Interfaces.BooleanFlag<boolean>;
-        require: Interfaces.OptionFlag<string[] | undefined, Interfaces.CustomOptions>;
-        import: Interfaces.OptionFlag<string[] | undefined, Interfaces.CustomOptions>;
-        base: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
-        tscompiler: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
-        typescript: Interfaces.BooleanFlag<boolean>;
-        ts: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
-        javascript: Interfaces.BooleanFlag<boolean>;
-        declarations: Interfaces.BooleanFlag<boolean>;
-        inspect: Interfaces.BooleanFlag<boolean>;
-        'inspect-brk': Interfaces.BooleanFlag<boolean>;
-    };
-    protected flags: Flags<T>;
-    protected args: Args<T>;
-    protected env: {
-        [key: string]: string | undefined;
-        TZ?: string;
-    };
-    protected pkg: Record<string, any>;
-    protected isESM: boolean;
-    protected pkgEgg: PackageEgg;
-    protected globalExecArgv: string[];
-    init(): Promise<void>;
-    protected catch(err: Error & {
-        exitCode?: number;
-    }): Promise<any>;
-    protected finally(_: Error | undefined): Promise<any>;
-    protected formatRequires(): Promise<string[]>;
-    protected formatImportModule(modulePath: string): string;
-    protected addNodeOptions(options: string): void;
-    protected forkNode(modulePath: string, forkArgs: string[], options?: ForkNodeOptions): Promise<void>;
-}
-export {};