bstack 1.1.6 → 1.2.0

package/README.md

@@ -73,6 +73,11 @@ git rebase --continue
 bstack
 ```
 
+### Reorder pull requests
+
+Reorder the corresponding commits with Git, then run `bstack` again.
+`bstack` keeps the existing pull request identities and rebuilds the native GitHub stack in the new commit order.
+
 Stacks cannot contain merge commits.
 When `main` moves, rebase your branch onto it instead of merging `main` into your branch.
 

package/dist/bstack.mjs

@@ -6,7 +6,7 @@ import * as v from "valibot";
 import { mkdirSync, readFileSync, renameSync, writeFileSync } from "node:fs";
 import { dirname } from "node:path";
 //#region package.json
-var version = "1.1.6";
+var version = "1.2.0";
 //#endregion
 //#region src/command.ts
 var CommandError = class extends Error {
@@ -59,7 +59,7 @@ function checkoutStack(dependencies, options) {
 	const { repository, github, reporter } = dependencies;
 	reporter.progress("Checking the repository and GitHub prerequisites");
 	repository.assertReady();
-	repository.assertClean();
+	if (!repository.isClean()) throw new Error("The working tree must be clean before checkout");
 	github.assertReady();
 	const remote = repository.resolveRemote(options.remote);
 	reporter.progress(`Looking up pull request ${options.reference}`);
@@ -168,8 +168,8 @@ var GitCliRepository = class {
 	assertReady() {
 		this.git(["rev-parse", "--show-toplevel"]);
 	}
-	assertClean() {
-		if (this.git(["status", "--porcelain"]).stdout.trim()) throw new Error("The working tree must be clean before checkout");
+	isClean() {
+		return this.git(["status", "--porcelain"]).stdout.trim() === "";
 	}
 	currentBranch() {
 		return this.git([
@@ -177,7 +177,7 @@ var GitCliRepository = class {
 			"--quiet",
 			"--short",
 			"HEAD"
-		], { allowFailure: true }).stdout.trim();
+		], { allowFailure: true }).stdout.trim() || void 0;
 	}
 	resolveRemote(requested) {
 		if (requested) {
@@ -327,6 +327,14 @@ const pullRequestSchema = v.object({
 	body: v.string(),
 	isDraft: v.boolean()
 });
+const createdPullRequestSchema = v.object({
+	number: v.number(),
+	html_url: v.string(),
+	state: v.picklist(["open", "closed"]),
+	title: v.string(),
+	body: v.nullable(v.string()),
+	draft: v.boolean()
+});
 const stackSchema = v.object({ number: v.number() });
 var GitHubCliPlatform = class {
 	cwd;
@@ -392,25 +400,33 @@ var GitHubCliPlatform = class {
 		return v.parse(pullRequestSchema, JSON.parse(raw));
 	}
 	createPullRequest(change, base, draft) {
-		const args = [
-			"pr",
-			"create",
-			"--base",
-			base,
-			"--head",
-			change.remoteBranch,
-			"--title",
-			change.subject,
-			"--body",
-			change.body
-		];
-		if (draft) args.push("--draft");
-		this.gh(args);
-		const created = this.pullRequestForBranch(change.remoteBranch);
-		if (!created) throw new Error(`GitHub did not return the PR created for ${change.remoteBranch}`);
-		return created;
+		const raw = this.gh([
+			"api",
+			"--method",
+			"POST",
+			"repos/{owner}/{repo}/pulls",
+			"--raw-field",
+			`base=${base}`,
+			"--raw-field",
+			`head=${change.remoteBranch}`,
+			"--raw-field",
+			`title=${change.subject}`,
+			"--raw-field",
+			`body=${change.body}`,
+			"--field",
+			`draft=${draft}`
+		]).stdout;
+		const created = v.parse(createdPullRequestSchema, JSON.parse(raw));
+		return {
+			number: created.number,
+			url: created.html_url,
+			state: created.state === "open" ? "OPEN" : "CLOSED",
+			title: created.title,
+			body: created.body ?? "",
+			isDraft: created.draft
+		};
 	}
-	linkStack(branches, base, remote, draft) {
+	linkStack(pullRequests, base, remote, draft) {
 		const args = [
 			"stack",
 			"link",
@@ -420,10 +436,10 @@ var GitHubCliPlatform = class {
 			remote
 		];
 		if (!draft) args.push("--open");
-		args.push(...branches);
+		args.push(...pullRequests.map(String));
 		this.gh(args);
 	}
-	appendToStack(stackNumber, branches, remote, draft) {
+	appendToStack(stackNumber, pullRequests, remote, draft) {
 		const args = [
 			"stack",
 			"link",
@@ -431,7 +447,7 @@ var GitHubCliPlatform = class {
 			remote
 		];
 		if (!draft) args.push("--open");
-		args.push(String(stackNumber), ...branches);
+		args.push(String(stackNumber), ...pullRequests.map(String));
 		this.gh(args);
 	}
 	unstack(stackNumber) {
@@ -606,7 +622,6 @@ var Stack = class Stack {
 		const currentIds = this.changes.map((change) => change.id);
 		const previousIdSet = new Set(previousIds);
 		const currentIdSet = new Set(currentIds);
-		if (!sameSequence(previousIds.filter((id) => currentIdSet.has(id)), currentIds.filter((id) => previousIdSet.has(id)))) throw new Error("Submitted commits cannot be reordered. Restore their original relative order before syncing");
 		const removed = previous.changes.filter((change) => !currentIdSet.has(change.id));
 		const added = this.changes.filter((change) => !previousIdSet.has(change.id));
 		if (removed.length === 0) {
@@ -615,7 +630,7 @@ var Stack = class Stack {
 			return stackNumber === void 0 ? { kind: "full" } : {
 				kind: "rebuild",
 				stackNumber,
-				action: "insert"
+				action: added.length === 0 ? "reorder" : "insert"
 			};
 		}
 		const firstCurrentIndex = previousIds.indexOf(currentIds[0]);
@@ -651,9 +666,6 @@ var Stack = class Stack {
 		};
 	}
 };
-function sameSequence(left, right) {
-	return left.length === right.length && left.every((value, index) => value === right[index]);
-}
 //#endregion
 //#region src/sync.ts
 function syncStack(dependencies, options) {
@@ -690,24 +702,44 @@ function syncStack(dependencies, options) {
 	const state = stateStore.read();
 	const previous = stack.findPrevious(state);
 	const transition = stack.transitionFrom(previous, {
-		preserveHigherChanges: repository.currentBranch() === "",
+		preserveHigherChanges: repository.currentBranch() === void 0,
 		lookups: {
 			pullRequestState: (pullRequest) => github.pullRequest(pullRequest).state,
 			stackNumberForPullRequest: (pullRequest) => github.stackNumberForPullRequest(pullRequest)
 		}
 	});
+	const isReorder = transition.kind === "rebuild" && transition.action === "reorder";
+	if (isReorder) {
+		reporter.progress(`Preparing stack #${transition.stackNumber} for reordered branches`);
+		github.unstack(transition.stackNumber);
+		try {
+			for (const change of previous.changes) github.editPullRequestBase(github.pullRequest(change.pullRequest), base);
+		} catch (error) {
+			restorePreviousStack(github, previous, base, remote, reporter, error);
+		}
+	}
 	reporter.progress(`Pushing ${changes.length} remote branch${changes.length === 1 ? "" : "es"}`);
