feat: callback of th-deleting-tiddler

Author: linonetwo

dprint.json

@@ -15,8 +15,8 @@
   ],
   "excludes": ["**/node_modules", "**/*-lock.json"],
   "plugins": [
-    "https://plugins.dprint.dev/typescript-0.93.3.wasm",
-    "https://plugins.dprint.dev/json-0.19.4.wasm",
-    "https://plugins.dprint.dev/markdown-0.17.8.wasm"
+    "https://plugins.dprint.dev/typescript-0.95.0.wasm",
+    "https://plugins.dprint.dev/json-0.20.0.wasm",
+    "https://plugins.dprint.dev/markdown-0.18.0.wasm"
   ]
 }

package.json

@@ -33,20 +33,20 @@
     ]
   },
   "devDependencies": {
-    "@modern-js/tsconfig": "^2.64.0",
-    "@types/node": "^22.12.0",
-    "dprint": "^0.48.0",
-    "eslint-config-tidgi": "1.2.3",
+    "@modern-js/tsconfig": "^2.67.3",
+    "@types/node": "^22.15.3",
+    "dprint": "^0.49.1",
+    "eslint-config-tidgi": "2.1.0",
     "husky": "^9.1.7",
-    "lint-staged": "^15.4.3",
-    "postcss": "^8.5.1",
+    "lint-staged": "^15.5.1",
+    "postcss": "^8.5.3",
     "rimraf": "^6.0.1",
     "ts-node": "^10.9.2",
-    "tw5-typed": "^0.5.14",
-    "typescript": "^5.7.3"
+    "tw5-typed": "^0.6.2",
+    "typescript": "^5.8.3"
   },
   "dependencies": {
-    "npm-check-updates": "^17.1.14",
+    "npm-check-updates": "^18.0.1",
     "tiddlywiki": "^5.3.6",
     "tiddlywiki-plugin-dev": "^0.3.2"
   }

src/tidgi-external-attachments/config.multids

@@ -6,3 +6,4 @@ MoveToWikiFolder: yes
 WikiFolderToMove: files
 UseAbsoluteForDescendents: no
 UseAbsoluteForNonDescendents: yes
+MoveToTrash: yes

src/tidgi-external-attachments/handleDeletingTiddler.ts

@@ -0,0 +1,48 @@
+/* eslint-disable @typescript-eslint/strict-boolean-expressions */
+import { Tiddler } from 'tiddlywiki';
+import { joinPaths } from './makePathRelative';
+
+// Configuration tiddler title
+const MOVE_TO_TRASH_TITLE = '$:/config/ExternalAttachments/MoveToTrash';
+
+/**
+ * Handles the 'th-deleting-tiddler' hook which is triggered when a tiddler is being deleted.
+ * If the tiddler references an external file via _canonical_uri, this function can move that file to trash.
+ *
+ * @param tiddler - The tiddler being deleted
+ * @param wikiFolderLocation - The location of the current wiki folder
+ * @returns The tiddler (unmodified)
+ */
+export function handleDeletingTiddler(tiddler: Tiddler, wikiFolderLocation: string): Tiddler {
+  // Check if we should move external files to trash on tiddler deletion
+  const moveToTrash = $tw.wiki.getTiddlerText(MOVE_TO_TRASH_TITLE, '') === 'yes';
+  if (!moveToTrash) return tiddler;
+
+  // Check if the tiddler has a canonical URI (reference to external file)
+  const canonicalUri = tiddler.fields._canonical_uri;
+  if (!canonicalUri || typeof canonicalUri !== 'string') return tiddler;
+  let filePath: string;
+  // Handle relative vs absolute paths
+  if (
+    canonicalUri.startsWith('/') ||
+    (canonicalUri.length > 1 && canonicalUri[1] === ':')
+  ) {
+    // Absolute path
+    filePath = canonicalUri;
+  } else {
+    // Relative path - resolve against wiki folder location
+    filePath = joinPaths(wikiFolderLocation, canonicalUri);
+  }
+
+  // Move the file to trash using TidGi's API
+  try {
+    void window.service?.native?.moveToTrash?.(filePath);
+
+    // Optional: Log operation to console
+    console.log(`Moved file to trash: ${filePath}`);
+  } catch (error) {
+    console.error(`Failed to move file to trash: ${filePath}`, error);
+  }
+
+  return tiddler;
+}

src/tidgi-external-attachments/settings-en-GB.tid

