@aklinker1/zero-changelog 0.1.0

package/dist/parse-commit.mjs

@@ -0,0 +1,34 @@
+//#region src/parse-commit.ts
+const SUBJECT_REGEX = /^(?<type>\w+)(\((?<scope>.*?)\))?(?<breaking>!)?:\s+(?<description>.+)$/;
+const FOOTER_REGEX = /^(?<key>BREAKING CHANGE|\S+):\s+(?<value>.+)$/;
+const AUTHOR_REGEX = /^(?<name>.+) <(?<email>.+)>$/;
+/** Convert a commit to a {@link ConventionalCommit}, returning `undefined` for unknown formats */
+function parseCommit(commit) {
+	const titleMatch = commit.subject.match(SUBJECT_REGEX);
+	if (!titleMatch) return void 0;
+	const { type, scope, breaking, description } = titleMatch.groups;
+	if (type == null || description == null) return void 0;
+	const footers = [];
+	if (commit.body) for (const line of commit.body.split("\n")) {
+		const match = line.match(FOOTER_REGEX);
+		if (!match?.groups) continue;
+		footers.push({
+			key: match.groups.key.toLowerCase(),
+			value: match.groups.value
+		});
+	}
+	return {
+		type,
+		scope,
+		description,
+		body: commit.body,
+		isBreaking: !!breaking || footers.some((footer) => footer.key === "breaking change"),
+		footers,
+		authors: [commit.author, ...footers.filter((footer) => footer.key === "co-authored-by").map((footer) => footer.value.match(AUTHOR_REGEX)?.groups).filter((group) => group != null).map((group) => ({
+			name: group.name,
+			email: group.email
+		}))]
+	};
+}
+//#endregion
+export { parseCommit };

package/dist/parse-commits.d.mts

@@ -0,0 +1,8 @@
+import { ConventionalCommit } from "./conventional-commit.mjs";
+import { GitCommit } from "./git-commit.mjs";
+
+//#region src/parse-commits.d.ts
+/** Convert commits to an array of {@link Change}, ignoring commits with an unknown format. */
+declare function parseCommits(commits: GitCommit[]): ConventionalCommit[];
+//#endregion
+export { parseCommits };

package/dist/parse-commits.mjs

@@ -0,0 +1,8 @@
+import { parseCommit } from "./parse-commit.mjs";
+//#region src/parse-commits.ts
+/** Convert commits to an array of {@link Change}, ignoring commits with an unknown format. */
+function parseCommits(commits) {
+	return commits.map(parseCommit).filter((change) => change != null);
+}
+//#endregion
+export { parseCommits };

package/dist/release.d.mts

