@build-script/package-tools 0.0.1

package/src/commands/detect-package-change.ts

@@ -0,0 +1,57 @@
+import { logger } from '@idlebox/logger';
+import { printLine } from '@idlebox/node';
+import { argv, CommandDefine, isJsonOutput, pArgS } from '../common/functions/cli.js';
+import { PackageManagerUsageKind } from '../common/package-manager/driver.abstract.js';
+import { increaseVersion } from '../common/package-manager/package-json.js';
+import { createPackageManager } from '../common/package-manager/package-manager.js';
+import { executeChangeDetect } from '../common/shared-jobs/detect-change-job.js';
+
+process.env.COREPACK_ENABLE_STRICT = '0';
+
+export class Command extends CommandDefine {
+	protected override _usage = `${pArgS('--bump')} ${pArgS('--json')}`;
+	protected override _description = '本地运行npm pack并与npm上的最新版本对比差异';
+	protected override _help = '';
+	protected override _arguments = {
+		'--bump': { flag: true, description: '当发现更改时更新package.json，增加版本号0.0.1' },
+	};
+}
+
+export async function main() {
+	const autoInc = argv.flag('--bump');
+
+	const pm = await createPackageManager(PackageManagerUsageKind.Read);
+
+	const pkgJson = await pm.loadPackageJson();
+	const { changedFiles, hasChange, remoteVersion } = await executeChangeDetect(pm, {});
+
+	if (autoInc) {
+		if (changedFiles.length) {
+			logger.log('自动增加版本号...');
+			if (!remoteVersion) {
+				throw new Error('程序错误, remoteVersion 为空');
+			}
+			await increaseVersion(pkgJson, remoteVersion);
+		} else {
+			logger.log('没有检测到更改');
+		}
+	} else {
+		printResult(changedFiles, hasChange);
+	}
+	return 0;
+}
+
+function printResult(changedFiles: string[], changed: boolean) {
+	if (process.stdout.isTTY && !isJsonOutput) {
+		if (changedFiles.length === 0) {
+			console.log('changes: no');
+		} else {
+			printLine();
+			logger.log('%s', changedFiles.join('\n'));
+			printLine();
+			console.log('changes: yes');
+		}
+	} else {
+		console.log(JSON.stringify({ changedFiles, changed }));
+	}
+}

package/src/commands/monorepo-bump-version.ts

