@tertium/gith 0.1.0 → 0.2.0

package/README.md

@@ -70,6 +70,7 @@ gith remove --obsolete              # remove branches untouched for 90 days, on
 gith remove --obsolete --local      # the same, here only
 gith remove --obsolete -days 30     # untouched for 30 days instead
 gith remove --detached              # pick local branches that have no origin copy
+gith remove --detached --all        # remove all of them: lists them, then asks Y/n
 
 # Look at the repo
 gith status                         # branch vs origin, and staged, unstaged and untracked counts
@@ -92,6 +93,8 @@ gith stat --last-week -limit 50     # the same for last week, looking at no more
 gith sync                           # fetch all remotes and tags, prune stale refs
 gith open                           # open origin in the browser
 gith doctor                         # check the repo is ready for the branch flow
+gith changelog --dry-run            # preview the CHANGELOG.md entry for package.json's version
+gith changelog                      # write it as its own commit (docs(changelog): <version>); --no-commit only writes
 
 # Help
 gith help                           # full usage
@@ -155,6 +158,7 @@ Commands that choose between flags (for example `create -b`, `-r` and `-h`, or `
 - **`stat`** reads the history of the current branch and prints a table of facts: commit count, top author, the biggest commit (lines added and removed), average size, the most changed file, the busiest day, weekday and hour, the longest streak of days with a commit, night owl and weekend commits, and the conventional commit types. The period is one switch: `--overall` (the default), `--current-year`, `--current-month`, `--current-week` (weeks start on Monday), or the matching `--last-` switch for the previous year, month or week. `-limit <n>` looks only at the last `n` commits. Stat changes nothing.
 - **`unstash`** runs `git stash pop`. If it conflicts, git keeps the stash in the list.
 - **`remove --obsolete`** fetches and prunes origin, then lists the branches untouched for `-days` (default 90): no commit newer than the cutoff on either side. Each line shows the sides and the last commit date, and the command asks `Remove these N branches here and on origin? [Y/n]`. Enter means yes. `--local` looks at and removes only local branches. `-limit` shows only the first `n`, and the prompt covers only those. `main`, `develop`, `release/*` and `hotfix/*` are never removed, and neither is the checked-out branch. Each branch is deleted locally first (`git branch -d`), so a branch that git does not see as merged stops the run before its origin copy is touched.
+- **`remove --detached --all`** fetches and prunes origin, lists every local branch with no origin copy, and asks `Remove these N branches? [Y/n]` once. Nothing is deleted without the yes, and `--all` can't be combined with `-limit`.
 - **`remove --detached`** fetches and prunes origin, then lists local branches that have no origin copy and lets you pick from them, the same as `remove --branch --local` but for branches with no origin copy only.
 - **Every removal shows what it will remove** before deleting anything, including the direct `remove -b` form. The picker and the prompt both show it first.
 - **`open`** opens origin in the browser, turning an `ssh` or `https` remote into a web address. GitHub and GitLab style addresses work.

package/bin/gith.js

@@ -30,6 +30,8 @@ var SPECS = new Map([
   ["current-hotfix", "switch"],
   ["pockets", "switch"],
   ["detached", "switch"],
+  ["all", "switch"],
+  ["no-commit", "switch"],
   ["overall", "switch"],
   ["current-year", "switch"],
   ["current-month", "switch"],
@@ -118,6 +120,10 @@ function onlyOne(flags, names) {
   return present[0];
 }
 
+// src/components/changelog/changelog.ts
+import { existsSync, readFileSync, writeFileSync } from "node:fs";
+import path from "node:path";
+
 // src/components/git/git.ts
 import { execFileSync } from "node:child_process";
 var verbose = false;
@@ -215,6 +221,92 @@ function act(args, options = {}) {
   execFileSync("git", args, { stdio: "inherit", ...options });
 }
 
+// src/components/changelog/changelog.constants.ts
+var CHANGELOG_FILE_NAME = "CHANGELOG.md";
+var CHANGELOG_TITLE = "# Changelog";
+var SEMVER_ONLY_PATTERN = /^\d+\.\d+\.\d+$/;
+
+// src/components/changelog/changelog.utils.ts
+function filterCommitSubjects(rawLog) {
+  if (!rawLog.trim())
+    return [];
+  return rawLog.split(`
+`).map((line) => line.trim()).filter((line) => line.length > 0 && !SEMVER_ONLY_PATTERN.test(line));
+}
+function buildEntry(notes) {
+  const bullets = notes.subjects.length > 0 ? notes.subjects.map((subject) => `- ${subject}`).join(`
+`) : "- (no changes recorded)";
+  return `## ${notes.version} - ${notes.date}
+
+${bullets}
+`;
+}
+function mergeChangelogContent(existing, entry) {
+  const heading = `${CHANGELOG_TITLE}
+`;
+  if (existing === null)
+    return `${heading}
+${entry}
+`;
+  const body = existing.startsWith(heading) ? existing.slice(heading.length).replace(/^\n+/, "") : existing;
+  return `${heading}
+${entry}
+${body}`;
+}
+function parsePackageVersion(rawPackageJson) {
+  const pkg = JSON.parse(rawPackageJson);
+  if (!pkg.version)
+    throw new Error('No "version" field found in package.json');
+  return pkg.version;
+}
+function todayIso(date = new Date) {
+  return date.toISOString().slice(0, 10);
+}
+
+// src/components/changelog/changelog.ts
+function previousTag() {
+  try {
+    return captureArgs(["describe", "--tags", "--abbrev=0"]);
+  } catch {
+    return null;
+  }
+}
+function commitSubjectsSince(tag) {
+  const range = tag ? `${tag}..HEAD` : "HEAD";
+  return filterCommitSubjects(captureArgs(["log", range, "--no-merges", "--pretty=format:%s"]));
+}
+function changelog(flags) {
+  const noCommit = flags.has("no-commit");
+  if (flags.size > (noCommit ? 1 : 0))
+    throw new Error("usage: gith changelog [--dry-run] [--no-commit]");
+  const root = process.cwd();
+  const version = parsePackageVersion(readFileSync(path.join(root, "package.json"), "utf8"));
+  const entry = buildEntry({
+    version,
+    date: todayIso(),
+    subjects: commitSubjectsSince(previousTag())
+  });
+  if (isDryRun()) {
+    console.log(entry);
+    console.log(`dry run: would update ${CHANGELOG_FILE_NAME}`);
+    return;
+  }
+  const file = path.join(root, CHANGELOG_FILE_NAME);
+  const existing = existsSync(file) ? readFileSync(file, "utf8") : null;
+  writeFileSync(file, mergeChangelogContent(existing, entry));
+  console.log(`✅ ${CHANGELOG_FILE_NAME} updated for ${version}`);
+  if (noCommit)
+    return;
+  gitArgs(["add", "--", CHANGELOG_FILE_NAME]);
+  gitArgs([
+    "commit",
+    "-m",
+    `docs(changelog): ${version}`,
+    "--",
+    CHANGELOG_FILE_NAME
+  ]);
+}
+
 // src/components/doctor/doctor.utils.ts
 function check(name, test, failure = "fail") {
   return {
@@ -945,8 +1037,10 @@ async function remove(flags) {
     throw new Error("use only one of: --obsolete, --detached.");
   if (flags.has("days") && !obsoleteOn)
     throw new Error("-days only applies to --obsolete.");
+  if (flags.has("all") && !detachedOn)
+    throw new Error("--all only applies to --detached.");
   if (obsoleteOn || detachedOn) {
-    const usage = detachedOn ? "usage: gith remove --detached [-l <n>]" : "usage: gith remove --obsolete [--local] [-days <n>] [-l <n>]";
+    const usage = detachedOn ? "usage: gith remove --detached [--all | -l <n>]" : "usage: gith remove --obsolete [--local] [-days <n>] [-l <n>]";
     if (name !== undefined || obsoleteOn && side === "remote" || detachedOn && side)
       throw new Error(usage);
     if (detachedOn)
@@ -1038,7 +1132,7 @@ function pick(scope, limit) {
   const remote = scope === "local" ? [] : remoteBranches();
   return choose(candidates(scope, localBranches(), remote, currentBranch2()), limit);
 }
-async function removeBranches(scope, names, ask2 = true) {
+async function removeBranches(scope, names, ask = true) {
   const plan = names.map((name) => {
     if (scope === "remote")
       return { name, local: false, origin: true };
@@ -1053,7 +1147,7 @@ async function removeBranches(scope, names, ask2 = true) {
   });
   if (plan.length > 0)
     console.log("Will remove:");
-  if (ask2 && plan.length > 0 && !await confirm(plan.length === 1 ? "Remove this branch? [Y/n] " : `Remove these ${plan.length} branches? [Y/n] `)) {
+  if (ask && plan.length > 0 && !await confirm(plan.length === 1 ? "Remove this branch? [Y/n] " : `Remove these ${plan.length} branches? [Y/n] `)) {
     console.log("Nothing removed.");
     return;
   }
@@ -1103,9 +1197,19 @@ async function obsolete(flags, scope) {
   await removeBranches(scope, shown.map((option) => option.name), false);
 }
 async function detached(flags) {
-  requireTerminal();
   gitArgs(["fetch", "--prune", "origin"]);
   const options = detachedOptions(readTimes(), currentBranch2());
+  if (flags.has("all")) {
+    if (flags.has("limit"))
+      throw new Error("use only one of: --all, -limit.");
+    if (options.length === 0) {
+      console.log("No detached branches to remove.");
+      return;
+    }
+    await removeBranches("local", options.map((option) => option.name));
+    return;
+  }
+  requireTerminal();
   await removeBranches("local", await choose(options, parseLimit(flags)));
 }
 function switchToCommit(ref) {
@@ -1264,8 +1368,8 @@ function startOfWeek(date) {
 }
 function dayKey(date) {
   const month = String(date.getMonth() + 1).padStart(2, "0");
-  const day2 = String(date.getDate()).padStart(2, "0");
-  return `${date.getFullYear()}-${month}-${day2}`;
+  const day = String(date.getDate()).padStart(2, "0");
+  return `${date.getFullYear()}-${month}-${day}`;
 }
 function top(counts) {
   let best;
@@ -1347,57 +1451,57 @@ function parseLog(output) {
 function longestStreak(dates) {
   const days = [...new Set(dates.map(dayKey))].sort();
   let best = 0;
-  let run2 = 0;
+  let run = 0;
   let previous = -Infinity;
   for (const key of days) {
     const [y = 0, m = 1, d = 1] = key.split("-").map(Number);
     const ms = Date.UTC(y, m - 1, d) / 86400000;
-    run2 = ms - previous === 1 ? run2 + 1 : 1;
-    best = Math.max(best, run2);
+    run = ms - previous === 1 ? run + 1 : 1;
+    best = Math.max(best, run);
     previous = ms;
   }
   return best;
 }
-function summarize(commits2) {
-  if (commits2.length === 0)
+function summarize(commits) {
+  if (commits.length === 0)
     return [];
   const rows = [];
   const add = (stat, value, detail = "") => rows.push({ stat, value, detail });
-  const authors = count(commits2.map((c) => c.author));
+  const authors = count(commits.map((c) => c.author));
   const topAuthor = top(authors);
-  const oldest = commits2.reduce((a, b) => a.date <= b.date ? a : b);
-  const newest = commits2.reduce((a, b) => a.date >= b.date ? a : b);
-  const added = commits2.reduce((sum, c) => sum + c.added, 0);
-  const deleted = commits2.reduce((sum, c) => sum + c.deleted, 0);
-  add("Commits", String(commits2.length), `${dayKey(oldest.date)} to ${dayKey(newest.date)}`);
+  const oldest = commits.reduce((a, b) => a.date <= b.date ? a : b);
+  const newest = commits.reduce((a, b) => a.date >= b.date ? a : b);
+  const added = commits.reduce((sum, c) => sum + c.added, 0);
+  const deleted = commits.reduce((sum, c) => sum + c.deleted, 0);
+  add("Commits", String(commits.length), `${dayKey(oldest.date)} to ${dayKey(newest.date)}`);
   add("Authors", String(authors.size));
   if (topAuthor)
     add("Top author", topAuthor[0], `${topAuthor[1]} commits`);
-  const biggest = commits2.reduce((a, b) => b.added + b.deleted > a.added + a.deleted ? b : a);
+  const biggest = commits.reduce((a, b) => b.added + b.deleted > a.added + a.deleted ? b : a);
   add("Biggest commit", `+${biggest.added} -${biggest.deleted}`, `${biggest.hash.slice(0, 7)} ${biggest.subject} (${biggest.author})`);
-  add("Average size", `${Math.round((added + deleted) / commits2.length)} lines`, `per commit; +${added} -${deleted} in total`);
-  const files = count(commits2.flatMap((c) => c.files));
+  add("Average size", `${Math.round((added + deleted) / commits.length)} lines`, `per commit; +${added} -${deleted} in total`);
+  const files = count(commits.flatMap((c) => c.files));
   const topFile = top(files);
   add("Files touched", String(files.size), topFile ? `most changed: ${topFile[0]} (${topFile[1]} commits)` : "");
-  const busiestDay = top(count(commits2.map((c) => dayKey(c.date))));
+  const busiestDay = top(count(commits.map((c) => dayKey(c.date))));
   if (busiestDay)
     add("Busiest day", busiestDay[0], `${busiestDay[1]} commits`);
-  const weekday = top(count(commits2.map((c) => DAYS[c.date.getDay()] ?? "")));
+  const weekday = top(count(commits.map((c) => DAYS[c.date.getDay()] ?? "")));
   if (weekday)
     add("Busiest weekday", weekday[0], `${weekday[1]} commits`);
-  const hour = top(count(commits2.map((c) => String(c.date.getHours()).padStart(2, "0"))));
+  const hour = top(count(commits.map((c) => String(c.date.getHours()).padStart(2, "0"))));
   if (hour)
     add("Peak hour", `${hour[0]}:00`, `${hour[1]} commits`);
-  const streak = longestStreak(commits2.map((c) => c.date));
+  const streak = longestStreak(commits.map((c) => c.date));
   add("Longest streak", `${streak} ${streak === 1 ? "day" : "days"}`, "in a row with a commit");
-  const nightOwl = commits2.filter((c) => c.date.getHours() >= 22 || c.date.getHours() < 5).length;
-  const weekend = commits2.filter((c) => c.date.getDay() === 0 || c.date.getDay() === 6).length;
+  const nightOwl = commits.filter((c) => c.date.getHours() >= 22 || c.date.getHours() < 5).length;
+  const weekend = commits.filter((c) => c.date.getDay() === 0 || c.date.getDay() === 6).length;
   add("Night owl", `${nightOwl} commits`, "between 22:00 and 05:00");
   add("Weekend", `${weekend} commits`, "on Saturday or Sunday");
-  const types = count(commits2.map((c) => /^(\w+)(\([^)]*\))?!?:/.exec(c.subject)?.[1]?.toLowerCase() ?? "").filter(Boolean));
+  const types = count(commits.map((c) => /^(\w+)(\([^)]*\))?!?:/.exec(c.subject)?.[1]?.toLowerCase() ?? "").filter(Boolean));
   if (types.size > 0) {
-    const list2 = [...types.entries()].sort((a, b) => b[1] - a[1] || a[0].localeCompare(b[0])).slice(0, 4).map(([type, n]) => `${type} ${n}`).join(", ");
-    add("Commit types", list2, "from conventional prefixes");
+    const list = [...types.entries()].sort((a, b) => b[1] - a[1] || a[0].localeCompare(b[0])).slice(0, 4).map(([type, n]) => `${type} ${n}`).join(", ");
+    add("Commit types", list, "from conventional prefixes");
   }
   return rows;
 }
@@ -1432,13 +1536,13 @@ function stat(flags) {
     args.push(`--until=${range.until}`);
   if (limit !== undefined)
     args.push(`-n${limit}`);
-  const commits2 = parseLog(captureArgs(args));
-  if (commits2.length === 0) {
+  const commits = parseLog(captureArgs(args));
+  if (commits.length === 0) {
     console.log(`No commits ${range.label === "overall" ? "yet" : `in ${range.label}`}.`);
     return;
   }
   console.log(`gith stat, ${range.label}${limit === undefined ? "" : `, last ${limit} commits`}`);
-  console.log(table(summarize(commits2)));
+  console.log(table(summarize(commits)));
 }
 
 // src/components/status/status.ts
@@ -1556,7 +1660,7 @@ function tree(flags) {
 }
 
 // src/components/version/version.ts
-import { readFileSync as readFileSync2 } from "node:fs";
+import { readFileSync as readFileSync3 } from "node:fs";
 
 // src/components/version/version.constants.ts
 var MASCOT = [
@@ -1571,19 +1675,19 @@ var MASCOT = [
 ];
 
 // src/components/version/version.utils.ts
-import { existsSync, readFileSync } from "node:fs";
-import path from "node:path";
+import { existsSync as existsSync2, readFileSync as readFileSync2 } from "node:fs";
+import path2 from "node:path";
 import { fileURLToPath } from "node:url";
 function packageJsonPath() {
-  let dir = path.dirname(fileURLToPath(import.meta.url));
+  let dir = path2.dirname(fileURLToPath(import.meta.url));
   for (;; ) {
-    const candidate = path.join(dir, "package.json");
-    if (existsSync(candidate)) {
-      const pkg = JSON.parse(readFileSync(candidate, "utf8"));
+    const candidate = path2.join(dir, "package.json");
+    if (existsSync2(candidate)) {
+      const pkg = JSON.parse(readFileSync2(candidate, "utf8"));
       if (pkg.name === "@tertium/gith")
         return candidate;
     }
-    const parent = path.dirname(dir);
+    const parent = path2.dirname(dir);
     if (parent === dir)
       throw new Error("gith package.json not found");
     dir = parent;
@@ -1592,7 +1696,7 @@ function packageJsonPath() {
 
 // src/components/version/version.ts
 function readVersion() {
-  const pkg = JSON.parse(readFileSync2(packageJsonPath(), "utf8"));
+  const pkg = JSON.parse(readFileSync3(packageJsonPath(), "utf8"));
   return pkg.version ?? "unknown";
 }
 function versionText() {
@@ -1638,6 +1742,7 @@ Clean up branches (every removal shows what it will remove first)
   gith remove --branch --remote      pick from origin branches
   gith remove --obsolete [--local] [-days <n>]   remove branches untouched for 90 days, after Y/n
   gith remove --detached [-l <n>]    pick local branches that have no origin copy
+  gith remove --detached --all       remove all of them, after listing them and a Y/n question
   gith rm                            alias of remove
 
 Look at the repo
@@ -1656,6 +1761,7 @@ Remote and health
   gith sync                          fetch all remotes and tags, prune stale refs
   gith open                          open origin in the browser
   gith doctor                        check the repo is ready for the branch flow (exit 1 on failures)
+  gith changelog [--dry-run]         add an entry for package.json's version to CHANGELOG.md (commits since the last tag)
 
 Help
   gith help                          show this help
@@ -1739,6 +1845,9 @@ try {
     case "open":
       open2(parseFlags(rest));
       break;
+    case "changelog":
+      changelog(parseFlags(rest));
+      break;
     case "doctor":
       if (!doctor(parseFlags(rest)))
         exit(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tertium/gith",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Git helper: branch flow with goal branches, release and hotfix containers, and everyday git commands.",
   "type": "module",
   "bin": {
@@ -15,7 +15,11 @@
     "test": "bun test --no-coverage",
     "lint": "biome check src",
     "lint:fix": "biome check --write src",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "release:patch": "node bin/gith.js release --patch",
+    "release:minor": "node bin/gith.js release --minor",
+    "release:major": "node bin/gith.js release --major",
+    "version": "bun run build && node bin/gith.js changelog"
   },
   "license": "ISC",
   "author": "Vitalii Balabanov",