@tertium/gith 0.1.1 → 0.2.0

package/README.md

@@ -93,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

package/bin/gith.js

@@ -31,6 +31,7 @@ var SPECS = new Map([
   ["pockets", "switch"],
   ["detached", "switch"],
   ["all", "switch"],
+  ["no-commit", "switch"],
   ["overall", "switch"],
   ["current-year", "switch"],
   ["current-month", "switch"],
@@ -119,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;
@@ -216,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 {
@@ -1569,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 = [
@@ -1584,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;
@@ -1605,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() {
@@ -1670,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
@@ -1753,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.1",
+  "version": "0.2.0",
   "description": "Git helper: branch flow with goal branches, release and hotfix containers, and everyday git commands.",
   "type": "module",
   "bin": {
@@ -18,7 +18,8 @@
     "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"
+    "release:major": "node bin/gith.js release --major",
+    "version": "bun run build && node bin/gith.js changelog"
   },
   "license": "ISC",
   "author": "Vitalii Balabanov",