@@ -0,0 +1,152 @@
+import { createWorkspace, type IPackageInfo, type MonorepoWorkspace } from '@build-script/monorepo-lib';
+import { Emitter, humanDate } from '@idlebox/common';
+import { BuilderDependencyGraph, type IWatchEvents } from '@idlebox/dependency-graph';
+import { logger } from '@idlebox/logger';
+import { makeRe } from 'minimatch';
+import { inspect } from 'node:util';
+import { argv, CommandDefine, CSI } from '../common/functions/cli.js';
+import { PackageManagerUsageKind } from '../common/package-manager/driver.abstract.js';
+import { increaseVersion } from '../common/package-manager/package-json.js';
+import { createPackageManager } from '../common/package-manager/package-manager.js';
+import { executeChangeDetect } from '../common/shared-jobs/detect-change-job.js';
+
+export class Command extends CommandDefine {
+	protected override _usage = ``;
+	protected override _description = '在monorepo中按照依赖顺序分别运行detect-package-change';
+	protected override _help = '';
+	protected override _arguments = {
+		'--skip': { flag: false, description: '跳过前N-1个包（从第N个包开始运行）' },
+		'--allow-private': { flag: true, description: '即使private=true也执行' },
+		'--exclude': { flag: false, description: '排除指定的包' },
+	};
+}
+
+interface IState {
+	readonly index: number;
+	readonly length: number;
+	readonly options: ReturnType<typeof options>;
+	readonly changedPackages: string[];
+}
+
+class BumpVersionJob implements IWatchEvents {
+	private readonly _onSuccess = new Emitter<void>();
+	public readonly onSuccess = this._onSuccess.event;
+
+	private readonly _onFailed = new Emitter<Error>();
+	public readonly onFailed = this._onFailed.event;
+
+	private readonly _onRunning = new Emitter<void>();
+	public readonly onRunning = this._onRunning.event;
+
+	private readonly allowPrivate: boolean;
+
+	constructor(
+		private readonly state: IState,
+		private readonly project: IPackageInfo,
+		private readonly workspace: MonorepoWorkspace,
+	) {
+		this.allowPrivate = argv.flag('--allow-private') > 0;
+	}
+
+	async execute() {
+		const { index, length, options, changedPackages } = this.state;
+		const w = length.toFixed(0).length;
+		console.log(`📦 [${(index + 1).toFixed(0).padStart(w)}/${length}] ${this.project.name}`);
+		if (this.project.packageJson.private && !this.allowPrivate) {
+			console.log(`  🛑 跳过，private=true: ${this.project.name}`);
+		} else if (options.skip > index + 1 || options.exclude?.test(this.project.name)) {
+			console.log(`  ⏩ ${CSI}2m跳过${CSI}0m`);
+		} else {
+			const startTime = Date.now();
+
+			console.log(`  🔍 ${CSI}38;5;14m检查包${CSI}0m`);
+
+			const pm = await createPackageManager(PackageManagerUsageKind.Write, this.workspace, this.project.absolute);
+			const { hasChange, remoteVersion } = await executeChangeDetect(pm, { forcePrivate: this.allowPrivate });
+
+			if (!remoteVersion) {
+				console.log('    ✨ 远程版本不存在\n');
+				if (this.project.packageJson.version !== '0.0.1') {
+					throw new Error(`远程版本不存在，但本地包版本不是 0.0.1\n  package: ${pm.projectPath}/package.json`);
+				}
+			} else if (hasChange) {
+				changedPackages.push(this.project.name);
+
+				const packageJson = await pm.loadPackageJson();
+				await increaseVersion(packageJson, remoteVersion);
+				console.log('    ✍️ 已修改本地包版本\n');
+			} else {
+				console.log(`    ✨ ${CSI}38;5;10m未发现修改${CSI}0m (in ${humanDate.delta(Date.now() - startTime)})\n`);
+			}
+		}
+	}
+
+	[inspect.custom]() {
+		// TODO
+		return '~~~~~~~~';
+	}
+}
+
+function options() {
+	const excludes = argv.multiple('--exclude');
+	let excludeReg: RegExp | undefined;
+	if (excludes.length > 0) {
+		let regTxt = [];
+		for (const exclude of excludes) {
+			const match = makeRe(exclude, { platform: 'linux' });
+			if (!match) {
+				throw new Error(`无法解析排除模式: ${exclude}`);
+			}
+			regTxt.push(match.source);
+		}
+		excludeReg = new RegExp(`^(${regTxt.join('|')})$`);
+	}
+
+	const skip = Number.parseInt(argv.single('--skip') || '0');
+	if (Number.isNaN(skip)) {
+		throw new Error('skip 不是数字');
+	}
+
+	return {
+		exclude: excludeReg,
+		skip: skip,
+	};
+}
+
+export async function main() {
+	const workspace = await createWorkspace();
+	await workspace.decoupleDependencies();
+	const projects = await workspace.listPackages();
+
+	const graph = new BuilderDependencyGraph(1, logger);
+
+	const opts = options();
+
+	const changedPackages: string[] = [];
+
+	let index = 0;
+	for (const project of projects) {
+		if (!project.packageJson.name) continue;
+
+		graph.addNode(
+			project.packageJson.name,
+			[],
+			new BumpVersionJob(
+				{
+					index,
+					length: projects.length,
+					options: opts,
+					changedPackages,
+				},
+				project,
+				workspace,
+			),
+		);
+
+		index++;
+	}
+
+	await graph.startup();
+
+	console.log(`🎉 所有任务完成，共修改了 ${changedPackages.length} 个包`);
+}

package/src/commands/monorepo-cnpm-sync.ts

@@ -0,0 +1,19 @@
+import { createWorkspace } from '@build-script/monorepo-lib';
+import { argv } from '@idlebox/args/default';
+import { CommandDefine, isQuiet, pDesc } from '../common/functions/cli.js';
+import { cnpmSync } from '../common/shared-jobs/cnpm-sync.js';
+
+export class Command extends CommandDefine {
+	protected override _usage = '';
+	protected override _description = '调用cnpm sync命令';
+	protected override _help = pDesc('需要在PATH中存在cnpm命令');
+}
+
+export async function main() {
+	const workspace = await createWorkspace();
+	const list = await workspace.listPackages();
+
+	const dry = argv.flag('--dry') > 0;
+
+	await cnpmSync(list, isQuiet, dry);
+}

