Feature: Enhanced Branch and Checkpoint Naming (#4993) * Add customizable name builder and max tries to getUniqueName utility - Add optional `nameBuilder` parameter to allow custom name formatting - Add `maxTries` parameter to client-side version to prevent infinite loops - Update JSDoc with new optional parameters - Use nullish coalescing to set default name builder function - Default name builder maintains existing "${baseName} (${i})" format * Add startIndex option to getUniqueName utility for flexible name generation * Enhance branch creation to use current chat name and ensure unique names - Import `getCurrentChatDetails` from script.js - Replace hardcoded branch name format with current chat name as base - Add custom `buildBranchName` function to format branch names with suffix - Strip existing " - Branch #N" suffixes before generating new branch name - Use `getUniqueName` utility with `nameBuilder` to ensure unique branch names - Remove unused `mainChat` variable and replace with `mainChatName` * Enhance checkpoint creation to use current chat name and suggest unique names - Import `getCurrentChatDetails` from script.js to get current chat name - Add custom `buildCheckpointName` function to format checkpoint names with suffix - Strip existing " - Checkpoint #N" suffixes before generating new checkpoint name - Use `getUniqueName` utility with `nameBuilder` to ensure unique checkpoint names - Pass `suggestedName` to template and popup input for better UX - Replace manual loop with `getUniqueName` * Remove automatic timestamp suffix from bookmark names * Fix getUniqueName utility to correctly handle maxTries and return null on failure * shut up copilot * Strip legacy bookmark and branch name prefixes when generating unique names - Add removal of old "Checkpoint #N - " prefix format in `buildCheckpointName` - Add removal of old "Branch #N - " prefix format in `buildBranchName` - Change `cleanName` from const to let to allow multiple replacements - Ensures clean base names regardless of legacy or current naming format

491f2a3afdbb5b62f091f59a973760bb9cfd6d51

Wolfsblvt <wolfsblvt@gmail.com>

Signed

Parents: 2d1a96f91d675c618e7fc9832cda3bea5c2ac8d4

public/scripts/bookmarks.js+33 -13 Viewed

     saveChatConditional,
     saveItemizedPrompts,
     setActiveGroup,
+    getCurrentChatDetails,
 } from '../script.js';
 import { humanizedDateTime } from './RossAscends-mods.js';
 import {

+}
 async function getBookmarkName({ isReplace = false, forceName = null } = {}) {
-    const chatNames = await getExistingChatNames();
+    const mainChatName = (getCurrentChatDetails()).sessionName;
-    const body = await renderTemplateAsync('createCheckpoint', { isReplace: isReplace });
+    function buildCheckpointName(name, i) {
-    let name = forceName ?? await Popup.show.input('Create Checkpoint', body);
+        // Strip off existing suffixes, then build new name
+        let cleanName = name.replace(new RegExp(` - ${bookmarkNameToken}\\d+$`), '');
+        // Strip off legacy old name prefix too
+        cleanName = name.replace(new RegExp(`^${bookmarkNameToken}\\d+ - `), '');
+        return `${cleanName} - ${bookmarkNameToken}${i}`;
+    }
+    const existingChats = await getExistingChatNames();
+    const suggestedName = getUniqueName(mainChatName, (x) => existingChats.includes(x), { nameBuilder: buildCheckpointName });
+    const body = await renderTemplateAsync('createCheckpoint', { isReplace: isReplace, suggestedName: suggestedName });
+    let name = forceName ?? await Popup.show.input('Create Checkpoint', body, suggestedName);
     // Special handling for confirmed empty input (=> auto-generate name)
     if (name === '') {
-        for (let i = chatNames.length; i < 1000; i++) {
+        name = suggestedName;
-            name = bookmarkNameToken + i;
-            if (!chatNames.includes(name)) {
-                break;
-            }
-        }
+    }
     if (!name) {
         return null;
+    }
-    return `${name} - ${humanizedDateTime()}`;
+    return name;
+}
 function getMainChatName() {

+    }
     const lastMes = chat[mesId];
