git-stack-cli 1.8.3 → 1.10.0

package/src/core/GitReviseTodo.ts

@@ -1,4 +1,10 @@
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+
 import * as Metadata from "~/core/Metadata";
+import { cli } from "~/core/cli";
+import { invariant } from "~/core/invariant";
 
 import type * as CommitMetadata from "~/core/CommitMetadata";
 
@@ -47,7 +53,7 @@ import type * as CommitMetadata from "~/core/CommitMetadata";
 //   apple sweet
 //
 export function GitReviseTodo(args: Args): string {
-  const entry_list = [];
+  const commit_list = [];
 
   const group_list = args.commit_range.group_list;
 
@@ -55,29 +61,84 @@ export function GitReviseTodo(args: Args): string {
     const group = group_list[i];
 
     for (const commit of group.commits) {
-      // update git commit message with stack id
-      const metadata = { id: group.id, title: group.title };
-      const unsafe_message_with_id = Metadata.write(
-        commit.full_message,
-        metadata
-      );
-      const message_with_id = unsafe_message_with_id.replace(/"/g, '\\"');
-
-      // get first 12 characters of commit sha
-      const sha = commit.sha.slice(0, 12);
-
-      // generate git revise entry
-      const entry_lines = [`++ pick ${sha}`, message_with_id];
-      const entry = entry_lines.join("\n");
-
-      entry_list.push(entry);
+      commit_list.push(commit);
     }
   }
 
-  const todo = entry_list.join("\n\n");
+  const todo = GitReviseTodo.todo({ commit_list });
   return todo;
 }
 
+type CommitListArgs = {
+  commit_list: CommitMetadata.CommitRange["commit_list"];
+};
+
+GitReviseTodo.todo = function todo(args: CommitListArgs) {
+  const entry_list = [];
+
+  for (const commit of args.commit_list) {
+    // update git commit message with stack id
+    const id = commit.branch_id;
+    const title = commit.title;
+
+    invariant(id, "commit.branch_id must exist");
+    invariant(title, "commit.title must exist");
+
+    const metadata = { id, title };
+
+    const unsafe_message_with_id = Metadata.write(
+      commit.full_message,
+      metadata
+    );
+
+    let message_with_id = unsafe_message_with_id;
+
+    message_with_id = message_with_id.replace(/[^\\]"/g, '\\"');
+
+    // get first 12 characters of commit sha
+    const sha = commit.sha.slice(0, 12);
+
+    // generate git revise entry
+    const entry_lines = [`++ pick ${sha}`, message_with_id];
+    const entry = entry_lines.join("\n");
+
+    entry_list.push(entry);
+  }
+
+  const todo = entry_list.join("\n\n");
+  return todo;
+};
+
+GitReviseTodo.execute = async function grt_execute(args: ExecuteArgs) {
+  // generate temporary directory and drop sequence editor script
+  const tmp_git_sequence_editor_path = path.join(
+    os.tmpdir(),
+    "git-sequence-editor.sh"
+  );
+
+  // ensure script is executable
+  fs.chmodSync(tmp_git_sequence_editor_path, "755");
+
+  const git_revise_todo = GitReviseTodo(args);
+
+  // execute cli with temporary git sequence editor script
+  // revise from merge base to pick correct commits
+  const command = [
+    `GIT_EDITOR="${tmp_git_sequence_editor_path}"`,
+    `GIT_REVISE_TODO="${git_revise_todo}"`,
+    `git`,
+    `revise --edit -i ${args.rebase_merge_base}`,
+  ];
+
+  await cli(command, { stdio: ["ignore", "ignore", "ignore"] });
+};
+
+type ExecuteArgs = {
+  rebase_group_index: number;
+  rebase_merge_base: string;
+  commit_range: CommitMetadata.CommitRange;
+};
+
 type Args = {
   rebase_group_index: number;
   commit_range: CommitMetadata.CommitRange;

package/src/core/Metadata.test.ts

@@ -52,6 +52,91 @@ test("write handles bulleted lists", () => {
   );
 });
 
+test("read handles slashes in branch name", () => {
+  const body = [
+    "[fix] slash in branch name",
+    "",
+    "git-stack-id: dev/noah/fix-slash-branch",
+    "git-stack-title: fix slash branch",
+  ].join("\n");
+
+  const metadata = Metadata.read(body);
+
+  expect(metadata).toEqual({
+    id: "dev/noah/fix-slash-branch",
+    title: "fix slash branch",
+  });
+});
+
+test("write handles bulleted lists", () => {
+  const body = [
+    "[feat] implement various features",
+    "",
+    "- keyboard modality escape key",
+    "- centralize settings",
+    "- move logic inside if branch",
+    "",
+    "git-stack-id: DdKIFyufW",
+  ].join("\n");
+
+  const metadata = {
+    id: "fix-slash-branch",
+    title: "fix slash branch",
+  };
+
+  expect(Metadata.write(body, metadata)).toEqual(
+    [
+      "[feat] implement various features",
+      "",
+      "- keyboard modality escape key",
+      "- centralize settings",
+      "- move logic inside if branch",
+      "",
+      "git-stack-id: fix-slash-branch",
+      "git-stack-title: fix slash branch",
+    ].join("\n")
+  );
+});
+
+test("read handles double quotes", () => {
+  const body = [
+    'Revert "[abc / 123] subject (#1234)"',
+    "",
+    "git-stack-id: dev/noah/fix-slash-branch",
+    'git-stack-title: Revert \\"[abc / 123] subject (#1234)\\"',
+  ].join("\n");
+
+  const metadata = Metadata.read(body);
+
+  expect(metadata).toEqual({
+    id: "dev/noah/fix-slash-branch",
+    title: 'Revert \\"[abc / 123] subject (#1234)\\"',
+  });
+});
+
+test("write handles double quotes", () => {
+  const body = [
+    // force line break
+    'Revert "[abc / 123] subject (#1234)"',
+    "",
+  ].join("\n");
+
+  const metadata = {
+    id: "abc123",
+    title: 'Revert "[abc / 123] subject (#1234)"',
+  };
+
+  expect(Metadata.write(body, metadata)).toEqual(
+    [
+      // force line break
+      'Revert \\"[abc / 123] subject (#1234)\\"',
+      "",
+      "git-stack-id: abc123",
+      'git-stack-title: Revert \\"[abc / 123] subject (#1234)\\"',
+    ].join("\n")
+  );
+});
+
 test("removes metadata", () => {
   const body = [
     "[feat] implement various features",

package/src/core/Metadata.ts

@@ -14,9 +14,6 @@ type OutputMetadataValues = {
 export function write(message: string, values: InputMetadataValues) {
   let result = message;
 
-  // escape double-quote for cli
-  result = safe_quote(result);
-
   // remove any previous metadata lines
   result = remove(result);
 
@@ -26,7 +23,9 @@ export function write(message: string, values: InputMetadataValues) {
     line_list.push(TEMPLATE.group_title(values.title));
   }
 
-  const new_message = line_list.join("\n");
+  let new_message = line_list.join("\n");
+
+  new_message = safe_quote(new_message);
 
   return new_message;
 }
@@ -73,6 +72,7 @@ const TEMPLATE = {
 };
 
 const RE = {
-  stack_id: new RegExp(TEMPLATE.stack_id("(?<id>[a-z0-9-+=]+)"), "i"),
+  // https://regex101.com/r/wLmGVq/1
+  stack_id: new RegExp(`${TEMPLATE.stack_id("(?<id>[^\\s]+)")}`, "i"),
   group_title: new RegExp(TEMPLATE.group_title("(?<title>[^\\n^\\r]+)"), "i"),
 };

package/src/core/gs_short_id.ts

@@ -0,0 +1,5 @@
+import { short_id } from "~/core/short_id";
+
+export function gs_short_id() {
+  return `gs-${short_id()}`;
+}

package/src/index.tsx

@@ -14,6 +14,7 @@ command()
 
     Store.setState((state) => {
       state.ink = ink;
+      state.process_argv = process.argv;
       state.argv = argv;
       state.cwd = process.cwd();
     });