mergelog 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Morten Daniel Fornes
+
+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,69 @@
+# mergelog
+
+> Format git commits as Markdown for merge and pull request descriptions
+
+## Why
+
+- Generate clean Markdown directly from `git log`
+- Optimized for GitLab and GitHub merge request descriptions
+- Automatically formats code-like terms with backticks
+- Detects issue references like `#1234`
+- Detects the repository main branch automatically
+- Supports clipboard output
+
+## Install
+
+```sh
+npm install mergelog -g
+```
+
+## Usage
+
+```sh
+$ mergelog --help
+
+mergelog
+
+Format git commits as Markdown for merge/pull request descriptions.
+
+Usage
+  mergelog
+  mergelog 3
+  mergelog origin/main..HEAD
+  mergelog 3 --no-code
+  mergelog 3 --clipboard
+
+Options
+  -h, --help       Show this help screen
+  -C, --no-code    Disable automatic backticks
+  -c, --clipboard  Copy Markdown to the clipboard
+
+Defaults
+  No range:        detected upstream/default branch .. HEAD
+  Number argument: last N commits, e.g. 3 -> -3
+
+Output
+  ### Commit subject
+
+  Commit body
+
+  Close #1234
+```
+
+## Example output
+
+```md
+### Tools: Improve startup logging
+
+Show clearer restart and shutdown messages during local development.
+
+### API: Deprecate timezone fields
+
+Mark legacy timezone fields as deprecated in the API schema.
+
+Close #1234
+
+### Calendar: Fix week rendering for January 2027
+
+Render calendar weeks using actual dates instead of ISO week numbers.
+```

package/dist/mergelog.js

