Tags: Add unused tags pruning to tags management

cc169fffc28f1e124f3a7403decad8b9e36d0a6d

Cohee <18619528+Cohee1207@users.noreply.github.com>

Parents: 3c05fb145679fb1fcf098e14148835680ee61115

public/scripts/tags.js+43 -0 Viewed

  * @returns {Tag[]} A list of tags
  */
 function getTagsList(key, sort = true) {
+    if (key === null || key === undefined) {
+        return [];
+    }
     if (!Array.isArray(tag_map[key])) {
         tag_map[key] = [];
         return [];

     download(blob, filename, 'application/json');
+}
+async function onTagsPruneClick() {
+    // Get tags which have zero tag map entries
+    const allTagsInTagMaps = new Set(Object.values(tag_map).flat());
+    const tagsToPrune = tags.filter(tag => !allTagsInTagMaps.has(tag.id));
+    // Get tag maps referring to deleted entities
+    const allEntityKeys = new Set([...characters.map(c => String(c.avatar)), ...groups.map(g => String(g.id))]);
+    const tagMapsToPrune = Object.keys(tag_map).filter(key => !allEntityKeys.has(key));
+    if (!tagsToPrune.length && !tagMapsToPrune.length) {
+        toastr.info(t`No unused tags or references found.`);
+        return;
+    }
+    const confirm = await Popup.show.confirm(t`Prune ${tagsToPrune.length} tags and ${tagMapsToPrune.length} references`, t`Are you sure you want to remove all unused tags and references to missing or deleted characters and groups?`);
+    if (!confirm) {
+        return;
+    }
+    for (const tag of tagsToPrune) {
+        tags.splice(tags.indexOf(tag), 1);
+    }
+    for (const key of tagMapsToPrune) {
+        delete tag_map[key];
+    }
+    printCharactersDebounced();
+    saveSettingsDebounced();
+    // Reprint the tag management popup, without having it to be opened again
+    const tagContainer = $('#tag_view_list .tag_view_list_tags');
+    printViewTagList(tagContainer);
+    toastr.success(t`Unused tags pruned successfully.`);
+}
 function onTagCreateClick() {
     const tagName = getFreeName('New Tag', tags.map(x => x.name));
     const tag = createNewTag(tagName);

     $(document).on('click', '.tag_view_create', onTagCreateClick);
     $(document).on('click', '.tag_view_backup', onTagsBackupClick);
     $(document).on('click', '.tag_view_restore', onBackupRestoreClick);
+    $(document).on('click', '.tag_view_prune', onTagsPruneClick);
     eventSource.on(event_types.CHARACTER_DUPLICATED, copyTags);
     eventSource.makeFirst(event_types.CHAT_CHANGED, () => selected_group ? applyTagsOnGroupSelect() : applyTagsOnCharacterSelect());

public/scripts/templates/tagManagement.html+4 -0 Viewed

 <div class="title_restorable alignItemsBaseline">
         <h3 data-i18n="Tag Management">Tag Management</h3>
         <div class="flex-container alignItemsBaseline">
+            <div class="menu_button menu_button_icon tag_view_prune" data-i18n="[title]Remove unused tags" title="Remove unused tags">
+                <i class="fa-solid fa-scissors"></i>
+                <span data-i18n="Prune">Prune</span>
+            </div>
             <div class="menu_button menu_button_icon tag_view_backup" data-i18n="[title]Save your tags to a file" title="Save your tags to a file">
                 <i class="fa-solid fa-file-export"></i>
                 <span data-i18n="Backup">Backup</span>