forbid rename CLUSTERS and ORPHANS folders

Author: lorens-osman-dev

src/createFamily/commit_info.md

@@ -1,14 +1,12 @@
 ## Did
 
--   [*] forbid make child or sibling with -cluster suffix
+-   [*] forbid rename CLUSTERS and ORPHANS folders
 
 ## ToDo
 
 -   [ ] FIX you need to add buttons line when onload if there is an active file
 -   [ ] make the extra buttons [ puzzle ] functionality implementation
--   [ ] when you rename parent note you need rename the son's containing folder with same name
 -   [ ] اخفي زر الحذف ضمن مجلد الكلستر عند الصغط على زر اليمين
--   [ ] forbid rename CLUSTERS and ORPHANS folders
 -   [ ] son --> child , father --> parent , brother --> sibling
 -   [ ] READEME.md
 -   [ ] modifyFirst Template

src/mainParts/events.ts

@@ -36,7 +36,7 @@ export function addEvents(plugin: ExtendedPlugin) {
   plugin.registerEvent(
     plugin.app.vault.on("rename", async (file, oldPath) => {
 
-      if (file && file.parent && file.path.startsWith("CLUSTER")) {
+      if (file && file.parent && (oldPath.startsWith("CLUSTERS") || oldPath.startsWith("ORPHANS"))) {
         const partsOfOldPath = oldPath.split("/")
         const renamedFile: RenamedItem<TAbstractFile> = {
           file: file,
@@ -47,8 +47,7 @@ export function addEvents(plugin: ExtendedPlugin) {
         }
         await renamer(plugin, renamedFile)
       }
-      // setTimeout(() => P.newNavTreeStart(plugin), 100)
-    }),
+    })
   );
 
   plugin.registerEvent(

src/renamer/doModify.ts

@@ -72,6 +72,7 @@ async function renameChildrenFolder(plugin: Plugin, fileItem: RenamedItem<TFile>
   }
 }
 async function forbidClusterRenaming(plugin: Plugin, fileItem: RenamedItem<TAbstractFile>): Promise<boolean> {
+  //= files
   if (fileItem.file instanceof TFile && isItem.isFileCluster(plugin, fileItem as RenamedItem<TFile>) === "theCluster") {
     const oldName = fileItem.oldPath.split("/")[1].slice(0, -3)
     const newName = fileItem.newPath.split("/")[1].slice(0, -3)
@@ -97,6 +98,7 @@ async function forbidClusterRenaming(plugin: Plugin, fileItem: RenamedItem<TAbst
       }
     }
   }
+  //= folders
   if (fileItem.file instanceof TFolder && isItem.isFolderCluster(fileItem as RenamedItem<TFolder>) === "theCluster") {
     const oldName = fileItem.oldPath.split("/")[1];
     const newName = fileItem.newPath.split("/")[1];

src/renamer/isItem.ts

@@ -1,4 +1,4 @@
-import { Plugin, TFile, TFolder } from "obsidian"
+import { Notice, Plugin, TAbstractFile, TFile, TFolder } from "obsidian"
 import { RenamedItem } from "src/types/obsidian"
 import U from "src/util/U"
 
@@ -88,12 +88,38 @@ function whatClusteringState(fileItem: RenamedItem<TFolder>): "linked" | "unLink
   return "unLinked"
 }
 
+async function isCLUSTERSorORPHANS(plugin: Plugin, fileItem: RenamedItem<TAbstractFile>): Promise<boolean> {
+  if (fileItem.file instanceof TFolder && fileItem.oldPath === "CLUSTERS") {
+    if (fileItem.newPath !== "CLUSTERS") {
+      try {
+        await plugin.app.fileManager.renameFile(fileItem.file, "CLUSTERS");
+        new Notice("This folder should remains with CLUSTERS name", 3000)
+        return true
+      } catch (error) {
+        console.error("Error renaming cluster file:", error);
+      }
+    }
+  }
+  if (fileItem.file instanceof TFolder && fileItem.oldPath === "ORPHANS") {
+    if (fileItem.newPath !== "ORPHANS") {
+      try {
+        await plugin.app.fileManager.renameFile(fileItem.file, "ORPHANS");
+        new Notice("This folder should remains with ORPHANS name", 3000)
+        return true
+      } catch (error) {
+        console.error("Error renaming cluster file:", error);
+      }
+    }
+  }
+  return false
+}
 
 const isItem = {
   isFileHasChildren,
   isFileCluster,
   isFolderCluster,
-  whatClusteringState
+  whatClusteringState,
+  isCLUSTERSorORPHANS
 }
 
 export default isItem

src/renamer/renamer.ts

@@ -2,20 +2,27 @@ import { TFile, TFolder, Plugin, TAbstractFile } from 'obsidian';
 import { RenamedFileItemType, RenamedItem } from '../types/obsidian';
 import { checkRenamedFileItemType } from './checkRenamedFileItemType';
 import doModify from './doModify';
-
+import isItem from './isItem';
+//_ renamer
 export async function renamer(plugin: Plugin, fileItem: RenamedItem<TAbstractFile>) {
+  // check if the name CLUSTERS or ORPHANS
+  if (await isItem.isCLUSTERSorORPHANS(plugin, fileItem)) {
+    return
+  }
   const renamedFileItemType = checkRenamedFileItemType(plugin, fileItem)
   if (!renamedFileItemType) {
-    console.log(fileItem.file.name + ": undifined -->", renamedFileItemType);
+    console.log(fileItem.file.name + ": undefined -->", renamedFileItemType);
     return
   }
   console.log(fileItem.file.name + "-->", renamedFileItemType);
+
   //do rename
-  rename(plugin, fileItem, renamedFileItemType)
+  await rename(plugin, fileItem, renamedFileItemType)
 }
 
 
-export async function rename(plugin: Plugin, fileItem: RenamedItem<TAbstractFile>, type: RenamedFileItemType) {
+//_ rename
+async function rename(plugin: Plugin, fileItem: RenamedItem<TAbstractFile>, type: RenamedFileItemType) {
   // file:alone:notTheCluster
   if (type === "file:alone:notTheCluster") {
     const forbid = await doModify.file.forbidClusterRenaming(plugin, fileItem as RenamedItem<TFile>)