@@ -0,0 +1,384 @@
+import { BumpBy } from "./semver.mjs";
+
+//#region src/release.d.ts
+type ReleaseOptions = {
+  /**
+   * How to bump the version during the release.
+   *
+   * - `undefined`: Detect based on the commit messages since {@link ReleaseOptions#since}
+   * - `"major"`: Bump the major version (e.g. `1.0.0` → `2.0.0`)
+   * - `"minor"`: Bump the minor version (e.g. `1.0.0` → `1.1.0`)
+   * - `"patch"`: Bump the patch version (e.g. `1.0.0` → `1.0.1`)
+   * - `"X.Y.Z"`: Use a specific version (e.g. `1.0.0` → `1.0.0`)
+   *
+   *   - You may set this string to any valid semver (e.g. `"2.0.0"`, `"1.2.3-beta.1"`).
+   *
+   * JS Usage:
+   *
+   * ```ts
+   * await release({ bump: "minor" });
+   * ```
+   *
+   * GitHub Actions:
+   *
+   * ```yml
+   * - uses: aklinker1/zero-changelog/actions/release
+   *   with:
+   *     bump: ${{ inputs.version }}
+   * ```
+   *
+   * @default undefined
+   */
+  bump?: BumpBy;
+  /**
+   * The directory to release
+   *
+   * JS Usage:
+   *
+   * ```ts
+   * await release({ path: "packages/my-package" });
+   * ```
+   *
+   * GitHub Actions:
+   *
+   * ```yml
+   * - uses: aklinker1/zero-changelog/actions/release
+   *   with:
+   *     path: ${{ inputs.packageDir }}
+   * ```
+   *
+   * @default process.cwd()
+   */
+  path?: string;
+  /**
+   * Additional directories to include commits from when computing the version bump.
+   *
+   * > **IMPORTANT**: You may use glob patterns for ONLY the github action. They are not automatically
+   * > expanded when using the JS API. If you use the JS API and want to use glob patterns, [install a
+   * > glob pattern library](https://www.npmjs.com/search?q=glob) and call it yourself.
+   *
+   * JS Usage:
+   *
+   * ```ts
+   * await release({
+   *   path: "packages/my-package",
+   *   additionalDirs: ["../../.github", "../../scripts"],
+   * });
+   * ```
+   *
+   * GitHub Actions:
+   *
+   * ```yml
+   * - uses: aklinker1/zero-changelog/actions/release
+   *   with:
+   *     path: ${{ inputs.packageDir }}
+   *     additionalDirs: |-
+   *       ../../.github
+   *       ../../scripts
+   * ```
+   */
+  additionalDirs?: string[];
+  /**
+   * Tag prefix to use while generating the tag name.
+   *
+   * The default value changes based on {@link ReleaseOptions#path}:
+   *
+   * - When `undefined`, defaults to `"v"`
+   * - When set, defaults to `basename(path) + "-v"`
+   *
+   * JS Usage:
+   *
+   * ```ts
+   * await release({
+   *   tagPrefix: "npm-v",
+   * });
+   * ```
+   *
+   * GitHub Actions:
+   *
+   * ```yml
+   * - uses: aklinker1/zero-changelog/actions/release
+   *   with:
+   *     tagPrefix: npm-v
+   * ```
+   */
+  tagPrefix?: string;
+  /**
+   * Customize the commit message.
+   *
+   * Template vars:
+   *
+   * - `{{version}}`: The version after being bumped.
+   * - `{{path}}`: The {@link ReleaseOptions#path} relative to the current working directory.
+   * - `{{dirname}}`: The path's base name.
+   *
+   * JS Usage:
+   *
+   * ```ts
+   * await release({
+   *   path: "packages/my-package",
+   *   commitTemplate: "chore(release): My Package v{{version}}",
+   * });
+   * ```
+   *
+   * GitHub Actions:
+   *
+   * ```yml
+   * - uses: aklinker1/zero-changelog/actions/release
+   *   with:
+   *     path: packages/my-package
+   *     commitTemplate: "chore(release): My Package v{{version}}"
+   * ```
+   *
+   * @default "chore(release): v{{version}}"
+   */
+  commitTemplate?: string;
+  /**
+   * A git ref to use as the starting point when generating changelog and determining which version
+   * to bump to.
+   *
+   * When not provided, the last tag that starts with your {@link ReleaseOptions#tagPrefix} will be
+   * used.
+   *
+   * JS Usage:
+   *
+   * ```ts
+   * await release({
+   *   since: "some-tag",
+   * });
+   * ```
+   *
+   * GitHub Actions:
+   *
+   * ```yml
+   * - uses: aklinker1/zero-changelog/actions/release
+   *   with:
+   *     since: "some-tag"
+   * ```
+   */
+  since?: string;
+  /**
+   * If `true`, the release will not be committed or tagged.
+   *
+   * JS Usage:
+   *
+   * ```ts
+   * await release({
+   *   dryRun: true,
+   * });
+   * ```
+   *
+   * GitHub Actions:
+   *
+   * ```yml
+   * - uses: aklinker1/zero-changelog/actions/release
+   *   with:
+   *     dryRun: true
+   * ```
+   *
+   * @default false
+   */
+  dryRun?: boolean;
+  /**
+   * Customize the release title.
+   *
+   * Template vars:
+   *
+   * - `{{version}}`: The version after being bumped.
+   * - `{{tag}}`: The tag that will be used for the release.
+   * - `{{path}}`: The {@link ReleaseOptions#path} relative to the current working directory.
+   * - `{{dirname}}`: The path's base name.
+   *
+   * JS Usage:
+   *
+   * ```ts
+   * await release({
+   *   path: "packages/my-package",
+   *   releaseNameTemplate: "My Package {{version}}",
+   * });
+   * ```
+   *
+   * GitHub Actions:
+   *
+   * ```yml
+   * - uses: aklinker1/zero-changelog/actions/release
+   *   with:
+   *     path: "packages/my-package"
+   *     releaseNameTemplate: "My Package {{version}}"
+   * ```
+   *
+   * @default "{{tag}}"
+   */
+  releaseNameTemplate?: string;
+  /**
+   * A custom publish command to run before committing and creating the release.
+   *
+   * If not provided, nothing is ran.
+   *
+   * JS Usage:
+   *
+   * ```ts
+   * await release({
+   *   publishCommands: ["npm publish", "jsr publish"],
+   * });
+   * ```
+   *
+   * GitHub Actions:
+   *
+   * ```yml
+   * - uses: aklinker1/zero-changelog/actions/release
+   *   with:
+   *     publishCommands: |-
+   *       npm publish
+   *       jsr publish
+   * ```
+   */
+  publishCommands?: string[];
+  /**
+   * If your {@link ReleaseOptions#publishCommands} has a dry run variant, you can provide it here.
+   *
+   * When provided, this command will be ran instead of the regular publishCommands when
+   * {@link ReleaseOptions#dryRun} is true.
+   *
+   * JS Usage:
+   *
+   * ```ts
+   * await release({
+   *   dryRunPublishCommands: ["npm publish --dry-run", "jsr publish --dry-run"],
+   * });
+   * ```
+   *
+   * GitHub Actions:
+   *
+   * ```yml
+   * - uses: aklinker1/zero-changelog/actions/release
+   *   with:
+   *     dryRunPublishCommands: |-
+   *       npm publish --dry-run
+   *       jsr publish --dry-run
+   * ```
+   */
+  dryRunPublishCommands?: string[];
+  /**
+   * List of files to bump versions inside, relative to the {@link ReleaseOptions#path}.
+   *
+   * - If none of the files exist, an error will be thrown.
+   * - If the file is not present, the path will be logged.
+   *
+   * > **IMPORTANT**: You may use glob patterns for ONLY the github action. They are not automatically
+   * > expanded when using the JS API. If you use the JS API and want to use glob patterns, [install a
+   * > glob pattern library](https://www.npmjs.com/search?q=glob) and call it yourself.
+   *
+   * JS Usage:
+   *
+   * ```ts
+   * await release({
+   *   versionFiles: ["package.json", "jsr.json"],
+   * });
+   * ```
+   *
+   * GitHub Actions:
+   *
+   * ```yml
+   * - uses: aklinker1/zero-changelog/actions/release
+   *   with:
+   *     versionFiles: |-
+   *       package.json
+   *       jsr.json
+   * ```
+   *
+   * @default ["package.json", "jsr.json", "deno.json", "Cargo.toml"]
+   */
+  versionFiles?: string[];
+  /**
+   * List of paths to artifacts to upload on the github release. Does NOT support globs.
+   *
+   * > **IMPORTANT**: You may use glob patterns for ONLY the github action. They are not automatically
+   * > expanded when using the JS API. If you use the JS API and want to use glob patterns, [install a
+   * > glob pattern library](https://www.npmjs.com/search?q=glob) and call it yourself.
+   *
+   * JS Usage:
+   *
+   * ```ts
+   * await release({
+   *   releaseArtifacts: ["file1", "file2"],
+   * });
+   * ```
+   *
+   * GitHub Actions:
+   *
+   * ```yml
+   * - uses: aklinker1/zero-changelog/actions/release
+   *   with:
+   *     releaseArtifacts: |-
+   *       file1
+   *       file2
+   * ```
+   */
+  releaseArtifacts?: string[];
+  /**
+   * When `true`, throw an error if no commits contain semver changes. When `false` or `undefined`,
+   * use `bump: "patch"` when no changes are detected.
+   *
+   * > IMPORTANT**: This option is only effective when the {@link ReleaseOptions#bump} is `undefined`.
+   *
+   * @default false
+   */
+  throwOnNoChanges?: boolean;
+  /**
+   * The repo to create the release on.
+   *
+   * JS Usage:
+   *
+   * ```ts
+   * await release({
+   *   githubRepo: "aklinker1/zero-changelog",
+   * });
+   * ```
+   *
+   * GitHub Actions:
+   *
+   * ```yml
+   * - uses: aklinker1/zero-changelog/actions/release
+   *   with:
+   *     githubRepo: "some-other/repo" # Defaults to the current repo
+   * ```
+   */
+  githubRepo?: `${string}/${string}`;
+  /**
+   * A github API token with access to the repo for creating a release.
+   *
+   * JS Usage:
+   *
+   * ```ts
+   * await release({
+   *   githubToken: process.env.GITHUB_TOKEN!,
+   * });
+   * ```
+   *
+   * GitHub Actions:
+   *
+   * ```yml
+   * - uses: aklinker1/zero-changelog/actions/release
+   *   with:
+   *     githubToken: ${{ secrets.GITHUB_TOKEN }}
+   * ```
+   *
+   * @default process.env.GITHUB_TOKEN
+   */
+  githubToken?: string;
+  /**
+   * Set to false to prevent marking the github release as "latest"
+   *
+   * @default true
+   */
+  latestRelease?: boolean;
+};
+type ReleaseMeta = {
+  /** The new version it was bumped to. */version: string; /** The tag used. */
+  tag: string; /** The release notes added to the changelog for the version */
+  releaseNotes: string;
+};
+declare function release(options: ReleaseOptions): Promise<ReleaseMeta>;
+//#endregion
+export { ReleaseMeta, ReleaseOptions, release };

