@coze-arch/rush-publish-plugin 0.0.1-alpha.4a0c61

package/lib/action/release/package.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyPublishConfig = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_enhance_1 = require("@coze-arch/fs-enhance");
+const get_rush_config_1 = require("../../utils/get-rush-config");
+/**
+ * 更新依赖版本
+ */
+const updateDependencyVersions = async (packageJson) => {
+    const rushConfiguration = (0, get_rush_config_1.getRushConfiguration)();
+    const { dependencies } = packageJson;
+    if (dependencies) {
+        for (const [dep, ver] of Object.entries(dependencies)) {
+            const project = rushConfiguration.getProjectByName(dep);
+            if (/^workspace:/.test(ver) && project) {
+                dependencies[dep] = project.packageJson.version;
+            }
+        }
+    }
+    return Promise.resolve(packageJson);
+};
+const applyCozePublishConfig = async (packageJson) => {
+    const { cozePublishConfig } = packageJson;
+    if (cozePublishConfig) {
+        const keys = Object.keys(cozePublishConfig);
+        for (const key of keys) {
+            packageJson[key] = cozePublishConfig[key];
+        }
+    }
+    return Promise.resolve(packageJson);
+};
+const applyPublishConfig = async (project) => {
+    const jobs = [
+        updateDependencyVersions,
+        applyCozePublishConfig,
+    ];
+    const packageJsonPath = path_1.default.join(project.projectFolder, 'package.json');
+    let packageJson = await (0, fs_enhance_1.readJsonFile)(packageJsonPath);
+    for (const job of jobs) {
+        packageJson = await job(packageJson);
+    }
+    await (0, fs_enhance_1.writeJsonFile)(packageJsonPath, packageJson);
+};
+exports.applyPublishConfig = applyPublishConfig;
+//# sourceMappingURL=package.js.map

package/lib/action/release/plan.d.ts

@@ -0,0 +1,8 @@
+import { type ReleaseManifest } from './types';
+export declare enum ReleaseType {
+    ALPHA = "alpha",
+    BETA = "beta",
+    LATEST = "latest"
+}
+export declare const calReleaseType: (version: string) => ReleaseType;
+export declare const checkReleasePlan: (releaseManifests: ReleaseManifest[], branchName: string) => boolean;

package/lib/action/release/plan.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkReleasePlan = exports.calReleaseType = exports.ReleaseType = void 0;
+var ReleaseType;
+(function (ReleaseType) {
+    ReleaseType["ALPHA"] = "alpha";
+    ReleaseType["BETA"] = "beta";
+    ReleaseType["LATEST"] = "latest";
+})(ReleaseType || (exports.ReleaseType = ReleaseType = {}));
+const calReleaseType = (version) => {
+    const tag = version.includes('alpha')
+        ? ReleaseType.ALPHA
+        : version.includes('beta')
+            ? ReleaseType.BETA
+            : ReleaseType.LATEST;
+    return tag;
+};
+exports.calReleaseType = calReleaseType;
+const calReleasePlan = (releaseManifests) => {
+    const plan = releaseManifests.map(r => (0, exports.calReleaseType)(r.version));
+    if (plan.some(p => p === ReleaseType.LATEST)) {
+        return ReleaseType.LATEST;
+    }
+    if (plan.some(p => p === ReleaseType.BETA)) {
+        return ReleaseType.BETA;
+    }
+    return ReleaseType.ALPHA;
+};
+const checkReleasePlan = (releaseManifests, branchName) => {
+    const releasePlan = calReleasePlan(releaseManifests);
+    if (releasePlan === ReleaseType.LATEST &&
+        !['main', 'feat/auto-publish'].includes(branchName)) {
+        throw new Error('For LATEST release, should be on main branch only.');
+    }
+    return true;
+};
+exports.checkReleasePlan = checkReleasePlan;
+//# sourceMappingURL=plan.js.map

package/lib/action/release/release.d.ts

@@ -0,0 +1,2 @@
+import { type ReleaseOptions, type ReleaseManifest } from './types';
+export declare const releasePackages: (releaseManifests: ReleaseManifest[], releaseOptions: ReleaseOptions) => Promise<void>;

