chore: rush plugin for generate change logs

Author: fanwenjie

common/_templates/node-core/package.json

@@ -19,7 +19,7 @@
     "@coze-infra/vitest-config": "workspace:*",
     "@types/node": "^22.13.13",
     "@vitest/coverage-v8": "^3.0.9",
-    "tsx": "^4.19.2",
+    "tsx": "^4.19.3",
     "vitest": "^3.0.9"
   }
 }

common/_templates/rush-plugin/package.json

@@ -19,7 +19,7 @@
     "@coze-infra/vitest-config": "workspace:*",
     "@types/node": "^22.13.13",
     "@vitest/coverage-v8": "^3.0.9",
-    "tsx": "^4.19.2",
+    "tsx": "^4.19.3",
     "vitest": "^3.0.9"
   }
 }

common/config/subspaces/default/pnpm-lock.yaml

@@ -0,0 +1 @@
+# @coze-infra/rush-change-plugin

packages/rush-plugins/change/README.md

@@ -0,0 +1,111 @@
+import path from 'path';
+import fs from 'fs/promises';
+
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { logger } from '@coze-infra/rush-logger';
+
+import * as helper from '../helper';
+import * as amendCommit from '../amend-commit';
+import { generateChangeFiles } from '../action';
+import * as projectAnalyzer from '../../../utils/project-analyzer';
+
+// Mock all dependencies
+vi.mock('fs/promises');
+vi.mock('path');
+vi.mock('@coze-infra/rush-logger');
+vi.mock('../helper');
+vi.mock('../amend-commit');
+vi.mock('../../../utils/project-analyzer');
+
+describe('generateChangeFiles', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+    // Reset environment variables
+    delete process.env.CI;
+  });
+
+  it('should do nothing in CI environment', async () => {
+    process.env.CI = 'true';
+    await generateChangeFiles({ ci: false });
+    expect(helper.analysisCommitMsg).not.toHaveBeenCalled();
+  });
+
+  it('should do nothing when ci option is true', async () => {
+    await generateChangeFiles({ ci: true });
+    expect(helper.analysisCommitMsg).not.toHaveBeenCalled();
+  });
+
+  it('should handle amend commit option', async () => {
+    await generateChangeFiles({ amendCommit: true });
+    expect(amendCommit.amendCommit).toHaveBeenCalled();
+    expect(helper.analysisCommitMsg).not.toHaveBeenCalled();
+  });
+
+  it('should read commit message from file when not provided', async () => {
+    const mockCommitMsg = 'feat: test commit';
+    const mockRushConfig = {
+      rushJsonFolder: '/test/path',
+    };
+
+    vi.mocked(projectAnalyzer.getRushConfiguration).mockReturnValue(
+      mockRushConfig as any,
+    );
+    vi.mocked(fs.readFile).mockResolvedValue(mockCommitMsg);
+    vi.mocked(helper.analysisCommitMsg).mockResolvedValue({
+      content: 'test commit',
+      type: 'minor',
+    });
+
+    await generateChangeFiles({});
+
+    expect(fs.readFile).toHaveBeenCalledWith(
+      path.resolve('/test/path', '.git/COMMIT_EDITMSG'),
+      'utf-8',
+    );
+    expect(helper.analysisCommitMsg).toHaveBeenCalledWith(mockCommitMsg);
+    expect(helper.generateAllChangesFile).toHaveBeenCalledWith(
+      'test commit',
+      'minor',
+    );
+  });
+
+  it('should use provided commit message', async () => {
+    const mockCommitMsg = 'feat: direct commit';
+    vi.mocked(helper.analysisCommitMsg).mockResolvedValue({
+      content: 'direct commit',
+      type: 'minor',
+    });
+
+    await generateChangeFiles({ commitMsg: mockCommitMsg });
+
+    expect(fs.readFile).not.toHaveBeenCalled();
+    expect(helper.analysisCommitMsg).toHaveBeenCalledWith(mockCommitMsg);
+    expect(helper.generateAllChangesFile).toHaveBeenCalledWith(
+      'direct commit',
+      'minor',
+    );
+  });
+
+  it('should handle invalid commit message', async () => {
+    vi.mocked(helper.analysisCommitMsg).mockResolvedValue({
+      content: '',
+      type: 'minor',
+    });
+
+    await generateChangeFiles({ commitMsg: 'invalid commit' });
+
+    expect(logger.warning).toHaveBeenCalledWith('Invalid subject');
+    expect(helper.generateAllChangesFile).not.toHaveBeenCalled();
+  });
+
+  it('should handle errors', async () => {
+    const error = new Error('Test error');
+    vi.mocked(helper.analysisCommitMsg).mockRejectedValue(error);
+
+    await generateChangeFiles({ commitMsg: 'test commit' });
+
+    expect(logger.error).toHaveBeenCalledWith(
+      `Generate changes file fail \n ${error}`,
+    );
+  });
+});