@@ -0,0 +1,171 @@
+#!/usr/bin/env node
+import { execFileSync } from "node:child_process";
+const colors = {
+    bold: "\x1b[1m",
+    dim: "\x1b[2m",
+    cyan: "\x1b[36m",
+    green: "\x1b[32m",
+    yellow: "\x1b[33m",
+    reset: "\x1b[0m",
+};
+const args = process.argv.slice(2);
+if (args.includes("-h") || args.includes("--help")) {
+    help();
+    process.exit(0);
+}
+const autoCode = !args.includes("-C") && !args.includes("--no-code");
+const clipboard = args.includes("-c") || args.includes("--clipboard");
+const arg = args.find(x => !x.startsWith("-"));
+main();
+/** Format git commits as Markdown for merge/pull request descriptions. */
+function main() {
+    const range = resolveRange(arg);
+    const log = git(["log", range, "--reverse", "--format=%x1e%B%x1f"], { showErrors: true });
+    const markdown = formatCommits(log);
+    if (clipboard) {
+        copyToClipboard(markdown);
+    }
+    else {
+        console.log(markdown);
+    }
+}
+/** Resolves a user argument to a git log range. */
+function resolveRange(arg) {
+    if (arg === undefined)
+        return `${getDefaultBaseRef()}..HEAD`;
+    if (/^\d+$/.test(arg))
+        return `-${arg}`;
+    return arg;
+}
+/** Formats raw git log output as Markdown sections. */
+function formatCommits(log) {
+    return log
+        .split("\x1f")
+        .map(x => x.replace(/\x1e/g, "").trim())
+        .filter(Boolean)
+        .map(formatCommit)
+        .join("\n\n");
+}
+/** Formats one commit message as a Markdown heading and body. */
+function formatCommit(commit) {
+    const [subject = "", ...bodyLines] = commit.split("\n");
+    const body = codeify(bodyLines.join("\n").trim());
+    return [`### ${subject}`, body].filter(Boolean).join("\n\n");
+}
+/** Adds inline-code formatting to likely code identifiers. */
+function codeify(text) {
+    if (!autoCode)
+        return text;
+    return text
+        .split(/(`[^`]*`)/g)
+        .map(codeifyNonCodeSpan)
+        .join("");
+}
+/** Adds inline-code formatting outside existing backtick spans. */
+function codeifyNonCodeSpan(part) {
+    if (part.startsWith("`") && part.endsWith("`"))
+        return part;
+    return (part
+        // Files and paths with a generic alphanumeric extension.
+        .replace(/(?<!`)\b([\w./-]*[\w-]+\.[A-Za-z0-9][A-Za-z0-9-]*)\b(?!`)/g, "`$1`")
+        // Dotfiles such as .env.
+        .replace(/(?<!`)(^|\s)(\.[A-Za-z0-9_-]+)(?!`)/g, "$1`$2`")
+        // Environment variables, optionally including simple assignments.
+        .replace(/(?<!`)\b([A-Z][A-Z0-9]+(?:_[A-Z0-9]+)+(?:=[^\s`]+)?)\b(?!`)/g, "`$1`")
+        // Package scripts or namespaced identifiers such as help:plain.
+        .replace(/(?<!`)\b([A-Za-z0-9_-]+:[A-Za-z0-9_:-]+)\b(?!`)/g, "`$1`")
+        // Short and long CLI flags such as -r and --rebuild.
+        .replace(/(^|\s)(?<!`)(-{1,2}[a-zA-Z0-9][a-zA-Z0-9-]*)(?!`)/g, "$1`$2`")
+        // Simple function or method-call expressions without nested parentheses.
+        .replace(/(?<!`)\b([A-Za-z_$][\w$]*(?:\.[A-Za-z_$][\w$]*)*\([^`()\n]*\))(?!`)/g, "`$1`")
+        // Dotted identifiers such as yEditor.saveChanges.
+        .replace(/(?<!`)\b([A-Za-z_$][\w$]*(?:\.[A-Za-z_$][\w$]*)+)\b(?!`)/g, "`$1`")
+        // camelCase identifiers, while avoiding all-uppercase acronyms.
+        .replace(/(?<!`)\b([a-z][A-Za-z0-9_$]*[A-Z][\w$]*)\b(?!`)/g, "`$1`"));
+}
+/** Finds the best default branch to compare the current branch against. */
+function getDefaultBaseRef() {
+    const upstream = tryGit(["rev-parse", "--abbrev-ref", "--symbolic-full-name", "@{upstream}"]);
+    if (upstream)
+        return upstream;
+    const originHead = tryGit(["symbolic-ref", "--quiet", "--short", "refs/remotes/origin/HEAD"]);
+    if (originHead)
+        return originHead;
+    for (const ref of ["origin/main", "origin/master", "main", "master"]) {
+        if (gitRefExists(ref))
+            return ref;
+    }
+    throw new Error("Could not detect base branch. Pass a range or number explicitly.");
+}
+/** Returns true if the given git ref exists locally. */
+function gitRefExists(ref) {
+    return tryGit(["rev-parse", "--verify", "--quiet", ref]) !== undefined;
+}
+/** Runs git and returns undefined if the command fails. */
+function tryGit(args) {
+    try {
+        return git(args);
+    }
+    catch {
+        return undefined;
+    }
+}
+/** Runs a git command and returns trimmed stdout. */
+function git(args, options = {}) {
+    return execFileSync("git", args, {
+        encoding: "utf8",
+        stdio: ["ignore", "pipe", options.showErrors ? "inherit" : "ignore"],
+    }).trim();
+}
+/** Copies text to the system clipboard. */
+function copyToClipboard(text) {
+    if (process.platform === "darwin") {
+        execFileSync("pbcopy", { input: text });
+        return;
+    }
+    if (process.platform === "win32") {
+        execFileSync("clip", { input: text });
+        return;
+    }
+    try {
+        execFileSync("wl-copy", { input: text });
+        return;
+    }
+    catch { }
+    try {
+        execFileSync("xclip", ["-selection", "clipboard"], { input: text });
+        return;
+    }
+    catch { }
+    throw new Error("Could not find a clipboard command. Install wl-copy or xclip, or pipe the output manually.");
+}
+/** Prints command usage and options. */
+function help() {
+    console.log(`${colors.bold}${colors.cyan}mergelog${colors.reset}
+
+${colors.dim}Format git log output as Markdown for merge and pull request descriptions.${colors.reset}
+
+${colors.bold}Usage${colors.reset}
+  ${colors.green}mergelog${colors.reset}
+  ${colors.green}mergelog${colors.reset} ${colors.yellow}3${colors.reset}
+  ${colors.green}mergelog${colors.reset} ${colors.yellow}origin/main..HEAD${colors.reset}
+  ${colors.green}mergelog${colors.reset} ${colors.yellow}3 --no-code${colors.reset}
+  ${colors.green}mergelog${colors.reset} ${colors.yellow}3 --clipboard${colors.reset}
+
+${colors.bold}Options${colors.reset}
+  ${colors.yellow}-h, --help${colors.reset}       Show this help screen
+  ${colors.yellow}-C, --no-code${colors.reset}    Disable automatic backticks
+  ${colors.yellow}-c, --clipboard${colors.reset}  Copy Markdown to the clipboard
+
+${colors.bold}Defaults${colors.reset}
+  No range:        detected upstream/default branch .. HEAD
+  Number argument: last N commits, e.g. ${colors.yellow}3${colors.reset} -> ${colors.yellow}-3${colors.reset}
+
+${colors.bold}Output${colors.reset}
+  ### Commit subject
+
+  Commit body
+
+  Close #1234
+`);
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "mergelog",
+  "version": "1.0.0",
+  "description": "Format git log output as Markdown for merge and pull request descriptions",
+  "keywords": [
+    "git",
+    "git-log",
+    "markdown",
+    "merge-request",
+    "pull-request",
+    "changelog",
+    "cli",
+    "developer-tools",
+    "productivity"
+  ],
+  "homepage": "https://github.com/mortend/tstools/mergelog",
+  "bugs": {
+    "url": "https://github.com/mortend/tstools/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mortend/tstools.git"
+  },
+  "license": "MIT",
+  "author": "mortend.co",
+  "type": "module",
+  "bin": {
+    "mergelog": "dist/mergelog.js"
+  },
+  "scripts": {
+    "prepack": "cp ../LICENSE . && tsc",
+    "postpack": "rm -f LICENSE",
+    "test": "tsx mergelog.ts"
+  },
+  "files": [
+    "dist/*",
+    "LICENSE",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=22"
+  }
+}