package/src/commands/monorepo-invalid.ts

@@ -0,0 +1,22 @@
+import { logger } from '@idlebox/logger';
+import { CommandDefine } from '../common/functions/cli.js';
+import { PackageManagerUsageKind } from '../common/package-manager/driver.abstract.js';
+import { createPackageManager } from '../common/package-manager/package-manager.js';
+
+export class Command extends CommandDefine {
+	protected override _usage = '';
+	protected override _description = '从npm缓存中删除关于本monorepo的数据，以便安装最新版本';
+	protected override _help = '';
+}
+
+export async function main() {
+	const packageManager = await createPackageManager(PackageManagerUsageKind.Read);
+	const cache = await packageManager.createCacheHandler();
+
+	const list = await packageManager.workspace.listPackages();
+
+	logger.log('删除%d个项目在 %s 的npm缓存', list.length, cache.path);
+	for (const data of list) {
+		await cache.deleteMetadata(data.packageJson.name);
+	}
+}

package/src/commands/monorepo-list.ts

@@ -0,0 +1,46 @@
+import { createWorkspace } from '@build-script/monorepo-lib';
+import { argv, CommandDefine, isJsonOutput, isVerbose, pArgS } from '../common/functions/cli.js';
+
+export class Command extends CommandDefine {
+	protected override _usage = `${pArgS('--verbose')} ${pArgS('--json')} ${pArgS('--relative')}`;
+	protected override _description = '列出所有项目目录';
+	protected override _help = '';
+	protected override _arguments = {
+		'--verbose': { flag: true, description: '列出所有信息，而不仅是目录' },
+		'--json': { flag: true, description: '输出json（同时使--verbose和--relative无效）' },
+		'--relative': { flag: true, description: '输出相对路径（相对于monorepo根目录）' },
+	};
+}
+
+export async function main() {
+	const repo = await createWorkspace();
+	const list = await repo.listPackages();
+
+	const isRelative = argv.flag('--relative') > 0;
+
+	if (isJsonOutput) {
+		console.log(
+			JSON.stringify(
+				list.map((e) => {
+					const { packageJson, ...extras } = e;
+					return extras;
+				}),
+			),
+		);
+		return;
+	}
+
+	for (const item of list) {
+		if (isVerbose) {
+			console.log('name: %s', item.name);
+			console.log('path: %s', item.absolute);
+			console.log('relative: %s', item.relative);
+			console.log('dependOn: %s', item.dependencies.join(', '));
+			console.log('');
+		} else if (isRelative) {
+			console.log(item.relative);
+		} else {
+			console.log(item.absolute);
+		}
+	}
+}

package/src/commands/monorepo-publish.ts

