aronrepo 2.2.1 → 3.0.1

package/README.md

@@ -2,60 +2,72 @@
 
 # aronrepo
 
-Facade install target for the Aronrepo monorepo toolchain.
+One commit standard and one release engine for JavaScript repositories, built so the repository owner and coding agents follow the same rules. It replaces semantic-release, commitlint, and changelog presets.
 
-Use this package when you want one dependency that brings the published Aronrepo toolchain packages for conventional commits, commitlint configuration, changelog generation, semantic-release configuration, and pnpm workspace publishing. The package also provides a small programmatic entrypoint that names those packages.
+## Install
 
-The package has no runtime side effects and does not configure commitlint, changelog generation, or semantic-release by itself.
+```sh
+bun add -d aronrepo husky
+```
 
-## Install
+`pnpm add -D aronrepo husky` and `npm install -D aronrepo husky` work too. This package is ESM-only and has no peer tools.
 
-For complete adoption, install the facade package plus the external peer tools used by your repository commands:
+## Configure
 
-```sh
-pnpm add -D aronrepo @commitlint/cli semantic-release
+```js
+// aronrepo.config.js
+/** @type {import('aronrepo').AronrepoConfig} */
+export default {
+    release: {
+        mode: 'explicit' // or 'auto'
+    }
+}
 ```
 
-For programmatic package-list usage only:
+```sh
+# .husky/commit-msg
+aronrepo check --edit "$1"
+```
 
 ```sh
-pnpm add -D aronrepo
+bun x aronrepo agents --write
+bun x aronrepo doctor
 ```
 
-This package is ESM-only.
+In `explicit` mode (the default) only `Bump(Minor)` and `Bump(Major)` raise minor and major versions. In `auto` mode `Add` releases a minor version and a `BREAKING CHANGE:` footer releases a major version. A release type that changes no published file releases nothing.
 
-## Usage
+## Commit Types
 
-```ts
-import { packages } from 'aronrepo'
+`Type(Scope): Summary`, with a summary that starts with an uppercase letter or digit and has no trailing period.
 
