gutterpress 0.11.23-alpha.4 → 0.11.23-alpha.6

package/dist/{index-h6yk5tjx.js → index-cw03e9p4.js}

@@ -6,7 +6,8 @@ import {
 import {
   capabilitiesFor,
   detectProjectSource,
-  findEnclosingRepoDir
+  findEnclosingRepoDir,
+  syncRemoteFor
 } from "./index-v5mp7a6q.js";
 
 // src/lib/git-fs.ts
@@ -214,6 +215,7 @@ function gitScopeFor(source) {
   return source.repoRoot || source.path;
 }
 var HISTORY_PAGE_LIMIT = 100;
+var NO_VERSION_HISTORY = "This book isn't keeping version history yet. Turn on version history first.";
 var DEFAULT_AUTHOR = "gutterpress";
 var DEFAULT_EMAIL = "noreply@gutterpress.local";
 var DEFAULT_BRANCH = "main";
@@ -385,7 +387,7 @@ class LocalFolderSourceProvider {
   async initVersionHistory(options) {
     const dir = options.projectDir;
     if (await findEnclosingRepoDir(dir) !== undefined) {
-      throw new Error("This folder is already inside a versioned book, so gutterpress " + "won't create a separate history here.");
+      throw new Error("This folder is already inside a book that keeps version history, so " + "Gutterpress won't start a separate one here.");
     }
     return withRepoLock(dir, async () => {
       const cache = {};
@@ -409,7 +411,7 @@ class LocalFolderSourceProvider {
     });
   }
   snapshot() {
-    return Promise.reject(new Error("This book has no version history yet. Enable version history first."));
+    return Promise.reject(new Error(NO_VERSION_HISTORY));
   }
   listHistory() {
     return Promise.resolve([]);
@@ -418,7 +420,7 @@ class LocalFolderSourceProvider {
     return Promise.resolve({ entries: [], hasMore: false });
   }
   restore() {
-    return Promise.reject(new Error("This book has no version history yet. Enable version history first."));
+    return Promise.reject(new Error(NO_VERSION_HISTORY));
   }
 }
 
@@ -517,7 +519,7 @@ async function snapshotWorkingTreeUnlocked(options) {
   const workdirClean = changes.adds.length === 0 && changes.removes.length === 0;
   if (workdirClean && !staleStaging) {
     logger.debug("snapshot", "no changes — skipping");
-    throw new Error("No changes since the last snapshot — there is nothing new to save.");
+    throw new Error("Nothing new to save — your last version already has everything.");
   }
   if (workdirClean && staleStaging && await stageMatchesHead(dir, cache)) {
     logger.debug("snapshot", "stale marker outlived a completed commit — clearing, not recommitting");
@@ -555,7 +557,7 @@ async function snapshotWorkingTreeUnlocked(options) {
   };
 }
 function isNoChangesError(e) {
-  return e instanceof Error && /no changes since the last snapshot/i.test(e.message);
+  return e instanceof Error && /nothing new to save/i.test(e.message);
 }
 async function countUnversionedChanges(projectDir) {
   const source = await detectProjectSource(projectDir);
@@ -586,14 +588,13 @@ function gitDirFor(projectDir) {
 function snapshotStagingMarkerPath(projectDir) {
   return path2.join(gitDirFor(projectDir), SNAPSHOT_STAGING_MARKER);
 }
-var RESTORE_BACKUP_MESSAGE = "Automatic backup before restoring an earlier version";
-var AUTO_SNAPSHOT_MESSAGE = "Automatic snapshot";
+var RESTORE_BACKUP_MESSAGE = "Automatic version before restoring";
+var AUTO_SNAPSHOT_MESSAGE = "Automatic version";
 async function restoreVersionWithBackup(options) {
   const { projectDir, id, authorName, authorEmail } = options;
   const source = await detectProjectSource(projectDir);
-  if (source.type !== "local-git-folder") {
-    throw new Error("This book has no version history yet. Enable version history first.");
-  }
+  if (source.type !== "local-git-folder")
+    throw new Error(NO_VERSION_HISTORY);
   const provider = new LocalGitSourceProvider(source);
   const repoDir = gitScopeFor(source);
   return withRepoLock(repoDir, async () => {
@@ -610,42 +611,105 @@ async function restoreVersionWithBackup(options) {
     try {
       await provider.restoreUnlocked({ projectDir, id });
     } catch (cause) {
-      throw new Error(backupId ? "The restore could not be completed, but your work is safe — it was " + `automatically saved as a backup snapshot (${backupId.slice(0, 7)}) ` + "and appears in your version history." : "The restore could not be completed. Your book files were not changed.", { cause });
+      throw new Error(backupId ? "Going back to that version didn't finish, but your work is safe — it was " + "saved as an automatic version and appears in your version history." : "Going back to that version didn't finish. Your book files were not changed.", { cause });
     }
     return { restoredId: id, backupId };
   });
 }
-var SWITCH_BRANCH_SNAPSHOT_MESSAGE = "Saved before switching copy";
-async function listLocalBranches(dir) {
-  const source = await detectProjectSource(dir);
-  if (source.type !== "local-git-folder")
-    return null;
-  const repoDir = gitScopeFor(source);
-  const [local, current, remotes] = await Promise.all([
-    git.listBranches({ fs: gitFs, dir: repoDir }),
-    git.currentBranch({ fs: gitFs, dir: repoDir, fullname: false }).catch(() => {
+var SWITCH_BRANCH_SNAPSHOT_MESSAGE = "Saved before switching revision";
+async function readRevisionRefs(dir) {
+  const [names, current, remote] = await Promise.all([
+    git.listBranches({ fs: gitFs, dir }),
+    git.currentBranch({ fs: gitFs, dir, fullname: false }).catch(() => {
       return;
     }),
-    git.listRemotes({ fs: gitFs, dir: repoDir }).catch(() => [])
+    syncRemoteFor(dir)
   ]);
-  const localNames = new Set(local);
-  const remoteOnly = new Set;
-  for (const { remote } of remotes) {
-    const names = await git.listBranches({ fs: gitFs, dir: repoDir, remote }).catch(() => []);
-    for (const name of names) {
-      if (name === "HEAD")
-        continue;
-      if (!localNames.has(name))
-        remoteOnly.add(name);
-    }
-  }
+  const tips = async (branches, prefix) => new Map(await Promise.all(branches.map(async (name) => [name, await git.resolveRef({ fs: gitFs, dir, ref: `${prefix}${name}` })])));
+  const onlineNames = remote ? (await git.listBranches({ fs: gitFs, dir, remote: remote.remote }).catch(() => [])).filter((name) => name !== "HEAD") : [];
   return {
     current: current ?? null,
-    branches: [...localNames, ...remoteOnly].sort(),
-    remoteOnly: [...remoteOnly].sort()
+    local: await tips(names, "refs/heads/"),
+    online: await tips(onlineNames, `refs/remotes/${remote?.remote}/`)
   };
 }
-async function resolveCopy(repoDir, branch) {
+var ANCESTRY_DEPTH = 1000;
+async function isContained(dir, tip, inTip, cache) {
+  if (tip === inTip)
+    return true;
+  return git.isDescendent({ fs: gitFs, dir, cache, oid: inTip, ancestor: tip, depth: ANCESTRY_DEPTH }).catch(() => false);
+}
+async function listRevisions(dir) {
+  const source = await detectProjectSource(dir);
+  if (source.type !== "local-git-folder")
+    return null;
+  const repoDir = gitScopeFor(source);
+  const { current, local, online } = await readRevisionRefs(repoDir);
+  const cache = {};
+  const names = [...new Set([...local.keys(), ...online.keys()])].sort((a, b) => a.localeCompare(b));
+  const revisions = await Promise.all(names.map(async (name) => {
+    const here = local.get(name);
+    const there = online.get(name);
+    return {
+      name,
+      current: name === current,
+      where: here && there ? "online" : here ? "this-computer" : "online-only",
+      notBackedUp: Boolean(here && there && !await isContained(repoDir, here, there, cache))
+    };
+  }));
+  return { current, revisions };
+}
+function revisionNameFrom(input) {
+  return input.trim().replace(/\s+/g, "-");
+}
+var UNUSABLE_REVISION_NAME = /[\u0000- \u007f~^:?*[\\/<>"|]|\.\.|@\{|^[-.]|\.$|\.lock$|^@$/;
+var REVISION_NAME_MAX = 100;
+async function assertFreeRevisionName(repoDir, name) {
+  if (!name)
+    throw new Error("Give the revision a name.");
+  if (name.length > REVISION_NAME_MAX || UNUSABLE_REVISION_NAME.test(name)) {
+    throw new Error(`"${name}" can't be a revision name. Use plain words, numbers and dashes, up to ${REVISION_NAME_MAX} characters.`);
+  }
+  const { local, online } = await readRevisionRefs(repoDir);
+  const taken = (names) => [...names].find((n) => n.toLowerCase() === name.toLowerCase());
+  const here = taken(local.keys());
+  if (here)
+    throw new Error(`There's already a revision called "${here}". Pick a different name.`);
+  const there = taken(online.keys());
+  if (there) {
+    throw new Error(`"${there}" is already a revision in the online copy. Switch to it, or pick a different name.`);
+  }
+}
+async function saveUnsavedWork(options, cache) {
+  try {
+    await snapshotWorkingTreeUnlocked({
+      projectDir: options.projectDir,
+      repoRoot: options.repoDir,
+      message: SWITCH_BRANCH_SNAPSHOT_MESSAGE,
+      authorName: options.authorName,
+      authorEmail: options.authorEmail,
+      cache
+    });
+  } catch (e) {
+    if (!isNoChangesError(e))
+      throw e;
+  }
+}
+async function createRevision(options) {
+  const { projectDir, authorName, authorEmail } = options;
+  const source = await detectProjectSource(projectDir);
+  if (source.type !== "local-git-folder")
+    throw new Error(NO_VERSION_HISTORY);
+  const repoDir = gitScopeFor(source);
+  const name = revisionNameFrom(options.name);
+  return withRepoLock(repoDir, async () => {
+    await assertFreeRevisionName(repoDir, name);
+    await saveUnsavedWork({ projectDir, repoDir, authorName, authorEmail }, {});
+    await git.branch({ fs: gitFs, dir: repoDir, ref: name, checkout: true });
+    return { current: name };
+  });
+}
+async function resolveRevision(repoDir, branch) {
   const local = await git.resolveRef({ fs: gitFs, dir: repoDir, ref: `refs/heads/${branch}` }).catch(() => {
     return;
   });
@@ -659,7 +723,7 @@ async function resolveCopy(repoDir, branch) {
     if (oid)
       return { oid, remote };
   }
-  throw new Error(`Couldn't find a copy named "${branch}" — it may have been renamed or deleted.`);
+  throw new Error(`Couldn't find a revision named "${branch}" — it may have been renamed or deleted.`);
 }
 function isCheckoutConflictError(e) {
   return e?.code === "CheckoutConflictError";
@@ -696,29 +760,16 @@ async function diffCommitPaths(dir, fromOid, toOid, cache) {
 async function switchBranch(options) {
   const { projectDir, branch, authorName, authorEmail } = options;
   const source = await detectProjectSource(projectDir);
-  if (source.type !== "local-git-folder") {
-    throw new Error("This book has no version history yet. Enable version history first.");
-  }
+  if (source.type !== "local-git-folder")
+    throw new Error(NO_VERSION_HISTORY);
   const repoDir = gitScopeFor(source);
   return withRepoLock(repoDir, async () => {
     const cache = {};
-    try {
-      await snapshotWorkingTreeUnlocked({
-        projectDir,
-        repoRoot: repoDir,
-        message: SWITCH_BRANCH_SNAPSHOT_MESSAGE,
-        authorName,
-        authorEmail,
-        cache
-      });
-    } catch (e) {
-      if (!isNoChangesError(e))
-        throw e;
-    }
+    await saveUnsavedWork({ projectDir, repoDir, authorName, authorEmail }, cache);
     const fromOid = await git.resolveRef({ fs: gitFs, dir: repoDir, ref: "HEAD" }).catch(() => {
       return;
     });
-    const { oid: toOid, remote } = await resolveCopy(repoDir, branch);
+    const { oid: toOid, remote } = await resolveRevision(repoDir, branch);
     try {
       await git.checkout({
         fs: gitFs,
@@ -730,7 +781,7 @@ async function switchBranch(options) {
       });
     } catch (e) {
       if (isCheckoutConflictError(e)) {
-        throw new Error("Couldn't switch copies — some files changed on disk right as the switch " + "started. Try again.", { cause: e });
+        throw new Error("Couldn't switch revisions — some files changed on disk right as the switch " + "started. Try again.", { cause: e });
       }
       throw e;
     }
@@ -742,4 +793,4 @@ async function switchBranch(options) {
   });
 }
 
-export { gitFs, errorLogData, resolveLogger, gitScopeFor, HISTORY_PAGE_LIMIT, withRepoLock, whenGitIdle, __repoLockQueueSizeForTests, resolveGitAuthor, listWorkdirChanges, stageChanges, hasPendingChanges, hasUncommittedChanges, snapshotWorkingTreeUnlocked, isNoChangesError, countUnversionedChanges, providerFor, gitDirFor, snapshotStagingMarkerPath, RESTORE_BACKUP_MESSAGE, AUTO_SNAPSHOT_MESSAGE, restoreVersionWithBackup, SWITCH_BRANCH_SNAPSHOT_MESSAGE, listLocalBranches, switchBranch };
+export { gitFs, errorLogData, resolveLogger, gitScopeFor, HISTORY_PAGE_LIMIT, NO_VERSION_HISTORY, withRepoLock, whenGitIdle, __repoLockQueueSizeForTests, resolveGitAuthor, listWorkdirChanges, stageChanges, hasPendingChanges, hasUncommittedChanges, snapshotWorkingTreeUnlocked, isNoChangesError, countUnversionedChanges, providerFor, gitDirFor, snapshotStagingMarkerPath, RESTORE_BACKUP_MESSAGE, AUTO_SNAPSHOT_MESSAGE, restoreVersionWithBackup, SWITCH_BRANCH_SNAPSHOT_MESSAGE, readRevisionRefs, isContained, listRevisions, revisionNameFrom, assertFreeRevisionName, createRevision, switchBranch };