@ci-kit/changelog 0.0.0-stage → 0.0.1

package/dist/cli.d.mts

@@ -0,0 +1 @@
+

package/dist/cli.d.ts

@@ -0,0 +1 @@
+

package/dist/cli.mjs

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+import { writeFileSync } from 'node:fs';
+import process from 'node:process';
+import { cac } from 'cac';
+import { collectCommits, renderChangelog } from './index.mjs';
+import 'node:child_process';
+
+const version = "0.0.1";
+const pkg = {
+	version: version};
+
+const cli = cac("ci-kit-changelog");
+cli.command("[out]", "Generate grouped release notes from git history").option("--from <tag>", "Previous tag (exclusive)").option("--to <tag>", "Target tag (inclusive, defaults to HEAD)").option("--max <n>", "Max items per section", { default: 10 }).action((out, options) => {
+  const commits = collectCommits({ from: options.from, to: options.to });
+  const markdown = renderChangelog(commits, {
+    maxPerSection: Number(options.max ?? 10)
+  });
+  if (out) {
+    writeFileSync(out, `${markdown}
+`, "utf8");
+    process.stdout.write(`Wrote ${out} (${commits.length} commits scanned)
+`);
+  } else {
+    process.stdout.write(`${markdown}
+`);
+  }
+});
+cli.help();
+cli.version(pkg.version);
+cli.parse();

package/dist/index.d.mts

@@ -0,0 +1,40 @@
+interface Commit {
+    hash: string;
+    subject: string;
+    body: string;
+}
+interface ChangelogSection {
+    type: string;
+    title: string;
+    items: string[];
+}
+interface ChangelogOptions {
+    cwd?: string;
+    from?: string;
+    to?: string;
+    maxPerSection?: number;
+    keep?: Array<{
+        type: string;
+        title: string;
+    }>;
+    drop?: string[];
+}
+declare const DEFAULT_KEEP: {
+    type: string;
+    title: string;
+}[];
+declare const DEFAULT_DROP: string[];
+declare function collectCommits(options?: ChangelogOptions): Commit[];
+interface ParsedSubject {
+    type: string;
+    description: string;
+    breaking: boolean;
+    references: string;
+}
+declare function parseSubject(subject: string): ParsedSubject | null;
+declare function renderChangelog(commits: Commit[], options?: ChangelogOptions): string;
+declare function isBetaTag(tag: string): boolean;
+declare function previousTagMatcher(channel: 'beta' | 'production'): string;
+
+export { DEFAULT_DROP, DEFAULT_KEEP, collectCommits, isBetaTag, parseSubject, previousTagMatcher, renderChangelog };
+export type { ChangelogOptions, ChangelogSection, Commit };

package/dist/index.d.ts

@@ -0,0 +1,40 @@
+interface Commit {
+    hash: string;
+    subject: string;
+    body: string;
+}
+interface ChangelogSection {
+    type: string;
+    title: string;
+    items: string[];
+}
+interface ChangelogOptions {
+    cwd?: string;
+    from?: string;
+    to?: string;
+    maxPerSection?: number;
+    keep?: Array<{
+        type: string;
+        title: string;
+    }>;
+    drop?: string[];
+}
+declare const DEFAULT_KEEP: {
+    type: string;
+    title: string;
+}[];
+declare const DEFAULT_DROP: string[];
+declare function collectCommits(options?: ChangelogOptions): Commit[];
+interface ParsedSubject {
+    type: string;
+    description: string;
+    breaking: boolean;
+    references: string;
+}
+declare function parseSubject(subject: string): ParsedSubject | null;
+declare function renderChangelog(commits: Commit[], options?: ChangelogOptions): string;
+declare function isBetaTag(tag: string): boolean;
+declare function previousTagMatcher(channel: 'beta' | 'production'): string;
+
+export { DEFAULT_DROP, DEFAULT_KEEP, collectCommits, isBetaTag, parseSubject, previousTagMatcher, renderChangelog };
+export type { ChangelogOptions, ChangelogSection, Commit };

package/dist/index.mjs