-console.log(packages)
-```
+| Release | Types |
+| --- | --- |
+| Owner decides | `Bump(Major)`, `Bump(Minor)`, `Bump(Patch)` |
+| Patch (`Add`: minor in `auto`) | `Add`, `Improve`, `Perf`, `Fix`, `Deprecate`, `Drop`, `Upgrade`, `Revert`, `Docs(README)` |
+| None | `Docs`, `Test`, `Benchmark`, `Example`, `Build`, `CI`, `Style`, `Refactor`, `Chore` |
 
-`packages` is a readonly list of the Aronrepo toolchain package names:
+`aronrepo policy --json` describes when to use each type. `Feat`, `New`, `Update`, and `Misc` are legacy types that `aronrepo check` rejects.
 
-```ts
-[
-    '@aronrepo/commitlint-config',
-    '@aronrepo/conventional-commits',
-    '@aronrepo/conventional-changelog-config',
-    '@aronrepo/semantic-release-config',
-    '@aronrepo/semantic-release-pnpm'
-]
-```
+## Commands
 
-## Toolchain Packages
+| Command | Use |
+| --- | --- |
+| `aronrepo check` | check a commit message, a commit range, or a PR title |
+| `aronrepo explain` | print the next version and the reason for each commit |
+| `aronrepo release [--dry-run]` | publish the packages, push the version tag, and create the GitHub release |
+| `aronrepo policy [--json]` | print the policy |
+| `aronrepo agents [--write]` | check or regenerate the policy block in `AGENTS.md` |
+| `aronrepo doctor` | check the setup |
 
-- `@aronrepo/conventional-commits`: commit types, release impact rules, changelog groups, and AI agent policy.
-- `@aronrepo/commitlint-config`: commitlint rules for Aronrepo commit and PR title validation.
-- `@aronrepo/conventional-changelog-config`: parser, writer, and recommended bump options for conventional changelog tooling.
-- `@aronrepo/semantic-release-config`: semantic-release defaults and workspace package discovery.
-- `@aronrepo/semantic-release-pnpm`: semantic-release plugin for publishing pnpm workspace packages.
+`aronrepo release` publishes `main` on `latest` and `alpha`, `beta`, `rc`, and `canary` as prereleases on their own dist-tags. It publishes every package on a staging dist-tag first, moves the channel's dist-tag once all of them are on the registry, and resumes an interrupted run.
 
-## AI Coding Adoption
+## API
 
-For a complete adoption prompt that an AI coding agent can use in another repository, see the root guide:
+```js
+import { parseCommit, resolveRelease, renderReleaseNotes } from 'aronrepo'
+import { planRelease, explainRange } from 'aronrepo/node'
+```
 
-- [AI Coding Integration](https://github.com/1aron/aronrepo/blob/main/docs/ai-coding.md)
+`aronrepo` exports the commit standard without Node dependencies; `aronrepo/node` exports the config loader, git and workspace helpers, the release engine, and the CLI commands.
 
-The prompt tells the agent to inspect the target repository first, install the `aronrepo` facade and required peer tools, configure commitlint and semantic-release, document release behavior, and add agent guidance without unrelated refactors.
+See the [Aronrepo repository](https://github.com/1aron/aronrepo#readme) for release branches, CI setup, AI coding integration, and migrating from Aronrepo 2.

package/dist/cli.d.ts

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

package/dist/cli.js

@@ -0,0 +1,110 @@
+#!/usr/bin/env node
+import { releaseModes } from "./index.js";
+import { c as release, i as explain, n as check, o as policy, r as doctor, t as agents } from "./commands-BRnoLH3z.js";
+import { parseArgs } from "node:util";
+// src/cli.ts
+const help = `Usage: aronrepo <command> [options]
+
+Commands:
+  check     Check commits against the release policy
+            --edit <file>             commit-msg hook: message file + staged files
+            --message <text>          a message + staged files (or --files)
+            --title <text> [--base <ref> --head <ref>]   a PR title + PR diff
+            --from <ref> [--to <ref>] every commit in a range
+  explain   Print the next release and the reason for each commit
+            [--from <ref>] [--to <ref>]   defaults to the release range of the branch
+  release   Publish the next release: npm packages, the version tag, and the GitHub release
+            [--dry-run] [--branch <name>]  prints the plan and notes without changes
+  policy    Print the release policy [--json | --markdown]
+  agents    Check the AGENTS.md policy block, or regenerate it with --write [--file <path>]
+  doctor    Check the Aronrepo setup of this repository
+
+Options:
+  --cwd <dir>                   repository root (default: current directory)
+  --mode <explicit|auto>        override release.mode from aronrepo.config.js
+  --json                        machine-readable output
+`;
+async function main(argv) {
+	const { positionals, values } = parseArgs({
+		args: argv,
+		allowPositionals: true,
+		options: {
+			cwd: { type: "string" },
+			mode: { type: "string" },
+			json: { type: "boolean" },
+			markdown: { type: "boolean" },
+			write: { type: "boolean" },
+			check: { type: "boolean" },
+			file: { type: "string" },
+			edit: { type: "string" },
+			message: { type: "string" },
+			title: { type: "string" },
+			base: { type: "string" },
+			head: { type: "string" },
+			from: { type: "string" },
+			to: { type: "string" },
+			files: { type: "string" },
+			"dry-run": { type: "boolean" },
+			branch: { type: "string" },
+			help: {
+				type: "boolean",
+				short: "h"
+			}
+		}
+	});
+	const [command] = positionals;
+	if (!command || values.help) return {
+		code: command || values.help ? 0 : 2,
+		output: help
+	};
+	if (values.mode && !releaseModes.includes(values.mode)) return {
+		code: 2,
+		output: `--mode must be one of: ${releaseModes.join(", ")}`
+	};
+	const common = {
+		...values.cwd ? { cwd: values.cwd } : {},
+		...values.mode ? { mode: values.mode } : {},
+		...values.json ? { json: true } : {}
+	};
+	const optional = (...keys) => Object.fromEntries(keys.filter((key) => values[key] !== void 0).map((key) => [key, values[key]]));
+	switch (command) {
+		case "check": return check({
+			...common,
+			...optional("edit", "message", "title", "base", "head", "from", "to"),
+			...values.files !== void 0 ? { files: values.files.split(",").map((file) => file.trim()).filter(Boolean) } : {}
+		});
+		case "explain": return explain({
+			...common,
+			...optional("from", "to")
+		});
+		case "release": return release({
+			...common,
+			...optional("branch"),
+			...values["dry-run"] ? { dryRun: true } : {}
+		});
+		case "policy": return policy({
+			...common,
+			...values.markdown ? { markdown: true } : {}
+		});
+		case "agents": return agents({
+			...common,
+			...optional("file"),
+			...values.write ? { write: true } : {}
+		});
+		case "doctor": return doctor(common);
+		default: return {
+			code: 2,
+			output: `Unknown command "${command}".\n\n${help}`
+		};
+	}
+}
+main(process.argv.slice(2)).then(({ code, output }) => {
+	if (output) (code === 0 ? process.stdout : process.stderr).write(`${output}\n`);
+	process.exitCode = code;
+}).catch((error) => {
+	process.stderr.write(`${error instanceof Error ? error.message : String(error)}\n`);
+	process.exitCode = 1;
+});
+export {};
+
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","names":[],"sources":["../src/cli.ts"],"sourcesContent":["#!/usr/bin/env node\nimport { parseArgs } from 'node:util'\nimport { releaseModes, type ReleaseMode } from './index'\nimport { agents, check, doctor, explain, policy, release, type CommandResult } from './commands'\n\nconst help = `Usage: aronrepo <command> [options]\n\nCommands:\n  check     Check commits against the release policy\n            --edit <file>             commit-msg hook: message file + staged files\n            --message <text>          a message + staged files (or --files)\n            --title <text> [--base <ref> --head <ref>]   a PR title + PR diff\n            --from <ref> [--to <ref>] every commit in a range\n  explain   Print the next release and the reason for each commit\n            [--from <ref>] [--to <ref>]   defaults to the release range of the branch\n  release   Publish the next release: npm packages, the version tag, and the GitHub release\n            [--dry-run] [--branch <name>]  prints the plan and notes without changes\n  policy    Print the release policy [--json | --markdown]\n  agents    Check the AGENTS.md policy block, or regenerate it with --write [--file <path>]\n  doctor    Check the Aronrepo setup of this repository\n\nOptions:\n  --cwd <dir>                   repository root (default: current directory)\n  --mode <explicit|auto>        override release.mode from aronrepo.config.js\n  --json                        machine-readable output\n`\n\nasync function main(argv: string[]): Promise<CommandResult> {\n    const { positionals, values } = parseArgs({\n        args: argv,\n        allowPositionals: true,\n        options: {\n            cwd: { type: 'string' },\n            mode: { type: 'string' },\n            json: { type: 'boolean' },\n            markdown: { type: 'boolean' },\n            write: { type: 'boolean' },\n            check: { type: 'boolean' },\n            file: { type: 'string' },\n            edit: { type: 'string' },\n            message: { type: 'string' },\n            title: { type: 'string' },\n            base: { type: 'string' },\n            head: { type: 'string' },\n            from: { type: 'string' },\n            to: { type: 'string' },\n            files: { type: 'string' },\n            'dry-run': { type: 'boolean' },\n            branch: { type: 'string' },\n            help: { type: 'boolean', short: 'h' }\n        }\n    })\n    const [command] = positionals\n    if (!command || values.help) return { code: command || values.help ? 0 : 2, output: help }\n    if (values.mode && !releaseModes.includes(values.mode as ReleaseMode)) {\n        return { code: 2, output: `--mode must be one of: ${releaseModes.join(', ')}` }\n    }\n    const common = {\n        ...(values.cwd ? { cwd: values.cwd } : {}),\n        ...(values.mode ? { mode: values.mode as ReleaseMode } : {}),\n        ...(values.json ? { json: true } : {})\n    }\n    const optional = <K extends keyof typeof values>(...keys: K[]) =>\n        Object.fromEntries(keys.filter((key) => values[key] !== undefined).map((key) => [key, values[key]]))\n\n    switch (command) {\n        case 'check':\n            return check({\n                ...common,\n                ...optional('edit', 'message', 'title', 'base', 'head', 'from', 'to'),\n                ...(values.files !== undefined ? { files: values.files.split(',').map((file) => file.trim()).filter(Boolean) } : {})\n            })\n        case 'explain':\n            return explain({ ...common, ...optional('from', 'to') })\n        case 'release':\n            return release({ ...common, ...optional('branch'), ...(values['dry-run'] ? { dryRun: true } : {}) })\n        case 'policy':\n            return policy({ ...common, ...(values.markdown ? { markdown: true } : {}) })\n        case 'agents':\n            return agents({ ...common, ...optional('file'), ...(values.write ? { write: true } : {}) })\n        case 'doctor':\n            return doctor(common)\n        default:\n            return { code: 2, output: `Unknown command \"${command}\".\\n\\n${help}` }\n    }\n}\n\nmain(process.argv.slice(2))\n    .then(({ code, output }) => {\n        if (output) (code === 0 ? process.stdout : process.stderr).write(`${output}\\n`)\n        process.exitCode = code\n    })\n    .catch((error: unknown) => {\n        process.stderr.write(`${error instanceof Error ? error.message : String(error)}\\n`)\n        process.exitCode = 1\n    })\n"],"mappings":";;;;;AAKA,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;AAsBb,eAAe,KAAK,MAAwC;CACxD,MAAM,EAAE,aAAa,WAAW,UAAU;EACtC,MAAM;EACN,kBAAkB;EAClB,SAAS;GACL,KAAK,EAAE,MAAM,SAAS;GACtB,MAAM,EAAE,MAAM,SAAS;GACvB,MAAM,EAAE,MAAM,UAAU;GACxB,UAAU,EAAE,MAAM,UAAU;GAC5B,OAAO,EAAE,MAAM,UAAU;GACzB,OAAO,EAAE,MAAM,UAAU;GACzB,MAAM,EAAE,MAAM,SAAS;GACvB,MAAM,EAAE,MAAM,SAAS;GACvB,SAAS,EAAE,MAAM,SAAS;GAC1B,OAAO,EAAE,MAAM,SAAS;GACxB,MAAM,EAAE,MAAM,SAAS;GACvB,MAAM,EAAE,MAAM,SAAS;GACvB,MAAM,EAAE,MAAM,SAAS;GACvB,IAAI,EAAE,MAAM,SAAS;GACrB,OAAO,EAAE,MAAM,SAAS;GACxB,WAAW,EAAE,MAAM,UAAU;GAC7B,QAAQ,EAAE,MAAM,SAAS;GACzB,MAAM;IAAE,MAAM;IAAW,OAAO;GAAI;EACxC;CACJ,CAAC;CACD,MAAM,CAAC,WAAW;CAClB,IAAI,CAAC,WAAW,OAAO,MAAM,OAAO;EAAE,MAAM,WAAW,OAAO,OAAO,IAAI;EAAG,QAAQ;CAAK;CACzF,IAAI,OAAO,QAAQ,CAAC,aAAa,SAAS,OAAO,IAAmB,GAChE,OAAO;EAAE,MAAM;EAAG,QAAQ,0BAA0B,aAAa,KAAK,IAAI;CAAI;CAElF,MAAM,SAAS;EACX,GAAI,OAAO,MAAM,EAAE,KAAK,OAAO,IAAI,IAAI,CAAC;EACxC,GAAI,OAAO,OAAO,EAAE,MAAM,OAAO,KAAoB,IAAI,CAAC;EAC1D,GAAI,OAAO,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACxC;CACA,MAAM,YAA2C,GAAG,SAChD,OAAO,YAAY,KAAK,QAAQ,QAAQ,OAAO,SAAS,KAAA,CAAS,CAAC,CAAC,KAAK,QAAQ,CAAC,KAAK,OAAO,IAAI,CAAC,CAAC;CAEvG,QAAQ,SAAR;EACI,KAAK,SACD,OAAO,MAAM;GACT,GAAG;GACH,GAAG,SAAS,QAAQ,WAAW,SAAS,QAAQ,QAAQ,QAAQ,IAAI;GACpE,GAAI,OAAO,UAAU,KAAA,IAAY,EAAE,OAAO,OAAO,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,OAAO,OAAO,EAAE,IAAI,CAAC;EACtH,CAAC;EACL,KAAK,WACD,OAAO,QAAQ;GAAE,GAAG;GAAQ,GAAG,SAAS,QAAQ,IAAI;EAAE,CAAC;EAC3D,KAAK,WACD,OAAO,QAAQ;GAAE,GAAG;GAAQ,GAAG,SAAS,QAAQ;GAAG,GAAI,OAAO,aAAa,EAAE,QAAQ,KAAK,IAAI,CAAC;EAAG,CAAC;EACvG,KAAK,UACD,OAAO,OAAO;GAAE,GAAG;GAAQ,GAAI,OAAO,WAAW,EAAE,UAAU,KAAK,IAAI,CAAC;EAAG,CAAC;EAC/E,KAAK,UACD,OAAO,OAAO;GAAE,GAAG;GAAQ,GAAG,SAAS,MAAM;GAAG,GAAI,OAAO,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAC;EAAG,CAAC;EAC9F,KAAK,UACD,OAAO,OAAO,MAAM;EACxB,SACI,OAAO;GAAE,MAAM;GAAG,QAAQ,oBAAoB,QAAQ,QAAQ;EAAO;CAC7E;AACJ;AAEA,KAAK,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,CACtB,MAAM,EAAE,MAAM,aAAa;CACxB,IAAI,QAAQ,CAAC,SAAS,IAAI,QAAQ,SAAS,QAAQ,OAAA,CAAQ,MAAM,GAAG,OAAO,GAAG;CAC9E,QAAQ,WAAW;AACvB,CAAC,CAAC,CACD,OAAO,UAAmB;CACvB,QAAQ,OAAO,MAAM,GAAG,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,EAAE,GAAG;CAClF,QAAQ,WAAW;AACvB,CAAC"}