package/dist/release.mjs

@@ -0,0 +1,125 @@
+import { createGithubRelease } from "./create-github-release.mjs";
+import { detectVersionBump } from "./detect-version-bump.mjs";
+import { t as findPreviousTag } from "./find-previous-tag-Cj2oZAty.mjs";
+import { getCurrentVersion } from "./get-current-version.mjs";
+import { getGithubRepo } from "./get-github-repo.mjs";
+import { getReleaseNotes } from "./get-release-notes.mjs";
+import { t as listCommitsSince } from "./list-commits-since-DycWgHTi.mjs";
+import { parseChangelog } from "./parse-changelog.mjs";
+import { parseCommits } from "./parse-commits.mjs";
+import { n as template } from "./utils-BO6byvK5.mjs";
+import { isPrerelease, parseSemver } from "./semver.mjs";
+import { serializeChangelog } from "./serialize-changelog.mjs";
+import { updateVersionFiles } from "./update-version-files.mjs";
+import { exec } from "node:child_process";
+import { readFile, writeFile } from "node:fs/promises";
+import { basename, resolve } from "node:path";
+//#region src/internal/run.ts
+/** Run a command, inheriting stdio. */
+async function run(options) {
+	console.log("Running command:", options);
+	if (options.dryRun) {
+		console.log("  -> Skipping, dry run");
+		return;
+	}
+	return new Promise((resolve, reject) => {
+		const child = exec(options.cmd, { cwd: options.cwd }, (error) => {
+			if (error) return reject(error);
+			else resolve();
+		});
+		child.stderr?.on("data", (data) => {
+			process.stderr.write(data);
+		});
+		child.stdout?.on("data", (data) => {
+			process.stdout.write(data);
+		});
+	});
+}
+//#endregion
+//#region src/release.ts
+async function release(options) {
+	const { additionalDirs = [], commitTemplate = "chore(release): v{{version}}", dryRun = false, dryRunPublishCommands, publishCommands, releaseNameTemplate = "{{tag}}", versionFiles = [
+		"package.json",
+		"jsr.json",
+		"deno.json",
+		"Cargo.toml"
+	], releaseArtifacts = [], throwOnNoChanges = false, githubToken = process.env.GITHUB_TOKEN, githubRepo = await getGithubRepo(), latestRelease = true } = options;
+	const cwd = process.cwd();
+	const path = options.path ? resolve(options.path) : cwd;
+	const dirname = basename(path);
+	const tagPrefix = path === cwd ? "v" : `${dirname}-v`;
+	if (!githubToken) throw Error("No github token provided");
+	if (!githubRepo) throw Error("No github repo provided");
+	const currentVersion = parseSemver(await getCurrentVersion(path, versionFiles));
+	const since = options.since ?? await findPreviousTag(tagPrefix);
+	const changes = parseCommits(await listCommitsSince({
+		since,
+		dirs: [path, ...additionalDirs]
+	}));
+	const bump = (options.bump?.trim() || void 0) ?? detectVersionBump(changes, throwOnNoChanges);
+	const version = currentVersion.bump(bump);
+	const tag = tagPrefix + version;
+	console.log("Bumping version to:", version);
+	console.log("Tag:", tag);
+	await updateVersionFiles(path, versionFiles, version);
+	const releaseNotes = getReleaseNotes(changes, since, tag, githubRepo);
+	const changelog = parseChangelog(await readFile("CHANGELOG.md", "utf8"));
+	changelog.unshift({
+		header: `v${version}`,
+		body: releaseNotes
+	});
+	await writeFile("CHANGELOG.md", serializeChangelog(changelog), "utf8");
+	if (dryRun && dryRunPublishCommands?.length) for (const cmd of dryRunPublishCommands) await run({
+		dryRun: false,
+		cwd: path,
+		cmd
+	});
+	else if (publishCommands?.length) for (const cmd of publishCommands) await run({
+		dryRun,
+		cwd: path,
+		cmd
+	});
+	await run({
+		dryRun,
+		cwd: path,
+		cmd: `git commit -am "${template(commitTemplate, {
+			version,
+			path,
+			dirname
+		})}"`
+	});
+	await run({
+		dryRun,
+		cwd: path,
+		cmd: `git tag ${tag}`
+	});
+	await run({
+		dryRun,
+		cwd: path,
+		cmd: "git push"
+	});
+	await run({
+		dryRun,
+		cwd: path,
+		cmd: "git push --tags"
+	});
+	await createGithubRelease({
+		repo: githubRepo,
+		token: githubToken,
+		dryRun,
+		tag,
+		name: template(releaseNameTemplate, {
+			version,
+			tag,
+			path,
+			dirname
+		}),
+		body: releaseNotes,
+		artifacts: releaseArtifacts,
+		latest: latestRelease,
+		prerelease: isPrerelease(parseSemver(version))
+	});
+	throw Error("Not implemented");
+}
+//#endregion
+export { release };

