@peiyanlu/release 0.0.4 → 0.0.6

package/dist/index.d.mts

@@ -1,5 +1,6 @@
-import { DeepPartial, DeepRequired } from "@peiyanlu/ts-utils";
 import { log } from "@clack/prompts";
+import { DeepPartial, DeepRequired } from "@peiyanlu/ts-utils";
+import { ConventionalChangelog } from "conventional-changelog";
 
 //#region src/types.d.ts
 
@@ -24,7 +25,7 @@ interface ReleaseConfig {
   /** 使用 monorepo 时使用 toTag，例如 `${pkg}@${version}`，默认为 `v${version}` 作为单仓库 */
   toTag: (pkg: string, version: string) => string;
   /** 作为 CHANGELOG 标题的 Tag 前缀，多包场景下需要 `${pkg}@` */
-  changelogTagPrefix: ((pkg: string) => string | undefined) | undefined;
+  tagPrefix: ((pkg: string) => string | undefined) | undefined;
   /**
    * Git 相关配置
    * 影响提交、打 tag、推送等本地/远程 Git 行为。
@@ -88,14 +89,10 @@ interface ReleaseConfig {
      * 是否启用 npm 发布流程
      */
     publish: boolean | undefined;
-    /**
-     * npm 发布目标路径，对应 `npm publish <package-spec>`
-     */
-    publishPath: string;
     /**
      * 额外的 npm publish 参数（透传给 npm CLI）
      */
-    pushArgs: string[];
+    publishArgs: string[];
     /**
      * 是否跳过发布前检查（如 ping、whoami 等校验）
      */
@@ -155,4 +152,48 @@ declare function defineConfig(config: UserConfigFn): UserConfigFn;
 declare function defineConfig(config: UserConfigExport): UserConfigExport;
 declare const mergeConfig: <T extends object>(defaults: DeepRequired<T>, overrides?: DeepPartial<T>) => DeepRequired<T>;
 //#endregion
-export { type Logger, type UserConfig, defineConfig, mergeConfig };
+//#region src/git/changelog.d.ts
+interface Options {
+  /** @example () => `packages/${pkg}` */
+  getPkgDir: () => string;
+  /** @example `${pkg}@` */
+  tagPrefix?: string;
+}
+declare const createGenerator: ({
+  getPkgDir,
+  tagPrefix
+}: Options) => Promise<ConventionalChangelog>;
+declare const getChangelog: ({
+  getPkgDir,
+  tagPrefix
+}: Options) => Promise<string>;
+declare const generateChangelog: ({
+  getPkgDir,
+  tagPrefix
+}: Options) => Promise<void>;
+//#endregion
+//#region src/index.d.ts
+interface PublishTagOptions {
+  /**
+   * 支持通过命令行参数提供
+   * @example v1.0.0; pkg@1.0.1;
+   * @example my-cli v1.0.0;
+   */
+  gitTag?: string;
+  /** @defaults `@` */
+  tagSeparator?: string;
+  /**
+   * monorepo 仓库子包不使用 `pkg@version` 格式创建 tag 时需要指定
+   * @example pkg-demo
+   */
+  defaultPackage?: string;
+  /**
+   * @example (pkg) => `packages/${pkg}`; (pkg) => '.';
+   */
+  getPkgDir?: (pkg: string) => string;
+  /** npm Trusted Publishing（OIDC） */
+  provenance?: boolean;
+}
+declare const publishTagToNpm: (options: PublishTagOptions) => Promise<void>;
+//#endregion
+export { type Logger, type UserConfig, createGenerator, defineConfig, generateChangelog, getChangelog, mergeConfig, publishTagToNpm };

package/dist/index.mjs

@@ -1,5 +1,128 @@
+import { eol, getPackageInfo, getPublishedVersion, publishPackage } from "@peiyanlu/cli-utils";
+import { coerce, lt, parse, valid } from "semver";
+import { dim, green, underline, yellow } from "ansis";
+import { log } from "@clack/prompts";
 import { isPlainObject } from "@peiyanlu/ts-utils";
+import { createWriteStream, existsSync, readFileSync } from "node:fs";
+import { join } from "node:path";
+import { ConventionalChangelog } from "conventional-changelog";
+import createPreset from "conventional-changelog-conventionalcommits";
+import { writeFile } from "node:fs/promises";
+import { finished } from "node:stream/promises";
 
+//#region src/messages.ts
+const n = (b) => b ? "(dry run)" : "";
+const t = () => green(`${Math.floor(process.uptime())}s`);
+const MSG = {
+	INTRO: (dryRun) => `🚀  Starting release ${n(dryRun)}`,
+	OUTRO: (dryRun) => `🎉  Release finished successfully in ${t()} ${n(dryRun)}`,
+	OUTRO_PREPARE: (dryRun) => `🎉  PrepareRelease finished successfully in ${t()} ${n(dryRun)}`,
+	LOG: {
+		SHOW_VERSION: (version) => `🎉  Released ${green(version)}`,
+		SHOW_CHANGELOG: "🎉  Changelog collected",
+		CHANGELOG_EMPTY: "No commits found since last release",
+		CHANGES_EMPTY: "Working tree clean. No files changed"
+	},
+	CHECK: {
+		GIT: {
+			CHECKING: "Checking Git repository",
+			CHECKED: (name, url) => `Git remote resolved: ${url ? `${dim(name)} → ${underline(dim(url))}` : "not found"}`
+		},
+		NPM: {
+			CHECKING: "Checking npm registry",
+			CHECKED: (registry, msg) => `NPM registry: ${underline(dim(registry))} ${underline(dim(msg))}`
+		},
+		GITHUB: {
+			CHECKING: "Checking github repository",
+			CHECKED: (repository, msg) => `GitHub repository: ${underline(dim(repository))} ${underline(dim(msg))}`
+		}
+	},
+	TASK: {
+		VERSION: {
+			START: "Bumping version",
+			END: (to) => `Version bumped: ${underline(dim(to))}`
+		},
+		CHANGELOG: {
+			START: "Generating changelog",
+			END: `Changelog generated`
+		},
+		NPM: {
+			START: "Publishing npm package",
+			END: (url) => `NPM package published: ${underline(dim(url))}`
+		},
+		GIT: {
+			START: "Creating git commit, tag & push",
+			END: "Git commit, tag & push completed"
+		},
+		GITHUB: {
+			START: "Creating GitHub release",
+			END: (url) => `GitHub release created: ${underline(dim(url))}`
+		}
+	},
+	PROMPT: {
+		SELECT_PACKAGE: "Select package release:",
+		SELECT_VERSION: "Select version bump:",
+		INPUT_VERSION: "Enter custom version:",
+		NPM_PUBLISH: (pkg) => `Publish to npm ${underline(dim`(${pkg})`)}?`,
+		NPM_OTP: "Enter npm one-time password (OTP):",
+		GITHUB_RELEASE: (title) => `Create a new GitHub release ${underline(dim`(${title})`)}?`,
+		GIT_COMMIT: (msg) => `Create git commit ${underline(dim`(${msg})`)}?`,
+		GIT_TAG: (msg) => `Create git tag ${underline(dim`(${msg})`)}?`,
+		GIT_PUSH: "Push commits and tags to remote?"
+	},
+	ERROR: {
+		GIT_WORKDIR: `[git] Working dir must be clean`,
+		GIT_REGISTRY: (name) => `[git] Repository not found for ${dim(name)}`,
+		GIT_REMOTE: (name) => `[git] Remote "${dim(name)}" not found`,
+		GITHUB_TAG_EXIT: (tag) => `[github] Release or tag "${tag}" already exists`,
+		GITHUB_TOKEN: (tokenRef) => `[github] Missing GitHub token. Please set ${yellow(tokenRef ?? "GITHUB_TOKEN")}`,
+		GITHUB_AUTH: "[github] Invalid GitHub token or insufficient permissions",
+		GITHUB_USER: "[github] User does not have permission to create releases",
+		NPM_REGISTRY: (registry) => `[npm] Unable to reach npm registry ${underline(dim(registry))}`,
+		NPM_AUTH: `[npm] Not authenticated with npm. Please run ${yellow("npm login")} and try again.`,
+		NPM_USER: (user, name) => `[npm] User ${dim(user)} is not a collaborator of ${dim(name)}.`
+	},
+	ABORT: {
+		CANCEL: "Operation cancelled",
+		MONOREPO_CI_NO_PACKAGE: "CI mode requires a target package in monorepo. Please specify it via \"--package <pkg>\"",
+		MONOREPO_NO_PACKAGES: "Monorepo detected, but no packages found. Please configure \"config.packages\""
+	},
+	INFO: {
+		TOOL: (name, version) => `${name} ${dim(`v${version}`)}`,
+		CONFIG: (path) => `config file: ${underline(dim(path || "not found"))}`
+	}
+};
+
+//#endregion
+//#region src/version/bump.ts
+const isValid = (version) => {
+	return Boolean(valid(version));
+};
+const parseVersion = (raw) => {
+	const next = isValid(raw) ? raw : coerce(raw)?.toString();
+	if (!next) return {};
+	const { prerelease } = parse(next);
+	const toPreRelease = Boolean(prerelease.length);
+	const [preId, preBase] = prerelease.map(String);
+	return {
+		next,
+		toPreRelease,
+		preId,
+		preBase
+	};
+};
+
+//#endregion
+//#region src/npm/publish.ts
+const resolvePublishTag = async (pkgName, version) => {
+	const { toPreRelease, preId } = parseVersion(version);
+	if (toPreRelease) return preId || "next";
+	const active = await getPublishedVersion(pkgName);
+	if (!active) return "latest";
+	return lt(version, active) ? "previous" : "latest";
+};
+
+//#endregion
 //#region src/config.ts
 function defineConfig(config) {
 	return config;
@@ -22,4 +145,218 @@ const mergeConfig = (defaults, overrides) => {
 };
 
 //#endregion
-export { defineConfig, mergeConfig };
+//#region src/git/changetype.ts
+const defaultTypes = [
+	{
+		type: "feat",
+		section: "✨ 新功能",
+		description: "新增功能"
+	},
+	{
+		type: "feature",
+		section: "✨ 新功能",
+		description: "新增功能"
+	},
+	{
+		type: "fix",
+		section: "🐛 Bug 修复",
+		description: "修复 bug"
+	},
+	{
+		type: "perf",
+		section: "⚡ 性能优化",
+		description: "提升性能"
+	},
+	{
+		type: "revert",
+		section: "⏪ 回退",
+		description: "回退到之前版本"
+	},
+	{
+		type: "docs",
+		section: "📝 文档",
+		description: "文档更新"
+	},
+	{
+		type: "style",
+		section: "💄 样式调整",
+		description: "样式或格式修改"
+	},
+	{
+		type: "chore",
+		section: "🎫 其他更新",
+		description: "非功能性更改"
+	},
+	{
+		type: "refactor",
+		section: "♻ 代码重构",
+		description: "重构代码"
+	},
+	{
+		type: "test",
+		section: "✅ 测试",
+		description: "测试更新"
+	},
+	{
+		type: "build",
+		section: "👷‍ 构建系统",
+		description: "构建工具和系统修改"
+	},
+	{
+		type: "ci",
+		section: "🔧 CI 配置",
+		description: "持续集成配置"
+	},
+	{
+		type: "config",
+		section: "🔨 配置",
+		description: "配置文件更新"
+	},
+	{
+		type: "deps",
+		section: "🔗 依赖更新",
+		description: "依赖版本变更"
+	},
+	{
+		type: "security",
+		section: "🔒 安全修复",
+		description: "安全性更新"
+	},
+	{
+		type: "i18n",
+		section: "🌐 国际化",
+		description: "国际化相关更新"
+	},
+	{
+		type: "ux",
+		section: "🖥️ 用户体验",
+		description: "用户体验改进"
+	},
+	{
+		type: "hotfix",
+		section: "🔥 热修复",
+		description: "紧急修复"
+	}
+];
+
+//#endregion
+//#region src/git/changelog.ts
+const createGenerator = async ({ getPkgDir, tagPrefix }) => {
+	const pkgDir = getPkgDir();
+	const preset = await createPreset({ types: defaultTypes.map((t$1) => ({
+		...t$1,
+		hidden: false
+	})) });
+	preset.writer ??= {};
+	preset.writer.headerPartial = `
+## {{#if isPatch~}} <small> {{~/if~}}
+{{#if @root.linkCompare~}}
+[{{version}}](
+{{~#if @root.repository~}}
+  {{~#if @root.host}}
+    {{~@root.host}}/
+  {{~/if}}
+  {{~#if @root.owner}}
+    {{~@root.owner}}/
+  {{~/if}}
+  {{~@root.repository}}
+{{~else}}
+  {{~@root.repoUrl}}
+{{~/if~}}
+/compare/{{previousTag}}...{{currentTag}})
+{{~else}}
+{{~version}}
+{{~/if}}
+{{~#if title}} "{{title}}"
+{{~/if}}
+{{~#if date}} ({{date}})
+{{~/if}}
+{{~#if isPatch~}} </small> {{~/if}}
+`.trim() + eol();
+	preset.writer.mainTemplate = `
+{{> header}}
+{{#if noteGroups}}
+{{#each noteGroups}}
+
+### ⚠ {{title}}
+
+{{#each notes}}
+* {{#if commit.scope}}**{{commit.scope}}:** {{/if}}{{commit.subject}} {{#if commit.hash}}([{{commit.shortHash}}](https://github.com/{{@root.owner}}/{{@root.repository}}/commit/{{commit.hash}})){{/if}}
+{{/each}}
+{{/each}}
+{{/if}}
+{{#each commitGroups}}
+
+{{#if title}}
+### {{title}}
+
+{{/if}}
+{{#each commits}}
+{{> commit root=@root}}
+{{/each}}
+{{/each}}`.trim() + eol(2);
+	return new ConventionalChangelog().readPackage(`${pkgDir}/package.json`).config(preset).options({ releaseCount: 1 }).commits({ path: pkgDir }).tags({ prefix: tagPrefix });
+};
+const getChangelog = async ({ getPkgDir, tagPrefix }) => {
+	const generator = await createGenerator({
+		getPkgDir,
+		tagPrefix
+	});
+	let changelog = "";
+	for await (const chunk of generator.write()) changelog += chunk;
+	return changelog;
+};
+const generateChangelog = async ({ getPkgDir, tagPrefix }) => {
+	const infile = join(getPkgDir(), "CHANGELOG.md");
+	if (!existsSync(infile)) await writeFile(infile, "");
+	const originalChangelog = readFileSync(infile, "utf-8");
+	const generator = await createGenerator({
+		getPkgDir,
+		tagPrefix
+	});
+	const writeStream = createWriteStream(infile);
+	for await (const chunk of generator.write()) writeStream.write(chunk);
+	writeStream.write(originalChangelog);
+	writeStream.end();
+	await finished(writeStream);
+};
+
+//#endregion
+//#region src/index.ts
+const publishTagToNpm = async (options) => {
+	const { gitTag, defaultPackage, tagSeparator = "@", getPkgDir = () => ".", provenance } = options;
+	const tag = process.argv.slice(2)[0] || gitTag;
+	if (!tag) throw new Error(`❌ No git tag specified.`);
+	console.log(`\n📦 Start publishing from git tag: ${tag}`);
+	let pkgName = defaultPackage;
+	let version;
+	if (tag.includes(tagSeparator)) {
+		[pkgName, version] = tag.split(tagSeparator);
+		console.log(`🔍 Parsed tag → package: "${pkgName}", version: "${version}"`);
+	} else {
+		version = tag;
+		console.log(`🔍 Parsed tag → version only: "${version}"`);
+	}
+	if (version.startsWith("v")) {
+		version = version.slice(1);
+		console.log(`✂️  Normalized version (strip v): ${version}`);
+	}
+	if (!pkgName) throw new Error(`❌ Package name should be specified in tag "${tag}" when defaultPackage is not set`);
+	console.log(`📁 Resolving package info for "${pkgName}"...`);
+	const { pkg, pkgDir } = getPackageInfo(pkgName, getPkgDir);
+	console.log(`📄 package.json → name: ${pkg.name}, version: ${pkg.version}`);
+	console.log(`📂 Package directory: ${pkgDir}`);
+	if (pkg.version !== version) throw new Error(`❌ Package version from tag "${version}" mismatches with current version "${pkg.version}"`);
+	const publishTag = await resolvePublishTag(pkg.name, version);
+	console.log(`🏷 Resolved npm dist-tag: "${publishTag}" (version ${version})`);
+	console.log(`🚀 Publishing "${pkg.name}@${version}" to npm...`);
+	await publishPackage({
+		tag: publishTag,
+		args: provenance ? ["--provenance"] : [],
+		cwd: pkgDir
+	});
+	console.log(`✅ Successfully published ${pkg.name}@${version} with dist-tag "${publishTag}"\n`);
+};
+
+//#endregion
+export { createGenerator, defineConfig, generateChangelog, getChangelog, mergeConfig, publishTagToNpm };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peiyanlu/release",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Release project tool.",
   "license": "MIT",
   "type": "module",
@@ -14,19 +14,13 @@
         "types": "./dist/index.d.mts",
         "default": "./dist/index.mjs"
       }
-    }
-  },
-  "scripts": {
-    "dev": "tsdown -w",
-    "build": "tsdown",
-    "prepublish": "tsdown",
-    "test": "vitest run",
-    "release": "tsdown && node index.js"
+    },
+    "./package.json": "./package.json"
   },
   "dependencies": {
     "@clack/prompts": "^0.11.0",
     "@octokit/rest": "^22.0.1",
-    "@peiyanlu/cli-utils": "^0.0.4",
+    "@peiyanlu/cli-utils": "^0.0.6",
     "@peiyanlu/ts-utils": "^0.0.4",
     "ansis": "^4.2.0",
     "commander": "^14.0.2",
@@ -42,9 +36,10 @@
     "@types/mime-types": "^3.0.1",
     "@types/node": "^24.10.3",
     "@types/semver": "^7.7.1",
+    "@vitest/coverage-v8": "^4.0.15",
     "tsdown": "^0.18.4",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.15"
+    "vitest": "^4.0.18"
   },
   "author": {
     "name": "YanluPei",
@@ -71,5 +66,13 @@
   "bugs": {
     "url": "https://github.com/peiyanlu/release/issues"
   },
-  "homepage": "https://github.com/peiyanlu/release#readme"
-}
+  "homepage": "https://github.com/peiyanlu/release#readme",
+  "scripts": {
+    "dev": "tsdown -w",
+    "build": "tsdown",
+    "prepublish": "tsdown",
+    "release": "node index.js",
+    "test": "vitest run",
+    "test:cov": "vitest run --coverage"
+  }
+}