@@ -9,6 +9,8 @@ caption: ExtAttach
 
 <$checkbox tiddler="$:/config/ExternalAttachments/MoveToWikiFolder" field="text" checked="yes" unchecked="no" default="no"> <$link to="$:/config/ExternalAttachments/MoveToWikiFolder">Automatically move imported files to the Wiki folder</$link> </$checkbox>
 
+<$checkbox tiddler="$:/config/ExternalAttachments/MoveToTrash" field="text" checked="yes" unchecked="no" default="no"> <$link to="$:/config/ExternalAttachments/MoveToTrash">Move associated external files to trash when deleting tiddlers</$link> </$checkbox>
+
 <%if [{$:/config/ExternalAttachments/MoveToWikiFolder}match[yes]] %>
 
   <$edit-text tiddler="$:/config/ExternalAttachments/WikiFolderToMove" tabindex=-1 focus=false cancelPopups="yes" fileDrop=no tag="input" /> Automatically move files to this folder inside the Wiki folder (suggested to keep using `files`).
@@ -30,5 +32,6 @@ caption: ExtAttach
 * Keep "Automatically move files to Wiki folder" enabled (default)
 * Retain the default storage directory as `files`
 * Always disable "Use absolute paths for files within Wiki"
+* Default to moving external files to trash when deleting tiddlers to simplify external file management, as TidGi's automatic git backups can restore files at any time.
 
 Read more in the [[plugin readme|$:/plugins/linonetwo/tidgi-external-attachments/readme]].

src/tidgi-external-attachments/settings-zh-Hans.tid

@@ -9,6 +9,8 @@ caption: 外部附件
 
 <$checkbox tiddler="$:/config/ExternalAttachments/MoveToWikiFolder" field="text" checked="yes" unchecked="no" default="no"> <$link to="$:/config/ExternalAttachments/MoveToWikiFolder">自动将拖入的文件移动到 Wiki 文件夹内</$link> </$checkbox>
 
+<$checkbox tiddler="$:/config/ExternalAttachments/MoveToTrash" field="text" checked="yes" unchecked="no" default="yes"> <$link to="$:/config/ExternalAttachments/MoveToTrash">删除条目时将关联的外部文件移动到回收站</$link> </$checkbox>
+
 <%if [{$:/config/ExternalAttachments/MoveToWikiFolder}match[yes]] %>
 
   <$edit-text tiddler="$:/config/ExternalAttachments/WikiFolderToMove" tabindex=-1 focus=false cancelPopups="yes" fileDrop=no tag="input" /> 自动移动文件到 Wiki 文件夹里的这个文件夹里（建议保持用 `files`）。
@@ -30,5 +32,6 @@ caption: 外部附件
 * 保持「自动移动文件到 Wiki 文件夹内」开启（默认启用）
 * 保留默认存储目录为 `files` 
 * 始终关闭「为 Wiki 内文件使用绝对路径」
+* 默认开启「删除条目时移动关联外部文件到回收站」功能，以简化外部应用管理，反正太记有自动git备份可以随时回档
 
 阅读[[插件说明|$:/plugins/linonetwo/tidgi-external-attachments/readme]]了解更多信息。

src/tidgi-external-attachments/startup.ts

@@ -3,6 +3,7 @@
 /* eslint-disable @typescript-eslint/prefer-nullish-coalescing */
 
 import { handleBeforeImporting } from './handleBeforeImporting';
+import { handleDeletingTiddler } from './handleDeletingTiddler';
 import { handleImportingFile } from './handleImportingFile';
 import { makePathRelative } from './makePathRelative';
 
@@ -51,5 +52,9 @@ exports.startup = function() {
     $tw.hooks.addHook('th-before-importing', function(info) {
       return handleBeforeImporting(info);
     });
+
+    $tw.hooks.addHook("th-deleting-tiddler", function(tiddler) {
+      return handleDeletingTiddler(tiddler, wikiFolderLocation);
+    });
   });
 };

src/tidgi-external-attachments/type.d.ts

@@ -18,6 +18,12 @@ declare global {
           toFilePath: string,
           options?: { fileToDir?: boolean },
         ): Promise<false | string>;
+        /**
+         * Move a file or directory to the trash bin.
+         * @param filePath The absolute path of the file or directory to move to the trash.
+         * @returns A promise that resolves to true if the operation was successful, false otherwise.
+         */
+        moveToTrash(filePath: string): Promise<boolean>;
         path(
           method: 'basename' | 'dirname' | 'join',
           pathString: string | undefined,