package/lib/action/release/release.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.releasePackages = void 0;
+const logger_1 = require("@coze-arch/logger");
+const exec_1 = require("../../utils/exec");
+const package_1 = require("./package");
+/**
+ * 发布包
+ */
+const publishPackage = async (project, releaseOptions) => {
+    const { dryRun, registry } = releaseOptions;
+    const token = process.env.NPM_AUTH_TOKEN;
+    const { version } = project.packageJson;
+    const tag = version.includes('alpha')
+        ? 'alpha'
+        : version.includes('beta')
+            ? 'beta'
+            : 'latest';
+    const args = [`NPM_AUTH_TOKEN=${token}`, 'npm', 'publish', `--tag ${tag}`];
+    if (dryRun) {
+        args.push('--dry-run');
+    }
+    if (registry) {
+        args.push(`--registry=${registry}`);
+    }
+    await (0, exec_1.exec)(args.join(' '), {
+        cwd: project.projectFolder,
+    });
+    logger_1.logger.success(`- Published ${project.packageName}@${version}`);
+};
+const releasePackage = async (releaseManifest, releaseOptions) => {
+    const { project } = releaseManifest;
+    const { packageName } = project;
+    logger_1.logger.info(`Preparing release for package: ${packageName}`);
+    await (0, package_1.applyPublishConfig)(project);
+    await publishPackage(project, releaseOptions);
+};
+const buildProjects = async (releaseManifests) => {
+    const packageNames = releaseManifests.map(manifest => manifest.project.packageName);
+    const buildCommands = `rush build ${packageNames.map(name => `--to ${name}`).join(' ')}`;
+    await (0, exec_1.exec)(buildCommands);
+};
+const releasePackages = async (releaseManifests, releaseOptions) => {
+    await buildProjects(releaseManifests);
+    await Promise.all(releaseManifests.map(async (manifest) => {
+        await releasePackage(manifest, releaseOptions);
+    }));
+};
+exports.releasePackages = releasePackages;
+//# sourceMappingURL=release.js.map

package/lib/action/release/types.d.ts

@@ -0,0 +1,14 @@
+import { type RushConfigurationProject } from '@rushstack/rush-sdk';
+export interface ReleaseOptions {
+    commit: string;
+    dryRun?: boolean;
+    registry: string;
+}
+export interface PackageToPublish {
+    packageName: string;
+    version: string;
+}
+export interface ReleaseManifest {
+    project: RushConfigurationProject;
+    version: string;
+}

package/lib/action/release/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/generate-changelog/generate-changelog.d.ts

@@ -0,0 +1,49 @@
+interface ChangeLogComment {
+    comment: string;
+    author?: string;
+    commit?: string;
+    customFields?: Record<string, string>;
+}
+interface ChangeLogEntry {
+    version: string;
+    tag: string;
+    date: string;
+    comments: {
+        major?: ChangeLogComment[];
+        minor?: ChangeLogComment[];
+        patch?: ChangeLogComment[];
+        dependency?: ChangeLogComment[];
+        none?: ChangeLogComment[];
+    };
+}
+export interface ChangeLog {
+    name: string;
+    entries: ChangeLogEntry[];
+}
+interface Change {
+    packageName: string;
+    comment: string;
+    type: 'none' | 'dependency' | 'patch' | 'minor' | 'major';
+    customFields?: Record<string, string>;
+}
+export interface ChangeFile {
+    changes: Change[];
+    packageName: string;
+    email?: string;
+}
+interface GenerateChangelogOptions {
+    packageName: string;
+    version: string;
+    commingChanges: ChangeFile[];
+    previousChangelog?: ChangeLog;
+    defaultChangelog?: string;
+    tag?: string;
+}
+/**
+ * Merge and generate changelog
+ */
+export declare const generateChangelog: ({ commingChanges, previousChangelog, version, packageName, tag, defaultChangelog, }: GenerateChangelogOptions) => {
+    changelog: ChangeLog;
+    report: string;
+};
+export {};

package/lib/generate-changelog/generate-changelog.js