package/dist/semver-type--Q1lYCiZ.d.mts

@@ -0,0 +1,11 @@
+//#region src/semver-type.d.ts
+type SemverType = {
+  /** The title of the section for this type of commit in the changelog. */title: string;
+  /**
+   * Describe how this type of conventional commit should bump the version when detecting the type
+   * of version bump based on the commits.
+   */
+  bump?: "minor" | "patch";
+};
+//#endregion
+export { SemverType as t };

package/dist/semver-type-map.d.mts

@@ -0,0 +1,8 @@
+import { t as SemverType } from "./semver-type--Q1lYCiZ.mjs";
+
+//#region src/semver-type-map.d.ts
+type SemverTypeMap = {
+  [type: string]: SemverType;
+};
+//#endregion
+export { SemverTypeMap };

package/dist/semver-type-map.mjs

@@ -0,0 +1 @@
+export {};

package/dist/semver-type.d.mts

@@ -0,0 +1,2 @@
+import { t as SemverType } from "./semver-type--Q1lYCiZ.mjs";
+export { SemverType };

package/dist/semver-type.mjs

@@ -0,0 +1 @@
+export {};

package/dist/semver-types/aklinker1.d.mts

@@ -0,0 +1,6 @@
+import { SemverTypeMap } from "../semver-type-map.mjs";
+
+//#region src/semver-types/aklinker1.d.ts
+declare const types: SemverTypeMap;
+//#endregion
+export { types as default };

