@mznjs/mbump 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 白鸢
+
+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,41 @@
+# @vill-v/bumpp
+
+遵循 semver 规范进行 release 的工具包（暂时只针对个人使用，并没有开放过多的配置项）
+
+本包为
+[bumpp](https://github.com/antfu/bumpp)
+与
+[changelogen](https://github.com/unjs/changelogen)
+的组合
+
+解决
+- 使用 [bumpp](https://github.com/antfu/bumpp) 无法生成 CHANGELOG.md
+- 使用 [changelogen](https://github.com/unjs/changelogen) 对 monorepo项目 无法进行有效的release
+
+## 简单使用
+
+```shell
+vbumpp
+```
+## monorepo项目
+
+```shell
+vbumpp -r
+```
+
+## 自定义bump文件
+
+```shell
+vbumpp package.json packages/*/package.json
+```
+
+## ❤️ 鸣谢
+
+[bumpp](https://github.com/antfu/bumpp)
+
+[changelogen](https://github.com/unjs/changelogen)
+
+
+## License
+
+[MIT](https://gitee.com/vill-v/bump/blob/main/LICENSE)

package/bin/index.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { createCli } from '../dist/cli.js'
+
+createCli()

package/dist/bump-CtknNhb9.js

@@ -0,0 +1,196 @@
+import { ProgressEvent, loadBumpConfig, versionBump, versionBumpInfo } from "bumpp";
+import { consola } from "consola";
+import { oraPromise } from "ora";
+import { existsSync } from "node:fs";
+import { readFile, writeFile } from "node:fs/promises";
+import { generateMarkDown, getGitDiff, getLastGitTag, loadChangelogConfig, parseCommits } from "changelogen";
+import { x } from "tinyexec";
+import { defu } from "defu";
+import { loadConfig, presetMini } from "esconf";
+import { glob } from "tinyglobby";
+
+//#region src/changelog.ts
+/**
+* 获取远程仓库的最新tag
+* @returns
+*/
+async function getTag() {
+	try {
+		return await getLastGitTag();
+	} catch (_e) {
+		return "";
+	}
+}
+/**
+* 生成changelog
+* @param rawConfig
+*/
+async function changelog(rawConfig) {
+	const config = {
+		...rawConfig,
+		newVersion: rawConfig.to,
+		to: `v${rawConfig.to}`,
+		from: `v${rawConfig.from}`
+	};
+	const rawCommits = await getGitDiff(config.from);
+	const commits = parseCommits(rawCommits, config).filter((c) => config.types[c.type] && !(c.type === "chore" && c.scope === "deps" && !c.isBreaking));
+	let markdown = await generateMarkDown(commits, config);
+	markdown = markdown.replace("#### ⚠️ Breaking Changes", `#### ${config.types.BreakingChange.title}`).replace("### ❤️ Contributors", "### ❤️ 贡献者");
+	let changelogMD;
+	if (existsSync(config.output)) changelogMD = await readFile(config.output, "utf8");
+	else changelogMD = "# Changelog\n\n";
+	const lastEntry = changelogMD.match(/^###?\s+.*$/m);
+	if (lastEntry) changelogMD = `${changelogMD.slice(0, lastEntry.index) + markdown}\n\n${changelogMD.slice(lastEntry.index)}`;
+	else changelogMD += `\n${markdown}\n\n`;
+	await writeFile(config.output, changelogMD);
+	await x("git", [
+		"add",
+		config.output,
+		"package.json"
+	]);
+	await x("git", [
+		"commit",
+		"-m",
+		`chore: update ${config.output}`
+	]);
+	return {
+		markdown,
+		changelogMD
+	};
+}
+
+//#endregion
+//#region src/config.ts
+function getDefaultsChangeLogConfig() {
+	return { types: {
+		feat: { title: "🚀 特性" },
+		perf: { title: "🔥 性能优化" },
+		fix: { title: "🩹 修复" },
+		refactor: { title: "💅 重构" },
+		examples: { title: "🏀 示例" },
+		docs: { title: "📖 文档" },
+		chore: { title: "🏡 框架" },
+		build: { title: "📦 打包" },
+		test: { title: "✅ 测试" },
+		BreakingChange: { title: "🚨 破坏性改动" },
+		style: { title: "🎨 样式" }
+	} };
+}
+/**
+* 合并配置项
+* @param rawConfig
+*/
+async function resolveConfig(rawConfig) {
+	const cwd = process.cwd();
+	const changelog$1 = await loadChangelogConfig(cwd, getDefaultsChangeLogConfig());
+	const bumpp = await loadBumpConfig({
+		cwd,
+		files: ["package.json", "package-lock.json"],
+		commit: true,
+		tag: true,
+		push: true,
+		confirm: false,
+		ignoreScripts: false,
+		noVerify: false
+	});
+	const { config } = await loadConfig({ presets: [presetMini({
+		name: "mbump",
+		configName: "config",
+		rcFile: true,
+		globalRc: true
+	})] });
+	const _resolveConfig = defu(rawConfig, config, {
+		changelog: changelog$1,
+		bumpp,
+		accesstoken: {}
+	});
+	if (rawConfig.bumpp?.recursive) {
+		const files = await glob("**/package.json", {
+			ignore: ["**/node_modules/**"],
+			cwd,
+			onlyFiles: true
+		});
+		files.forEach((item) => {
+			_resolveConfig.bumpp.files.push(item);
+		});
+	}
+	_resolveConfig.bumpp.recursive = false;
+	_resolveConfig.bumpp.files = [...new Set(_resolveConfig.bumpp.files)];
+	return _resolveConfig;
+}
+const defineConfig = (config) => config;
+
+//#endregion
+//#region src/bump.ts
+/**
+* antfu/bumpp progress
+*/
+function progress({ event, script, updatedFiles, skippedFiles, newVersion }) {
+	switch (event) {
+		case ProgressEvent.FileUpdated:
+			consola.success(`Updated ${updatedFiles.pop()} to ${newVersion}`);
+			break;
+		case ProgressEvent.FileSkipped:
+			consola.info(`${skippedFiles.pop()} did not need to be updated`);
+			break;
+		case ProgressEvent.GitCommit:
+			consola.info("Git commit");
+			break;
+		case ProgressEvent.GitTag:
+			consola.info("Git tag");
+			break;
+		case ProgressEvent.GitPush:
+			consola.success("Git push");
+			break;
+		case ProgressEvent.NpmScript:
+			consola.success(`Npm run ${script}`);
+			break;
+	}
+}
+/**
+* 更新版本
+* @param option
+*/
+async function bumpVersion(option = {}) {
+	const config = await resolveConfig(option);
+	const currentTag = await getTag();
+	const { state } = await versionBumpInfo();
+	const res = { config };
+	res.bumpp = state;
+	if (currentTag) res.changelog = await oraPromise(changelog({
+		...config.changelog,
+		to: state.newVersion,
+		from: state.currentVersion
+	}), {
+		text: "changelog",
+		successText: `Update ${config.changelog.output} success`,
+		failText: `Update ${config.changelog.output} success`
+	});
+	await versionBump({
+		...config.bumpp,
+		progress,
+		release: state.newVersion
+	});
+	return res;
+}
+/**
+* 更新版本伴随基础 release 基础等待动画
+* @param option 更新版本配置
+* @param addRelease release脚本
+* @param provider git 远程储存提供商
+*/
+async function bumpVersionWithBaseRelease(option = {}, addRelease, provider) {
+	const { bumpp, changelog: changelog$1, config } = await bumpVersion(option);
+	await oraPromise(addRelease({
+		bumpp,
+		changelog: changelog$1,
+		config
+	}), {
+		text: `${provider} Release`,
+		successText: ` [${provider}] add release v${bumpp.newVersion} success`,
+		failText: `[${provider}] add release v${bumpp.newVersion} fail`
+	});
+}
+
+//#endregion
+export { bumpVersion, bumpVersionWithBaseRelease, defineConfig };

package/dist/changelogens.d.ts

@@ -0,0 +1 @@
+export * from "changelogen"

package/dist/changelogens.js

@@ -0,0 +1 @@
+export * from "changelogen"

package/dist/cli.d.ts

@@ -0,0 +1,8 @@
+import { Config } from "./types.d-B0g2i1Ge.js";
+
+//#region src/cli.d.ts
+declare function createBaseCli(bumpVersion: (config?: Config) => Promise<any>, version?: string): void;
+declare const createCli: () => void;
+
+//#endregion
+export { createBaseCli, createCli };

package/dist/cli.js

@@ -0,0 +1,23 @@
+import { bumpVersion } from "./bump-CtknNhb9.js";
+import { cac } from "cac";
+
+//#region src/cli.ts
+function createBaseCli(bumpVersion$1, version) {
+	const $cac = cac("mbump");
+	$cac.command("[...files]").option("-o,--output [output]", "CHANGELOG.md 生成位置", { default: "CHANGELOG.md" }).option("-r,--recursive", "recursively", { default: false }).action(async (files, options) => {
+		await bumpVersion$1({
+			bumpp: {
+				files,
+				recursive: options.recursive
+			},
+			changelog: { output: options.output }
+		});
+	});
+	$cac.version(version || "1.0.1");
+	$cac.help();
+	$cac.parse();
+}
+const createCli = () => createBaseCli(bumpVersion);
+
+//#endregion
+export { createBaseCli, createCli };

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+import { Accesstokens, BumpVersion, BumppResult, ChangelogOptions, ChangelogResult, Config, ResolveConfig } from "./types.d-B0g2i1Ge.js";
+
+//#region src/bump.d.ts
+/**
+* 更新版本
+* @param option
+*/
+declare function bumpVersion(option?: Config): Promise<BumpVersion>;
+/**
+* 更新版本伴随基础 release 基础等待动画
+* @param option 更新版本配置
+* @param addRelease release脚本
+* @param provider git 远程储存提供商
+*/
+declare function bumpVersionWithBaseRelease(option: Config | undefined, addRelease: (res: BumpVersion) => Promise<any>, provider: string): Promise<void>;
+
+//#endregion
+//#region src/config.d.ts
+declare const defineConfig: (config: Config) => Config;
+
+//#endregion
+export { Accesstokens, BumpVersion, BumppResult, ChangelogOptions, ChangelogResult, Config, ResolveConfig, bumpVersion, bumpVersionWithBaseRelease, defineConfig };

package/dist/index.js

@@ -0,0 +1,3 @@
+import { bumpVersion, bumpVersionWithBaseRelease, defineConfig } from "./bump-CtknNhb9.js";
+
+export { bumpVersion, bumpVersionWithBaseRelease, defineConfig };

package/dist/types.d-B0g2i1Ge.d.ts

@@ -0,0 +1,76 @@
+import { VersionBumpOptions, versionBumpInfo } from "bumpp";
+import { ChangelogConfig, ResolvedChangelogConfig } from "changelogen";
+
+//#region src/changelog.d.ts
+/**
+* 生成changelog
+* @param rawConfig
+*/
+declare function changelog(rawConfig: ResolvedChangelogConfig): Promise<{
+    markdown: string;
+    changelogMD: string;
+}>;
+
+//#endregion
+//#region src/types.d.ts
+/**
+* changelog 生成配置信息
+*/
+interface ChangelogOptions extends Omit<Partial<ChangelogConfig>, 'cwd' | 'tokens' | 'newVersion' | 'to' | 'from' | 'publish'> {
+}
+interface Accesstokens {
+    [key: string]: string;
+}
+/**
+* 用户配置信息
+*/
+interface Config {
+    /**
+     * changelog 生成配置信息
+     */
+    changelog?: ChangelogOptions;
+    /**
+     * bumpp 配置信息
+     */
+    bumpp?: Omit<VersionBumpOptions, 'progress' | 'cwd'>;
+    accesstoken?: Accesstokens;
+}
+/**
+* 合并后的配置信息
+*/
+interface ResolveConfig {
+    /**
+     * changelog 生成配置信息
+     */
+    changelog: ResolvedChangelogConfig;
+    /**
+     * bumpp 配置信息
+     */
+    bumpp: Omit<VersionBumpOptions, 'progress'>;
+    accesstoken: Accesstokens;
+}
+/**
+* bumpp 生成结果
+*/
+type BumppResult = Awaited<ReturnType<typeof versionBumpInfo>>;
+/**
+* changelog 生成结果
+*/
+type ChangelogResult = Awaited<ReturnType<typeof changelog>>;
+/**
+* bumppVersion 方法返回结果
+*/
+interface BumpVersion {
+    /**
+     * bumpp 生成结果
+     */
+    bumpp: BumppResult['state'];
+    /**
+     * changelog 生成结果
+     */
+    changelog: ChangelogResult;
+    config: ResolveConfig;
+}
+
+//#endregion
+export { Accesstokens, BumpVersion, BumppResult, ChangelogOptions, ChangelogResult, Config, ResolveConfig };

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@mznjs/mbump",
+  "version": "1.0.1",
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "mbump": "bin/index.js"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "author": {
+    "name": "whitekite",
+    "email": "1075790909@qq.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitee.com/vill-v/bump",
+    "directory": "packages/bump"
+  },
+  "files": [
+    "dist",
+    "bin"
+  ],
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./changelogen": {
+      "import": {
+        "types": "./dist/changelogens.d.ts",
+        "default": "./dist/changelogens.js"
+      }
+    },
+    "./cli": {
+      "import": {
+        "types": "./dist/cli.d.ts",
+        "default": "./dist/cli.js"
+      }
+    }
+  },
+  "dependencies": {
+    "bumpp": "^10.1.0",
+    "cac": "^6.7.14",
+    "changelogen": "^0.6.1",
+    "consola": "^3.4.2",
+    "defu": "^6.1.4",
+    "esconf": "~0.5.1",
+    "ora": "^8.2.0",
+    "tinyexec": "^1.0.1",
+    "tinyglobby": "^0.2.13"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "release": "pnpm publish --access public"
+  }
+}