@@ -0,0 +1,227 @@
+import {
+	createWorkspace,
+	normalizePackageName,
+	type IPackageInfo,
+	type MonorepoWorkspace,
+} from '@build-script/monorepo-lib';
+import { Emitter, prettyPrintError } from '@idlebox/common';
+import { BuilderDependencyGraph, type IWatchEvents } from '@idlebox/dependency-graph';
+import { logger } from '@idlebox/logger';
+import { commandInPath, emptyDir, writeFileIfChangeSync } from '@idlebox/node';
+import { cpSync, existsSync } from 'fs';
+import { resolve } from 'path';
+import { inspect } from 'util';
+import { argv, CommandDefine, CSI, pArgS } from '../common/functions/cli.js';
+import { PackageManagerUsageKind } from '../common/package-manager/driver.abstract.js';
+import { increaseVersion } from '../common/package-manager/package-json.js';
+import { createPackageManager } from '../common/package-manager/package-manager.js';
+import { cnpmSyncNames } from '../common/shared-jobs/cnpm-sync.js';
+import { executeChangeDetect } from '../common/shared-jobs/detect-change-job.js';
+
+export class Command extends CommandDefine {
+	protected override _usage = `${pArgS('--debug')} ${pArgS('--dry')}`;
+	protected override _description = '在monorepo中按照依赖顺序发布修改过的包';
+	protected override _help = '';
+	protected override _arguments = {
+		'--debug': { flag: true, description: '详细输出模式' },
+		'--dry': { flag: true, description: '仅检查修改，不发布（仍会修改version字段）' },
+		'--private': { flag: false, description: '即使private=true也执行' },
+	};
+}
+
+interface IState {
+	readonly index: number;
+	readonly length: number;
+	readonly options: ReturnType<typeof options>;
+}
+
+let indexDisplay = 0;
+class BuildPackageJob implements IWatchEvents {
+	private readonly _onSuccess = new Emitter<void>();
+	public readonly onSuccess = this._onSuccess.event;
+
+	private readonly _onFailed = new Emitter<Error>();
+	public readonly onFailed = this._onFailed.event;
+
+	private readonly _onRunning = new Emitter<void>();
+	public readonly onRunning = this._onRunning.event;
+
+	private shouldPublish = '';
+
+	constructor(
+		private readonly state: IState,
+		private readonly project: IPackageInfo,
+		private readonly workspace: MonorepoWorkspace,
+	) {
+		this.onSuccess(() => {
+			indexDisplay++;
+			const { length } = this.state;
+			const w = length.toFixed(0).length;
+			console.log(`📦 [${indexDisplay.toFixed(0).padStart(w)}/${length}] ${this.project.name}`);
+			console.log(this.logText.join('\n'));
+			this.logText.length = 0;
+		});
+		this.onFailed((e) => {
+			indexDisplay++;
+			const { length } = this.state;
+			const w = length.toFixed(0).length;
+			console.log(`📦 [${indexDisplay.toFixed(0).padStart(w)}/${length}] ${this.project.name}`);
+			console.log(this.logText.join('\n'));
+			prettyPrintError('❌pack failed', e);
+			this.logText.length = 0;
+		});
+	}
+
+	get name() {
+		return this.project.name;
+	}
+
+	getPackagePath() {
+		return this.shouldPublish || undefined;
+	}
+
+	async execute() {
+		this._onRunning.fire();
+		this.log(`    🔍 ${CSI}38;5;14m检查包${CSI}0m`);
+
+		const pm = await createPackageManager(PackageManagerUsageKind.Write, this.workspace, this.project.absolute);
+		const { changedFiles, hasChange, remoteVersion } = await executeChangeDetect(pm, {});
+		let shouldPublish = hasChange || changedFiles.length > 0;
+		let localVersion = this.project.packageJson.version;
+
+		if (hasChange) {
+			const packageJson = await pm.loadPackageJson();
+			localVersion = await increaseVersion(packageJson, remoteVersion || '0.0.0');
+			this.log('    ✍️ 已修改本地包版本\n');
+		}
+		if (!shouldPublish) {
+			this.log(`    ✨ ${CSI}38;5;10m未发现修改${CSI}0m\n`);
+			this._onSuccess.fire();
+			return;
+		}
+
+		this.log(`    🔄 打包文件`);
+
+		const tempFile = resolve(
+			this.workspace.temp,
+			`publish/${normalizePackageName(this.project.name)}-${localVersion}.tgz`,
+		);
+		this.shouldPublish = await pm.pack(tempFile);
+
+		if (remoteVersion) {
+			this.log(`    🎈 即将发布新版本 "${this.project.packageJson.version}" 以更新远程版本 "${remoteVersion}"`);
+		} else {
+			this.log(`    🎈 即将发布初始版本 "${this.project.packageJson.version}"`);
+		}
+		this._onSuccess.fire();
+	}
+
+	private readonly logText: string[] = [];
+	log(text: string) {
+		this.logText.push(text);
+	}
+
+	[inspect.custom]() {
+		// TODO
+		return '~~~~~~~~';
+	}
+}
+
+function options() {
+	const dryRun = argv.flag('--dry') > 0;
+
+	return {
+		dryRun: dryRun,
+	};
+}
+
+export async function main() {
+	const workspace = await createWorkspace();
+	await workspace.decoupleDependencies();
+
+	const temp = resolve(workspace.temp, 'publish');
+	await emptyDir(temp);
+
+	const projects = await workspace.listPackages();
+
+	const concurrency = argv.flag(['--debug', '-d']) > 0 ? 1 : 10;
+	const graph = new BuilderDependencyGraph<BuildPackageJob>(concurrency, logger);
+	const opts = options();
+
+	const shouldPublishProjects = projects.filter((project) => {
+		if (!project.packageJson.name) return false;
+
+		if (project.packageJson.private) {
+			console.log(`📦 ${project.name}`);
+			console.log(`    🛑 跳过，private=true: ${project.name}`);
+			graph.addEmptyNode(project.name);
+			return false;
+		}
+
+		return true;
+	});
+
+	let index = 0;
+	for (const project of shouldPublishProjects) {
+		graph.addNode(
+			project.name,
+			project.devDependencies,
+			new BuildPackageJob(
+				{
+					index,
+					length: shouldPublishProjects.length,
+					options: opts,
+				},
+				project,
+				workspace,
+			),
+		);
+
+		index++;
+	}
+
+	await graph.startup();
+
+	const packageToPublish: { name: string; pack: string }[] = [];
+	for (const id of graph.overallOrder) {
+		const node = graph.getNodeData(id);
+		if (!(node instanceof BuildPackageJob)) continue;
+
+		const pack = node.getPackagePath();
+		if (!pack) continue;
+		packageToPublish.push({ name: node.name, pack });
+	}
+	console.log(`✅ 打包阶段结束，有 ${packageToPublish.length} 个包需要发布`);
+
+	if (opts.dryRun) {
+		console.log(`中断并退出（--dry）`);
+		return;
+	}
+
+	const pm = await createPackageManager(PackageManagerUsageKind.Write, workspace, temp);
+	const npmrc = workspace.getNpmRCPath(true);
+	if (existsSync(npmrc)) {
+		cpSync(npmrc, resolve(temp, '.npmrc'));
+		writeFileIfChangeSync(resolve(temp, 'package.json'), '{}');
+	}
+
+	const w = packageToPublish.length.toFixed(0).length;
+	let published: string[] = [];
+	for (const { name, pack } of packageToPublish) {
+		console.log(`📦 [${(index + 1).toFixed(0).padStart(w)}/${packageToPublish.length}] ${name}`);
+		const r = await pm.uploadTarball(pack);
+		if (r.published) {
+			console.log(`    👌 已发布新版本 ${r.version}`);
+			published.push(name);
+		} else {
+			console.log(`    🤔 版本号未改变 ${r.version}`);
+		}
+	}
+
+	console.log(`🎉 所有任务完成，共发布了 ${published.length} 个包`);
+
+	if (await commandInPath('cnpm')) {
+		await cnpmSyncNames(published, true).catch();
+	}
+	console.log(`	🐱 已同步到 cnpm`);
+}