packages/rush-plugins/change/__tests__/.gitkeep

@@ -0,0 +1,112 @@
+import path from 'path';
+
+import { describe, it, expect, vi, beforeEach, type Mock } from 'vitest';
+
+import { amendCommit } from '../amend-commit';
+import * as projectAnalyzer from '../../../utils/project-analyzer';
+import * as gitCommand from '../../../utils/git-command';
+import { exec } from '../../../utils/exec';
+
+// Mock all dependencies
+vi.mock('path', () => ({ default: { relative: vi.fn() } }));
+vi.mock('../../../utils/git-command');
+vi.mock('../../../utils/project-analyzer');
+vi.mock('../../../utils/exec', () => ({
+  exec: vi.fn(),
+}));
+
+describe('amendCommit', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it('should amend commit when changes file is detected', async () => {
+    // Mock rush configuration
+    const mockRushConfig = {
+      rushJsonFolder: '/root/path',
+      changesFolder: '/root/path/common/changes',
+    };
+    vi.mocked(projectAnalyzer.getRushConfiguration).mockReturnValue(
+      mockRushConfig as any,
+    );
+
+    // Mock path.relative to return the changes folder path
+    (path.relative as Mock).mockReturnValue('common/changes');
+
+    // Mock git changed files to include a changes file
+    vi.mocked(gitCommand.getChangedFilesFromCached).mockResolvedValue([
+      'common/changes/my-package.json',
+      'some/other/file.js',
+    ]);
+
+    await amendCommit();
+
+    // Verify the correct paths were used
+    expect(path.relative).toHaveBeenCalledWith(
+      '/root/path',
+      '/root/path/common/changes',
+    );
+
+    // Verify git command was executed
+    expect(exec).toHaveBeenCalledWith('git commit --amend --no-edit -n');
+  });
+
+  it('should not amend commit when no changes file is detected', async () => {
+    // Mock rush configuration
+    const mockRushConfig = {
+      rushJsonFolder: '/root/path',
+      changesFolder: '/root/path/common/changes',
+    };
+    vi.mocked(projectAnalyzer.getRushConfiguration).mockReturnValue(
+      mockRushConfig as any,
+    );
+
+    // Mock path.relative to return the changes folder path
+    vi.mocked(path.relative).mockReturnValue('common/changes');
+
+    // Mock git changed files to not include any changes file
+    vi.mocked(gitCommand.getChangedFilesFromCached).mockResolvedValue([
+      'src/index.ts',
+      'package.json',
+    ]);
+
+    await amendCommit();
+
+    // Verify path.relative was still called
+    expect(path.relative).toHaveBeenCalledWith(
+      '/root/path',
+      '/root/path/common/changes',
+    );
+
+    // Verify git command was not executed
+    expect(exec).not.toHaveBeenCalled();
+  });
+
+  it('should handle empty changed files array', async () => {
+    // Mock rush configuration
+    const mockRushConfig = {
+      rushJsonFolder: '/root/path',
+      changesFolder: '/root/path/common/changes',
+    };
+    vi.mocked(projectAnalyzer.getRushConfiguration).mockReturnValue(
+      mockRushConfig as any,
+    );
+
+    // Mock path.relative
+    vi.mocked(path.relative).mockReturnValue('common/changes');
+
+    // Mock git changed files to return empty array
+    vi.mocked(gitCommand.getChangedFilesFromCached).mockResolvedValue([]);
+
+    await amendCommit();
+
+    // Verify path.relative was called
+    expect(path.relative).toHaveBeenCalledWith(
+      '/root/path',
+      '/root/path/common/changes',
+    );
+
+    // Verify git command was not executed
+    expect(exec).not.toHaveBeenCalled();
+  });
+});