@@ -0,0 +1,127 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateChangelog = void 0;
+const semver_1 = __importDefault(require("semver"));
+const dayjs_1 = __importDefault(require("dayjs"));
+/**
+ * Convert change type to corresponding title
+ */
+const getChangeTypeTitle = (type) => {
+    switch (type) {
+        case 'major':
+            return '### Breaking Changes';
+        case 'minor':
+            return '### New Features';
+        case 'patch':
+            return '### Bug Fixes';
+        case 'dependency':
+            return '### Dependencies';
+        case 'none':
+            return '### Other Changes';
+        default:
+            return '';
+    }
+};
+/**
+ * Generate changelog for a single version
+ */
+const generateVersionChangelog = ({ version, changes, tag, defaultChangelog, }) => {
+    // Group changes by type
+    const groupedChanges = changes.length > 0
+        ? changes.reduce((acc, change) => {
+            const { type, comment, customFields } = change;
+            if (!acc[type]) {
+                acc[type] = [];
+            }
+            const node = acc[type];
+            if (node.some(existing => existing.comment === comment) === false) {
+                node.push({
+                    comment,
+                    customFields,
+                });
+            }
+            return acc;
+        }, {})
+        : { none: [{ comment: defaultChangelog }] };
+    return {
+        version,
+        tag,
+        date: (0, dayjs_1.default)().toISOString(),
+        comments: groupedChanges,
+    };
+};
+/**
+ * Convert changelog to Markdown format
+ */
+const changelogToMarkdown = (changelog) => {
+    const lines = [];
+    lines.push(`# ${changelog.name}`);
+    lines.push('');
+    changelog.entries.forEach(entry => {
+        lines.push(`## ${entry.version} - ${(0, dayjs_1.default)(entry.date).format('YYYY-MM-DD')}`);
+        lines.push('');
+        // Output different types of changes in fixed order
+        const typeOrder = [
+            'major',
+            'minor',
+            'patch',
+            'dependency',
+            'none',
+        ];
+        typeOrder.forEach(type => {
+            const changes = entry.comments[type];
+            if (changes?.length) {
+                lines.push(getChangeTypeTitle(type));
+                lines.push('');
+                changes.forEach(change => {
+                    lines.push(`- ${change.comment}`);
+                    // Add custom fields to changelog if they exist
+                    if (change.customFields) {
+                        Object.entries(change.customFields).forEach(([key, value]) => {
+                            lines.push(`  - ${key}: ${value}`);
+                        });
+                    }
+                });
+                lines.push('');
+            }
+        });
+        lines.push('');
+    });
+    return lines.join('\n');
+};
+/**
+ * Merge and generate changelog
+ */
+const generateChangelog = ({ commingChanges, previousChangelog, version, packageName, tag, defaultChangelog = 'Publish for noop', }) => {
+    // Create new changelog entry
+    const newEntry = generateVersionChangelog({
+        version,
+        changes: commingChanges.flatMap(r => r.changes),
+        tag: tag || 'HEAD',
+        defaultChangelog,
+    });
+    const allEntries = (previousChangelog ? [newEntry, ...previousChangelog.entries] : [newEntry]).sort((a, b) => {
+        // Handle invalid version numbers
+        if (!semver_1.default.valid(a.version) || !semver_1.default.valid(b.version)) {
+            return 0;
+        }
+        // Use semver.rcompare for descending sort (newer versions first)
+        return semver_1.default.rcompare(a.version, b.version);
+    });
+    // Merge with existing changelog
+    const changelog = {
+        name: packageName,
+        entries: allEntries,
+    };
+    // Convert to markdown
+    const markdown = changelogToMarkdown(changelog);
+    return {
+        changelog,
+        report: markdown,
+    };
+};
+exports.generateChangelog = generateChangelog;
+//# sourceMappingURL=generate-changelog.js.map

package/lib/index.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const commander_1 = require("commander");
+const release_1 = require("./action/release");
+const publish_1 = require("./action/publish");
+const change_1 = require("./action/change");
+const main = () => {
+    const packageJson = JSON.parse(fs_1.default.readFileSync(path_1.default.resolve(__dirname, '../package.json'), 'utf8'));
+    const program = new commander_1.Command();
+    program
+        .name(packageJson.name)
+        .description(packageJson.description)
+        .version(packageJson.version)
+        .showSuggestionAfterError(true)
+        .showHelpAfterError(true);
+    const actions = [change_1.installAction, release_1.installAction, publish_1.installAction];
+    actions.forEach(a => {
+        a(program);
+    });
+    program.parse();
+};
+main();
+//# sourceMappingURL=index.js.map

package/lib/types.d.ts

@@ -0,0 +1,2 @@
+import { type Command } from 'commander';
+export type InstallAction = (program: Command) => void;

package/lib/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/utils/exec.d.ts

@@ -0,0 +1,7 @@
+import { type ExecOptions } from 'shelljs';
+export interface ExecResult {
+    code: number;
+    stdout: string;
+    stderr: string;
+}
+export declare const exec: (cmd: string, options?: ExecOptions) => Promise<ExecResult>;

package/lib/utils/exec.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exec = void 0;
+const shelljs_1 = require("shelljs");
+class ExecError extends Error {
+    constructor(result) {
+        super(result.stderr || result.stdout);
+        this.code = result.code;
+        this.stderr = result.stderr;
+        this.stdout = result.stdout;
+    }
+}
+const exec = (cmd, options = { silent: true }) => new Promise((r, j) => {
+    (0, shelljs_1.exec)(cmd, options, (code, stdout, stderr) => {
+        if (code === 0) {
+            r({ code, stdout, stderr });
+        }
+        else {
+            j(new ExecError({ code, stderr, stdout }));
+        }
+    });
+});
+exports.exec = exec;
+//# sourceMappingURL=exec.js.map