-	repository.pushBranches(remote, changes.map((change) => ({
-		name: change.remoteBranch,
-		oid: change.oid
-	})));
+	try {
+		repository.pushBranches(remote, changes.map((change) => ({
+			name: change.remoteBranch,
+			oid: change.oid
+		})));
+	} catch (error) {
+		if (isReorder) restorePreviousStack(github, previous, base, remote, reporter, error);
+		throw error;
+	}
 	reporter.progress("Looking up existing pull requests");
 	const existing = changes.map((change) => github.pullRequestForBranch(change.remoteBranch));
-	let pullRequests;
+	const pullRequests = changes.map((change, index) => {
+		const current = existing[index];
+		if (current) return current;
+		const pullRequestBase = index === 0 ? base : changes[index - 1].remoteBranch;
+		reporter.progress(`Creating pull request: ${change.subject}`);
+		return github.createPullRequest(change, pullRequestBase, options.draft);
+	});
 	if (changes.length === 1) {
 		if (transition.kind === "partial") reporter.progress("Updating this down-stack prefix while preserving higher pull requests");
-		reporter.progress(existing[0] ? "Using the existing pull request" : "Creating a pull request");
-		const pullRequest = existing[0] ?? github.createPullRequest(changes[0], base, options.draft);
+		const pullRequest = pullRequests[0];
 		if (transition.kind === "collapse") {
 			reporter.progress(`Removing omitted pull requests from stack #${transition.stackNumber}`);
 			github.unstack(transition.stackNumber);
@@ -717,30 +749,27 @@ function syncStack(dependencies, options) {
 				restorePreviousStack(github, previous, base, remote, reporter, error);
 			}
 		}
-		pullRequests = [pullRequest];
-	} else {
-		if (transition.kind === "full") {
-			reporter.progress(`Linking ${changes.length} pull requests as a native GitHub stack`);
-			github.linkStack(changes.map((change) => change.remoteBranch), base, remote, options.draft);
-		} else if (transition.kind === "rebuild") {
-			reporter.progress(`Rebuilding stack #${transition.stackNumber} to ${transition.action} pull requests`);
-			github.unstack(transition.stackNumber);
-			try {
-				github.linkStack(changes.map((change) => change.remoteBranch), base, remote, options.draft);
-			} catch (error) {
-				restorePreviousStack(github, previous, base, remote, reporter, error);
-			}
-		} else if (transition.kind === "append") {
-			reporter.progress(`Appending ${transition.branches.length} pull request${transition.branches.length === 1 ? "" : "s"} to stack #${transition.stackNumber}`);
-			github.appendToStack(transition.stackNumber, transition.branches, remote, options.draft);
-		} else if (transition.kind === "partial") reporter.progress("Updating this down-stack prefix while preserving higher pull requests");
-		else reporter.progress("The native GitHub stack already has the correct members");
-		pullRequests = changes.map((change, index) => {
-			const pr = existing[index] ?? github.pullRequestForBranch(change.remoteBranch);
-			if (!pr) throw new Error(`GitHub did not return a PR for ${change.remoteBranch}`);
-			return pr;
-		});
-	}
+	} else if (transition.kind === "full") {
+		reporter.progress(`Linking ${changes.length} pull requests as a native GitHub stack`);
+		github.linkStack(pullRequests.map((pullRequest) => pullRequest.number), base, remote, options.draft);
+	} else if (transition.kind === "rebuild") {
+		reporter.progress(`Rebuilding stack #${transition.stackNumber} to ${transition.action} pull requests`);
+		if (!isReorder) github.unstack(transition.stackNumber);
+		try {
+			github.linkStack(pullRequests.map((pullRequest) => pullRequest.number), base, remote, options.draft);
+		} catch (error) {
+			restorePreviousStack(github, previous, base, remote, reporter, error);
+		}
+	} else if (transition.kind === "append") {
+		reporter.progress(`Appending ${transition.branches.length} pull request${transition.branches.length === 1 ? "" : "s"} to stack #${transition.stackNumber}`);
+		github.appendToStack(transition.stackNumber, transition.branches.map((branch) => {
+			const index = changes.findIndex((change) => change.remoteBranch === branch);
+			const pullRequest = pullRequests[index];
+			if (!pullRequest) throw new Error(`Missing pull request for ${branch}`);
+			return pullRequest.number;
+		}), remote, options.draft);
+	} else if (transition.kind === "partial") reporter.progress("Updating this down-stack prefix while preserving higher pull requests");
+	else reporter.progress("The native GitHub stack already has the correct members");
 	reporter.progress("Synchronizing pull request titles and descriptions");
 	for (const [index, pr] of pullRequests.entries()) {
 		github.editPullRequest(pr, changes[index]);
@@ -775,7 +804,7 @@ function restorePreviousStack(github, previous, base, remote, reporter, rebuildE
 	const rebuildMessage = rebuildError instanceof Error ? rebuildError.message : String(rebuildError);
 	reporter.progress("Rebuild failed; restoring the previous native GitHub stack");
 	try {
-		github.linkStack(previous.changes.map((change) => change.remoteBranch), base, remote, true);
+		github.linkStack(previous.changes.map((change) => change.pullRequest), base, remote, true);
 	} catch (rollbackError) {
 		const rollbackMessage = rollbackError instanceof Error ? rollbackError.message : String(rollbackError);
 		throw new Error(`Stack rebuild failed: ${rebuildMessage}\nRestoring the previous stack also failed: ${rollbackMessage}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bstack",
-  "version": "1.1.6",
+  "version": "1.2.0",
   "description": "Create native GitHub stacked pull requests from a linear series of commits",
   "license": "MIT",
   "repository": {