@@ -0,0 +1,112 @@
+import { execFileSync } from 'node:child_process';
+import process from 'node:process';
+
+const HEADER = "## \u66F4\u65B0\u5185\u5BB9";
+const EMPTY_NOTICE = "\u672C\u6B21\u7248\u672C\u4E3B\u8981\u4E3A\u5185\u90E8\u7EF4\u62A4\u4E0E\u7A33\u5B9A\u6027\u8C03\u6574\uFF0C\u6CA1\u6709\u9762\u5411\u7528\u6237\u7684\u529F\u80FD\u53D8\u66F4\u3002";
+const FIRST_RELEASE_NOTICE = "\u9996\u4E2A\u7248\u672C\u3002";
+const DEFAULT_KEEP = [
+  { type: "feat", title: "\u65B0\u529F\u80FD" },
+  { type: "fix", title: "\u4FEE\u590D" },
+  { type: "perf", title: "\u6027\u80FD" },
+  { type: "refactor", title: "\u91CD\u6784" }
+];
+const DEFAULT_DROP = [
+  "ci",
+  "docs",
+  "chore",
+  "test",
+  "build",
+  "style"
+];
+function collectCommits(options = {}) {
+  const { cwd = process.cwd(), from, to } = options;
+  const range = from ? `${from}..${to ?? "HEAD"}` : to ?? "HEAD";
+  const output = execFileSync(
+    "git",
+    [
+      "log",
+      range,
+      "--no-merges",
+      "--pretty=format:%H%x1f%s%x1f%b%x1e"
+    ],
+    { cwd, encoding: "utf8", maxBuffer: 16 * 1024 * 1024 }
+  );
+  return output.split("").map((chunk) => chunk.trim()).filter(Boolean).map((chunk) => {
+    const [hash = "", subject = "", body = ""] = chunk.split("");
+    return {
+      hash,
+      subject: subject.trim(),
+      body: body.trim()
+    };
+  });
+}
+const PREFIX_RE = /^(feat|fix|perf|refactor|ci|docs|chore|test|build|style)(?:\([^)]+\))?(!)?:\s+/;
+function parseSubject(subject) {
+  const match = subject.match(PREFIX_RE);
+  if (!match) {
+    return null;
+  }
+  const [, type, breaking] = match;
+  const description = subject.slice(match[0].length).trim();
+  const references = description.match(/#\d+/g)?.join(" ") ?? "";
+  return {
+    type,
+    description: description.trim(),
+    breaking: breaking === "!",
+    references
+  };
+}
+function renderChangelog(commits, options = {}) {
+  const {
+    keep = DEFAULT_KEEP,
+    drop = DEFAULT_DROP,
+    maxPerSection = 10
+  } = options;
+  if (commits.length === 0) {
+    return `${HEADER}
+
+${FIRST_RELEASE_NOTICE}`;
+  }
+  const sections = /* @__PURE__ */ new Map();
+  for (const commit of commits) {
+    const parsed = parseSubject(commit.subject);
+    if (!parsed || drop.includes(parsed.type)) {
+      continue;
+    }
+    if (!keep.some((entry) => entry.type === parsed.type)) {
+      continue;
+    }
+    const items = sections.get(parsed.type) ?? [];
+    items.push(parsed.breaking ? `${parsed.description}\uFF08\u4E0D\u517C\u5BB9\uFF09` : parsed.description);
+    sections.set(parsed.type, items);
+  }
+  const lines = [HEADER, ""];
+  let rendered = false;
+  for (const { type, title } of keep) {
+    const items = sections.get(type);
+    if (!items || items.length === 0) {
+      continue;
+    }
+    rendered = true;
+    lines.push(`### ${title}`, "");
+    for (const item of items.slice(0, maxPerSection)) {
+      lines.push(`- ${item}`);
+    }
+    if (items.length > maxPerSection) {
+      lines.push(`- \u4EE5\u53CA\u53E6\u5916 ${items.length - maxPerSection} \u6761`);
+    }
+    lines.push("");
+  }
+  if (!rendered) {
+    lines.push(EMPTY_NOTICE, "");
+  }
+  return lines.join("\n").trimEnd();
+}
+function isBetaTag(tag) {
+  return /\d+\.\d+\.\d+-beta\.\d+$/.test(tag);
+}
+function previousTagMatcher(channel) {
+  return channel === "beta" ? "v*-beta.*" : "v[0-9]*";
+}
+
+export { DEFAULT_DROP, DEFAULT_KEEP, collectCommits, isBetaTag, parseSubject, previousTagMatcher, renderChangelog };

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@ci-kit/changelog",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "type": "module",
+  "version": "0.0.1",
+  "description": "Turn git commits into grouped release notes",
+  "author": "imba97",
+  "license": "MIT",
+  "homepage": "https://github.com/cikit-js/ci-kit#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cikit-js/ci-kit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/cikit-js/ci-kit/issues"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "bin": {
+    "ci-kit-changelog": "dist/cli.mjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "cac": "^7.1.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "typecheck": "tsc --noEmit",
+    "stub": "unbuild --stub"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.