package/lib/utils/get-rush-config.d.ts

@@ -0,0 +1,2 @@
+import { RushConfiguration } from '@rushstack/rush-sdk';
+export declare const getRushConfiguration: (useCache?: boolean) => RushConfiguration;

package/lib/utils/get-rush-config.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRushConfiguration = void 0;
+const rush_sdk_1 = require("@rushstack/rush-sdk");
+exports.getRushConfiguration = (() => {
+    let rushConfiguration = null;
+    return (useCache = true) => {
+        if (!useCache) {
+            rushConfiguration = null;
+        }
+        return (rushConfiguration || (rushConfiguration = rush_sdk_1.RushConfiguration.loadFromDefaultLocation({
+            startingFolder: process.cwd(),
+        })));
+    };
+})();
+//# sourceMappingURL=get-rush-config.js.map

package/lib/utils/git.d.ts

@@ -0,0 +1,19 @@
+export declare const getChangedFilesFromCached: () => Promise<string[]>;
+/**
+ * 获取当前分支名称
+ * @returns string
+ */
+export declare const getCurrentBranchName: () => Promise<string>;
+export declare const isMainBranch: () => Promise<boolean>;
+export declare const getChangedFiles: () => Promise<string[]>;
+/**
+ * 确保没有未提交的变更
+ */
+export declare const ensureNotUncommittedChanges: () => Promise<boolean>;
+/**
+ * 获取当前 Git 仓库设置的 origin 远程源地址
+ * @param cwd 当前工作目录
+ * @returns origin 远程源地址
+ */
+export declare const getCurrentOrigin: (cwd?: string) => Promise<string | undefined>;
+export declare const convertGitSchemaToHttp: (gitUrl: string) => string;

package/lib/utils/git.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertGitSchemaToHttp = exports.getCurrentOrigin = exports.ensureNotUncommittedChanges = exports.getChangedFiles = exports.isMainBranch = exports.getCurrentBranchName = exports.getChangedFilesFromCached = void 0;
+const exec_1 = require("./exec");
+const serializeFilesName = (output) => output
+    .split('\n')
+    .map(line => {
+    if (line) {
+        const trimmedLine = line.trim();
+        return trimmedLine;
+    }
+    return '';
+})
+    .filter(line => line && line.length > 0);
+const getChangedFilesFromCached = async () => {
+    const output = await (0, exec_1.exec)('git diff --name-only --diff-filter=ACMR --cached');
+    if (!output) {
+        return [];
+    }
+    return serializeFilesName(output.stdout);
+};
+exports.getChangedFilesFromCached = getChangedFilesFromCached;
+/**
+ * 获取当前分支名称
+ * @returns string
+ */
+const getCurrentBranchName = async () => {
+    const { stdout } = await (0, exec_1.exec)('git rev-parse --abbrev-ref HEAD');
+    return stdout.trim();
+};
+exports.getCurrentBranchName = getCurrentBranchName;
+const isMainBranch = async () => {
+    const currentBranchName = await (0, exports.getCurrentBranchName)();
+    return currentBranchName === 'main';
+};
+exports.isMainBranch = isMainBranch;
+const getChangedFiles = async () => {
+    const output = await (0, exec_1.exec)('git diff --name-only --diff-filter=ACMR');
+    return serializeFilesName(output.stdout);
+};
+exports.getChangedFiles = getChangedFiles;
+/**
+ * 确保没有未提交的变更
+ */
+const ensureNotUncommittedChanges = async () => {
+    const changedFiles = (await Promise.all([(0, exports.getChangedFilesFromCached)(), (0, exports.getChangedFiles)()])).flat();
+    if (changedFiles.length > 0) {
+        throw new Error('There are uncommitted changes in the working tree, please commit them first.');
+    }
+    return true;
+};
+exports.ensureNotUncommittedChanges = ensureNotUncommittedChanges;
+/**
+ * 获取当前 Git 仓库设置的 origin 远程源地址
+ * @param cwd 当前工作目录
+ * @returns origin 远程源地址
+ */
+const getCurrentOrigin = async (cwd = process.cwd()) => {
+    try {
+        const { stdout } = await (0, exec_1.exec)('git remote get-url origin', { cwd });
+        return stdout.trim();
+    }
+    catch (error) {
+        return undefined;
+    }
+};
+exports.getCurrentOrigin = getCurrentOrigin;
+const convertGitSchemaToHttp = (gitUrl) => gitUrl.replace('git@', 'https://').replace(':', '/').replace('.git', '');
+exports.convertGitSchemaToHttp = convertGitSchemaToHttp;
+//# sourceMappingURL=git.js.map