package/src/commands/monorepo-tsconfig.ts

@@ -0,0 +1,156 @@
+import { createWorkspace, type IPackageInfo } from '@build-script/monorepo-lib';
+import { resolveExportPath } from '@idlebox/common';
+import { loadJsonFile, writeJsonFile, writeJsonFileBack } from '@idlebox/json-edit';
+import { logger } from '@idlebox/logger';
+import { relativePath } from '@idlebox/node';
+import { existsSync } from 'node:fs';
+import { dirname, resolve } from 'node:path';
+import { argv, CommandDefine, pArgS } from '../common/functions/cli.js';
+
+export class Command extends CommandDefine {
+	protected override _usage = `${pArgS('--dev')}`;
+	protected override _description = '为所有项目的 tsconfig.json 添加 references 字段';
+	protected override _help =
+		`查找tsconfig.json和src/tsconfig.json\n    如果不在这里，可以在package.json中设置exports['./tsconfig.json'] = './xxxx'`;
+	protected override _arguments = {
+		'--dev': { flag: true, description: '也将devDependencies中的包添加到references中' },
+	};
+}
+
+const path_element_id = 'package-tools/monorepo-tsconfig';
+interface IReference {
+	$id?: string;
+	path: string;
+}
+
+export async function main() {
+	const includeDev = argv.flag('--dev') > 0;
+
+	const repo = await createWorkspace();
+
+	try {
+		await repo.requireGitClean();
+	} catch (e: any) {
+		logger.fatal(e.message);
+	}
+
+	const list = await repo.listPackages();
+	const configAbsMap = new Map<IPackageInfo, string>();
+	const projNameMap = new Map<string, IPackageInfo>();
+	// repo.root
+
+	logger.log(`在${list.length}个项目中搜索tsconfig.json文件...`);
+	for (const proj of list) {
+		projNameMap.set(proj.name, proj);
+
+		if (typeof proj.packageJson.exports === 'object' && proj.packageJson.exports['./tsconfig.json']) {
+			const file = resolveExportPath(proj.packageJson.exports['./tsconfig.json'], ['default']);
+			if (file) {
+				configAbsMap.set(proj, resolve(proj.absolute, file));
+				continue;
+			}
+		}
+
+		let file = resolve(proj.absolute, 'tsconfig.json');
+		if (existsSync(file)) {
+			configAbsMap.set(proj, file);
+			continue;
+		}
+
+		file = resolve(proj.absolute, 'src', 'tsconfig.json');
+		if (existsSync(file)) {
+			configAbsMap.set(proj, file);
+			continue;
+		}
+		logger.log(`未找到${proj.name}的tsconfig.json文件`);
+	}
+
+	const batchSave = new Map<IPackageInfo, any>();
+	for (const [proj, tsconfig] of configAbsMap.entries()) {
+		logger.log(`正在处理${proj.name}的tsconfig.json文件...`);
+		const tsconfigJson = await loadJsonFile(tsconfig);
+		batchSave.set(proj, tsconfigJson);
+
+		if (!tsconfigJson.references) tsconfigJson.references = [];
+		const references: IReference[] = tsconfigJson.references;
+
+		const workspaceDeps = filterByLink(proj.packageJson.dependencies);
+		if (includeDev) {
+			workspaceDeps.push(...filterByLink(proj.packageJson.devDependencies));
+		}
+
+		const knownPaths = [];
+
+		for (const name of workspaceDeps) {
+			const depProj = projNameMap.get(name);
+			if (!depProj) {
+				throw new Error(`在${proj.name}的package.json中存在未知依赖项目：${name}`);
+			}
+
+			const depTsconfig = configAbsMap.get(depProj);
+			if (!depTsconfig) continue;
+
+			const path = relativePath(dirname(tsconfig), depTsconfig);
+			const added = addToSet(references, path);
+			if (added) logger.log(`  - 添加${path}`);
+
+			knownPaths.push(path);
+		}
+
+		for (const ref of references.toReversed()) {
+			if (ref.$id !== path_element_id) continue;
+
+			if (knownPaths.includes(ref.path)) continue;
+			// 删除不再引用
+			const index = references.lastIndexOf(ref);
+			references.splice(index, 1);
+			logger.log(`  - 删除${ref.path}`);
+		}
+
+		if (references.length === 0) {
+			tsconfigJson.references = undefined;
+			logger.log(`  - 删除references字段`);
+		}
+	}
+
+	for (const [proj, tsconfigJson] of batchSave.entries()) {
+		const ch = await writeJsonFileBack(tsconfigJson);
+
+		logger.log(`  - ${proj.name} ${ch ? '已修改' : '未修改'} tsconfig.json`);
+	}
+
+	const rootTsconfig = resolve(repo.root, 'tsconfig.everything.json');
+	const references: IReference[] = [];
+	for (const tsconfig of configAbsMap.values()) {
+		references.push({ path: relativePath(repo.root, tsconfig) });
+	}
+	await writeJsonFile(rootTsconfig, {
+		compilerOptions: {
+			esModuleInterop: true,
+			outDir: './lib',
+			moduleResolution: 'Node',
+			module: 'ESNext',
+			target: 'ESNext',
+		},
+		references,
+	});
+}
+
+function addToSet(set: IReference[], value: string) {
+	if (set.some((item) => item.path === value)) {
+		return false;
+	}
+
+	set.push({ $id: path_element_id, path: value });
+	return true;
+}
+
+function filterByLink(dependencies: Record<string, string>): string[] {
+	// 只保留引用workspace的
+	if (!dependencies) return [];
+
+	return Object.keys(dependencies).filter((dep) => {
+		const version = dependencies[dep];
+		return version.startsWith('workspace:');
+	});
+}