-    const mainChat = selected_group ? groups?.find(x => x.id == selected_group)?.chat_id : characters[this_chid].chat;
+    const mainChatName = (getCurrentChatDetails()).sessionName;
-    const newMetadata = { main_chat: mainChat };
+    const newMetadata = { main_chat: mainChatName };
-    let name = `Branch #${mesId} - ${humanizedDateTime()}`;
+    function buildBranchName(name, i) {
+        // Strip off existing suffixes, then build new name
+        let cleanName = name.replace(/ - Branch #\d+$/, '');
+        // Strip off legacy old name prefix too
+        cleanName = name.replace(/^Branch #\d+ - /, '');
+        return `${cleanName} - Branch #${i}`;
+    }
+    const existingChats = await getExistingChatNames();
+    const name = getUniqueName(mainChatName, (x) => existingChats.includes(x), { nameBuilder: buildBranchName });
+    if (!name) {
+        console.error('Could not generate a unique branch name.');
+        toastr.error('Could not generate a unique branch name.', 'Branch creation failed');
+        return;
+    }
     if (selected_group) {
         await saveGroupBookmarkChat(selected_group, name, newMetadata, mesId);

public/scripts/utils.js+19 -9 Viewed

 /**
  * Returns a name that is unique among the names that exist.
- * @param {string} name The name to check.
+ * @param {string} baseName The name to check.
  * @param {{ (name: string): boolean; }} exists Function to check if name exists.
- * @returns {string} A unique name.
+ * @param {Object} [options] The options.
- */
+ * @param {((baseName: string, i: number) => string)|null} [options.nameBuilder=null] Function to build the name.
-export function getUniqueName(name, exists) {
+ *        Starts with the index provided by `startIndex` (default is 1). If not provided, uses "${baseName} (${i})".
-    let i = 1;
+ * @param {number} [options.maxTries=1000] The maximum number of tries to find a unique name. Default is 1000.
-    let baseName = name;
+ * @param {number} [options.startIndex=1] The index to start with when building the name. Default is 1.
-    while (exists(name)) {
+ *        When set to 0, the intention is to also check if the basename (without applied index) is free.
-        name = `${baseName} (${i})`;
+ * @returns {string|null} A unique name. Null if no unique name could be found in `maxTries`.
+ */
+export function getUniqueName(baseName, exists, { nameBuilder = null, maxTries = 1000, startIndex = 1 } = {}) {
+    nameBuilder ??= (baseName, i) => i === 0 ? baseName : `${baseName} (${i})`;
+    let i = startIndex;
+    let name;
+    while (i < maxTries + startIndex) {
+        name = nameBuilder(baseName, i);
+        if (!exists(name)) {
+            return name;
+        }
         i++;
+    }
-    return name;
+    return null;
+}
 /**

src/util.js+19 -9 Viewed

 /**
  * Returns a name that is unique among the names that exist.
- * @param {string} name The name to check.
+ * @param {string} baseName The name to check.
  * @param {{ (name: string): boolean; }} exists Function to check if name exists.
- * @returns {string} A unique name.
+ * @param {Object} [options] The options.
- */
+ * @param {((baseName: string, i: number) => string)|null} [options.nameBuilder=null] Function to build the name.
-export function getUniqueName(name, exists) {
+ *        Starts with the index provided by `startIndex` (default is 1). If not provided, uses "${baseName} (${i})".
-    let i = 1;
+ * @param {number} [options.maxTries=1000] The maximum number of tries to find a unique name. Default is 1000.
-    let baseName = name;
+ * @param {number} [options.startIndex=1] The index to start with when building the name. Default is 1.
-    while (exists(name)) {
+ *        When set to 0, the intention is to also check if the basename (without applied index) is free.
-        name = `${baseName} (${i})`;
+ * @returns {string|null} A unique name. Null if no unique name could be found in `maxTries`.
+ */
+export function getUniqueName(baseName, exists, { nameBuilder = null, maxTries = 1000, startIndex = 1 } = {}) {
+    nameBuilder ??= (baseName, i) => i === 0 ? baseName : `${baseName} (${i})`;
+    let i = startIndex;
+    let name;
+    while (i < maxTries + startIndex) {
+        name = nameBuilder(baseName, i);
+        if (!exists(name)) {
+            return name;
+        }
         i++;
+    }
-    return name;
+    return null;
+}
 /**