package/dist/semver-types/aklinker1.mjs

@@ -0,0 +1,38 @@
+//#region src/semver-types/aklinker1.ts
+const types = {
+	feat: {
+		title: "🚀 Features",
+		bump: "minor"
+	},
+	perf: {
+		title: "🔥 Performance",
+		bump: "patch"
+	},
+	fix: {
+		title: "🩹 Fixes",
+		bump: "patch"
+	},
+	refactor: {
+		title: "💅 Refactors",
+		bump: "patch"
+	},
+	docs: {
+		title: "📖 Documentation",
+		bump: "patch"
+	},
+	build: {
+		title: "📦 Build",
+		bump: "patch"
+	},
+	types: {
+		title: "🌊 Types",
+		bump: "patch"
+	},
+	chore: { title: "🏡 Chore" },
+	examples: { title: "🏀 Examples" },
+	test: { title: "✅ Tests" },
+	style: { title: "🎨 Styles" },
+	ci: { title: "🤖 CI" }
+};
+//#endregion
+export { types as default };

package/dist/semver.d.mts

@@ -0,0 +1,37 @@
+//#region src/semver.d.ts
+type RelativeBump = "major" | "minor" | "patch";
+type BumpBy = RelativeBump | (string & {});
+interface Semver {
+  type: unknown;
+  version: string;
+  bump(this: void, by: BumpBy): string;
+  compare(this: void, other: Semver): -1 | 0 | 1;
+}
+declare const STABLE_TYPE: unique symbol;
+interface StableVersion extends Semver {
+  type: typeof STABLE_TYPE;
+  major: number;
+  minor: number;
+  patch: number;
+}
+declare function parseSemver(version: string): Semver;
+declare function isStable(semver: Semver): semver is StableVersion;
+declare const UNSTABLE_TYPE: unique symbol;
+interface UnstableVersion extends Semver {
+  type: typeof UNSTABLE_TYPE;
+  major: 0;
+  minor: number;
+  patch: number;
+}
+declare function isUnstable(semver: Semver): semver is UnstableVersion;
+declare const PRERELEASE_TYPE: unique symbol;
+interface PrereleaseVersion extends Semver {
+  type: typeof PRERELEASE_TYPE;
+  major: number;
+  prerelease: number;
+  prereleaseType: PrereleaseType;
+}
+type PrereleaseType = "alpha" | "beta" | "rc";
+declare function isPrerelease(semver: Semver): semver is PrereleaseVersion;
+//#endregion
+export { BumpBy, PrereleaseType, PrereleaseVersion, RelativeBump, Semver, StableVersion, UnstableVersion, isPrerelease, isStable, isUnstable, parseSemver };