Merge branch 'release/0.2.0'

Author: VChet

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [0.2.0](https://github.com/VChet/git-merged-branches/compare/0.1.2...0.2.0) (2025-04-16)
+
+### Features
+
+* add support for multiple 'issueUrlPrefix', more fine-grained 'issueUrlFormat' ([37b3b74](https://github.com/VChet/git-merged-branches/commit/37b3b74e97f4b5e45a3c3b14eabb403a3fd63d54))
+
 ## [0.1.2](https://github.com/VChet/git-merged-branches/compare/0.1.1...0.1.2) (2025-04-15)
 
 ### Features

README.md

@@ -41,14 +41,14 @@ hotfix/urgent-fix
 You can configure the utility in your `package.json` under `git-merged-branches`. This allows you to set:
 
 - **issueUrlFormat**: Base URL for your issue tracker (must be a valid URL).
-- **issueUrlPrefix**: Prefix for issue identifiers in branch names (must be letters).
+- **issueUrlPrefix**: Array of prefixes for issue identifiers in branch names.
 
 Example configuration:
 
 ```json
 "git-merged-branches": {
-  "issueUrlFormat": "https://your-jira-instance.net/browse",
-  "issueUrlPrefix": "TOKEN"
+  "issueUrlFormat": "https://your-jira-instance.net/browse/{{prefix}}{{id}}",
+  "issueUrlPrefix": ["TOKEN-", "PROJECT-"]
 }
 ```
 
@@ -57,8 +57,8 @@ With this setup, `git-merged-branches` will generate links for branches with suc
 ```bash
 $ git-merged-branches
 Branches merged into 'master':
-TOKEN-800_new-feature <https://your-jira-instance.net/TOKEN-800>
-fix/TOKEN-123_some-fix <https://your-jira-instance.net/TOKEN-123>
+TOKEN-800_new-feature <https://your-jira-instance.net/browse/TOKEN-800>
+fix/TOKEN-123_some-fix <https://your-jira-instance.net/browse/TOKEN-123>
 fix/EXTERNAL-391
 hotfix
 ```

package.json

@@ -2,7 +2,7 @@
   "name": "git-merged-branches",
   "description": "CLI tool to list all Git branches merged into a base branch with issue link formatting",
   "type": "module",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "license": "MIT",
   "author": {
     "name": "VChet",
@@ -32,11 +32,12 @@
     "lint:js:fix": "npm run lint:js -- --fix",
     "lint:all": "npm run lint:ts && npm run lint:js",
     "test": "vitest --run",
-    "release": "release-it"
+    "release": "dotenv release-it"
   },
   "devDependencies": {
     "@release-it/conventional-changelog": "^10.0.0",
     "@types/node": "^22.14.1",
+    "dotenv-cli": "^8.0.0",
     "esbuild": "^0.25.2",
     "eslint": "^9.24.0",
     "neostandard": "^0.12.1",

pnpm-lock.yaml

@@ -1,5 +1,23 @@
 import { GitMergedConfig } from "./repo.js";
-import { isValidIssuePrefix, isValidURL } from "./validate.js";
+import { isValidURL } from "./validate.js";
+
+function formatSingleBranch(
+  branch: string,
+  issueUrlFormat: NonNullable<GitMergedConfig["issueUrlFormat"]>,
+  issueUrlPrefix: NonNullable<GitMergedConfig["issueUrlPrefix"]>
+): string {
+  for (const prefix of issueUrlPrefix) {
+    const prefixRegex = new RegExp(`\\b${prefix}(\\d+)`, "i");
+    const match = branch.match(prefixRegex);
+
+    if (!match) { continue; }
+
+    const [_fullToken, id] = match;
+    const url = issueUrlFormat.replace("{{prefix}}", prefix).replace("{{id}}", id);
+    return `${branch} <${url}>`;
+  }
+  return branch;
+}
 
 export function formatTaskBranches(branches: string[], { issueUrlFormat, issueUrlPrefix }: GitMergedConfig): string[] {
   if (!issueUrlFormat || !issueUrlPrefix) { return branches; }
@@ -9,20 +27,11 @@ export function formatTaskBranches(branches: string[], { issueUrlFormat, issueUr
     return branches;
   }
   // issueUrlPrefix
-  if (!isValidIssuePrefix(issueUrlPrefix)) {
-    console.warn(`'${issueUrlPrefix}' is not a valid issue prefix. Skipped formatting.`);
+  if (!Array.isArray(issueUrlPrefix)) {
+    console.warn(`'${issueUrlPrefix}' is not an array. Skipped formatting.`);
     return branches;
   }
-  const prefixRegex = new RegExp(`\\b(${issueUrlPrefix}-\\d+)`, "i");
-
-  return branches.map((branch) => {
-    const match = branch.match(prefixRegex);
-    if (match && issueUrlFormat) {
-      const issueId = match[1].toUpperCase();
-      return `${branch} <${issueUrlFormat}/${issueId}>`;
-      }
-    return branch;
-  });
+  return branches.map((branch) => formatSingleBranch(branch, issueUrlFormat, issueUrlPrefix));
 }
 
 export function outputMergedBranches(branches: string[], targetBranch: string, config: GitMergedConfig): void {

src/output.ts

@@ -6,7 +6,7 @@ export function isGitRepo(): boolean {
   try {
     execSync("git rev-parse --is-inside-work-tree", { stdio: "ignore" });
     return true;
-  } catch (error) {
+  } catch {
     return false;
   }
 }
@@ -42,15 +42,15 @@ export function getMergedBranches(targetBranch: string): string[] {
 
 export interface GitMergedConfig {
   issueUrlFormat?: string;
-  issueUrlPrefix?: string;
+  issueUrlPrefix?: string[];
 };
 
 export function getConfig(): GitMergedConfig {
   try {
     const pkgPath = join(process.cwd(), "package.json");
     const pkg = JSON.parse(readFileSync(pkgPath, "utf-8"));
     return pkg["git-merged-branches"] || {};
-  } catch (error) {
+  } catch {
     return {};
   }
 }

src/repo.ts

@@ -3,38 +3,64 @@ import { formatTaskBranches, outputMergedBranches } from "../output";
 import { GitMergedConfig } from "../repo";
 
 const DEFAULT_CONFIG: GitMergedConfig = {
-  issueUrlFormat: "https://test-instance.org",
-  issueUrlPrefix: "TOKEN"
+  issueUrlFormat: "https://test-instance.org/browse/{{prefix}}{{id}}",
+  issueUrlPrefix: ["TOKEN-"]
 };
 
 describe("formatTaskBranches", () => {
   it("should format branches with issue URL correctly", () => {
     const branches = ["feat/TOKEN-800_new-feature", "fix/TOKEN-123_some-fix"];
     const result = formatTaskBranches(branches, DEFAULT_CONFIG);
     expect(result).toEqual([
-      'feat/TOKEN-800_new-feature <https://test-instance.org/TOKEN-800>',
-      'fix/TOKEN-123_some-fix <https://test-instance.org/TOKEN-123>'
+      'feat/TOKEN-800_new-feature <https://test-instance.org/browse/TOKEN-800>',
+      'fix/TOKEN-123_some-fix <https://test-instance.org/browse/TOKEN-123>'
     ]);
   });
 
-  it("should not format branches without issue prefix", () => {
-    const branches = ["fix/hotfix", "feature/no-issue"];
-    const result = formatTaskBranches(branches, DEFAULT_CONFIG);
-    expect(result).toEqual(branches);  // No change, since no matching prefix
+  it("should support multiple issue prefixes", () => {
+    const branches = ["fix/TOKEN-123_fix", "feat/PROJECT-45_add-feature"];
+    const config: GitMergedConfig = {
+      issueUrlFormat: "https://example.com/browse/{{prefix}}{{id}}",
+      issueUrlPrefix: ["TOKEN-", "PROJECT-"]
+    };
+    const result = formatTaskBranches(branches, config);
+    expect(result).toEqual([
+      "fix/TOKEN-123_fix <https://example.com/browse/TOKEN-123>",
+      "feat/PROJECT-45_add-feature <https://example.com/browse/PROJECT-45>"
+    ]);
   });
 
-  it("should return branches as is if URL format is invalid", () => {
+  it("should not format branches if issueUrlFormat is not provided", () => {
+    const branches = ["feat/TOKEN-100"];
+    const config = { issueUrlFormat: DEFAULT_CONFIG.issueUrlFormat };
+    const result = formatTaskBranches(branches, config);
+    expect(result).toEqual(branches);
+  });
+
+  it("should not format branches if issueUrlPrefix is not provided", () => {
+    const branches = ["feat/TOKEN-100"];
+    const config = { issueUrlPrefix: DEFAULT_CONFIG.issueUrlPrefix };
+    const result = formatTaskBranches(branches, config);
+    expect(result).toEqual(branches);
+  });
+
+  it("should not format branches without valid issueUrlFormat", () => {
     const branches = ["feat/TOKEN-800_new-feature"];
     const config: GitMergedConfig = { ...DEFAULT_CONFIG, issueUrlFormat: "invalid-url" };
     const result = formatTaskBranches(branches, config);
     expect(result).toEqual(branches);  // Invalid URL, no changes
   });
 
-  it("should return branches as is if issue prefix is invalid", () => {
-    const branches = ["feat/TOKEN-800_new-feature"];
-    const config: GitMergedConfig = { ...DEFAULT_CONFIG, issueUrlPrefix: "invalid!prefix" };
-    const result = formatTaskBranches(branches, config);
-    expect(result).toEqual(branches);  // Invalid prefix, no changes
+  it("should not format branches without matching prefix", () => {
+    const branches = ["fix/hotfix", "feature/no-issue"];
+    const result = formatTaskBranches(branches, DEFAULT_CONFIG);
+    expect(result).toEqual(branches);  // No matching prefix, no changes
+  });
+
+  it("should not format branches when prefix is part of another word", () => {
+    const branches = ["fix/NOTTOKEN-100_bad-branch"];
+    const result = formatTaskBranches(branches, DEFAULT_CONFIG);
+    expect(result).toEqual(branches); // No matching prefix, prefix must be exact, no changes
   });
 });
 
@@ -46,33 +72,28 @@ describe("outputMergedBranches", () => {
     warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
   });
 
-  it("should warn when issueUrlFormat is not a valid URL", () => {
-    const branches = ["feat/TOKEN-100"];
-    const config = { ...DEFAULT_CONFIG, issueUrlFormat: "invalid-url" };
-
-    outputMergedBranches(branches, "master", config);
-    expect(warnSpy).toHaveBeenCalledWith("'invalid-url' is not a valid URL. Skipped formatting.");
-  });
-
-  it("should warn when issueUrlPrefix is not valid", () => {
-    const branches = ["feat/TOKEN-100"];
-    const config = { ...DEFAULT_CONFIG, issueUrlPrefix: "invalid!prefix" };
-
-    outputMergedBranches(branches, "master", config);
-    expect(warnSpy).toHaveBeenCalledWith("'invalid!prefix' is not a valid issue prefix. Skipped formatting.");
-  });
-
   it("should log the correct branches when there are merged branches", () => {
     const branches = ["feat/TOKEN-800_new-feature", "fix/TOKEN-123_some-fix"];
 
     outputMergedBranches(branches, "master", DEFAULT_CONFIG);
     expect(infoSpy).toHaveBeenNthCalledWith(1, "Branches merged into 'master':");
-    expect(infoSpy).toHaveBeenNthCalledWith(2, "feat/TOKEN-800_new-feature <https://test-instance.org/TOKEN-800>\nfix/TOKEN-123_some-fix <https://test-instance.org/TOKEN-123>")
+    const branchOutput = [
+      "feat/TOKEN-800_new-feature <https://test-instance.org/browse/TOKEN-800>",
+      "fix/TOKEN-123_some-fix <https://test-instance.org/browse/TOKEN-123>"
+    ]
+    expect(infoSpy).toHaveBeenNthCalledWith(2, branchOutput.join("\n"));
   });
 
   it("should log a message when no branches are merged", () => {
     outputMergedBranches([], "master", DEFAULT_CONFIG);
-
     expect(infoSpy).toHaveBeenCalledWith("No branches merged into 'master'.");
   });
+
+  it("should warn when issueUrlFormat is not a valid URL", () => {
+    const branches = ["feat/TOKEN-100"];
+    const config = { ...DEFAULT_CONFIG, issueUrlFormat: "invalid-url" };
+
+    outputMergedBranches(branches, "master", config);
+    expect(warnSpy).toHaveBeenCalledWith("'invalid-url' is not a valid URL. Skipped formatting.");
+  });
 });

src/tests/output.test.ts

@@ -7,8 +7,3 @@ export function isValidURL(url?: string): boolean {
     return false;
   }
 }
-
-export function isValidIssuePrefix(prefix?: string): boolean {
-  if (!prefix) return false;
-  return /^[A-Z]{2,10}$/i.test(prefix);
-}