package/lib/utils/random.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 生成指定长度的随机字符串(使用 crypto 模块)
+ * @param digit 字符串长度
+ * @returns 随机字符串
+ */
+export declare function randomHash(digit: number): string;

package/lib/utils/random.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.randomHash = randomHash;
+const crypto_1 = __importDefault(require("crypto"));
+/**
+ * 生成指定长度的随机字符串(使用 crypto 模块)
+ * @param digit 字符串长度
+ * @returns 随机字符串
+ */
+function randomHash(digit) {
+    return crypto_1.default
+        .randomBytes(Math.ceil(digit / 2))
+        .toString('hex')
+        .slice(0, digit);
+}
+//# sourceMappingURL=random.js.map

package/lib/utils/whoami.d.ts

@@ -0,0 +1,4 @@
+export declare const whoAmI: () => Promise<{
+    name: string;
+    email: string;
+}>;

package/lib/utils/whoami.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.whoAmI = void 0;
+const exec_1 = require("./exec");
+const whoAmI = async () => {
+    const [name, email] = await Promise.all([
+        (0, exec_1.exec)('git config user.name', { cwd: __dirname, silent: true }),
+        (0, exec_1.exec)('git config user.email', { cwd: __dirname, silent: true }),
+    ]);
+    return {
+        name: name.stdout.toString().replace('\n', ''),
+        email: email.stdout.toString().replace('\n', ''),
+    };
+};
+exports.whoAmI = whoAmI;
+//# sourceMappingURL=whoami.js.map

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@coze-arch/rush-publish-plugin",
+  "version": "0.0.1-alpha.4a0c61",
+  "description": "rush plugin to generate change log and publish packages",
+  "keywords": [
+    "rush",
+    "plugin",
+    "command",
+    "release",
+    "publish"
+  ],
+  "license": "ISC",
+  "author": "tecvan.fe@gmail.com",
+  "maintainers": [],
+  "main": "./lib/index.js",
+  "bin": {
+    "rush-publish": "./lib/index.js"
+  },
+  "files": [
+    "lib",
+    "!**/*.tsbuildinfo",
+    "!**/*.map",
+    "command-line.json",
+    "rush-plugin-manifest.json"
+  ],
+  "scripts": {
+    "build": "tsc -b tsconfig.build.json",
+    "lint": "eslint ./ --cache",
+    "test": "vitest --run --passWithNoTests",
+    "test:cov": "npm run test -- --coverage"
+  },
+  "dependencies": {
+    "@coze-arch/fs-enhance": "0.0.1",
+    "@coze-arch/logger": "0.0.1",
+    "@inquirer/prompts": "^3.2.0",
+    "@rushstack/rush-sdk": "^5.150.0",
+    "chalk": "^4.1.2",
+    "conventional-changelog-angular": "^5.0.13",
+    "conventional-commits-parser": "^3.2.4",
+    "dayjs": "^1.11.13",
+    "open": "~10.1.0",
+    "semver": "^7.7.1",
+    "shelljs": "^0.9.2"
+  },
+  "devDependencies": {
+    "@commitlint/types": "^17.4.0",
+    "@coze-arch/eslint-config": "workspace:*",
+    "@coze-arch/ts-config": "workspace:*",
+    "@coze-arch/vitest-config": "workspace:*",
+    "@types/node": "^22.13.13",
+    "@types/semver": "^7.5.8",
+    "@types/shelljs": "^0.8.15",
+    "@vitest/coverage-v8": "^3.0.9",
+    "commander": "^13.1.0",
+    "sucrase": "^3.32.0",
+    "tsx": "^4.19.3",
+    "vitest": "^3.0.9"
+  },
+  "peerDependencies": {
+    "commander": "^13.1.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "cozePublishConfig": {
+    "bin": {
+      "rush-publish": "./lib/index.js"
+    },
+    "main": "./lib/index.js"
+  }
+}

package/rush-plugin-manifest.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/rush-plugin-manifest.schema.json",
+  "plugins": [
+    {
+      "pluginName": "@coze-arch/rush-publish-plugin",
+      "description": "rush plugin to generate change log and publish packages",
+      "commandLineJsonFilePath": "./command-line.json"
+    }
+  ]
+}