vvvfs 0.0.7 → 0.0.9

package/README.md

@@ -42,6 +42,10 @@ const vvvfs = new VVVFS("vvvfs", {
 (async function () {
     await vvvfs.reset(); // 重置文件系统
     await vvvfs.init("UserName"); // 初始化文件系统
+    await vvvfs.watch("/home/user/Desktop/test.txt", (type) => {
+        console.log(type); // 打印文件操作的类型
+        return true; // 返回true或false，表示是否取消该操作
+    });
     await vvvfs.createDir("/home/user/Desktop"); // 创建目录，返回true和false
     await vvvfs.writeText("/home/user/Desktop/test.txt", "Hello World!"); // 写入文本文件，写入文件还包括write(path: string, content: Blob)和writeJson(path: string, content: Record<string, any>)方法，返回true和false
     console.log(await vvvfs.readText("/home/user/Desktop/test.txt")); // 读取文本文件，读取文件还包括read(path: string): Blob | null和readJson(path: string): Record<string, any> | null方法
@@ -78,6 +82,14 @@ const vvvfs = new VVVFS("vvvfs", {
 
 ## 更新日志
 
+### 0.0.9
+
+- 更新 `watch` 方法，监听时，返回 `true` 表示取消该操作
+
+### 0.0.8
+
+- 新增 `watch` 方法 (该方法属于实验性功能，后期可能会改变)
+
 ### 0.0.7
 
 - AI 了优化一下

package/index.html

@@ -13,9 +13,14 @@
         (async () => {
             try {
                 globalThis.vvvfs = new VVVFS();
+                vvvfs.options.throwError = true;
                 await vvvfs.reset();
                 await vvvfs.init("IFTC");
                 console.log(vvvfs);
+                await vvvfs.watch("/test.txt", (type) => {
+                    console.log(type);
+                    // return true;
+                });
                 console.log("创建文件", await vvvfs.createFile("/test.txt"));
                 console.log("写入文件", await vvvfs.writeText("/test.txt", "Hello World"));
                 console.log("文件是否存在", await vvvfs.exists("/test.txt"));

package/index.ts

@@ -216,6 +216,9 @@ class VVVFSFile {
     async search(query: string) {
         return await this._vvvfs.search(this._path, query);
     }
+    async watch(handler: (type: string) => Promise<boolean>) {
+        return await this._vvvfs.watch(this._path, handler);
+    }
 }
 
 const version = packageJson.version;
@@ -231,6 +234,10 @@ class VVVFS {
      * 虚拟文件系统文件类
      */
     static File = VVVFSFile;
+    /**
+     * 虚拟文件系统监听器
+     */
+    watchers: Record<string, Array<(type: string) => Promise<boolean>>> = {};
     /**
      * 创建虚拟文件系统
      * @param name 虚拟文件系统名称
@@ -410,11 +417,21 @@ class VVVFS {
      */
     async createFile(path: string) {
         const targetPath = joinPath(path);
-        if (await this.exists(targetPath)) {
-            console.warn("文件已存在");
-            return true;
-        }
         try {
+            if (this.watchers[targetPath]) {
+                for (const handler of this.watchers[targetPath]) {
+                    if (await handler("create")) {
+                        if (this.options.throwError) {
+                            throw new VVVFSError("CreateFile", "创建文件失败：监听器取消了操作");
+                        }
+                        return false;
+                    }
+                }
+            }
+            if (await this.exists(targetPath)) {
+                console.warn("文件已存在");
+                return true;
+            }
             const { name, parent } = parsePath(targetPath);
             if (!(await this.exists(parent))) {
                 await this.createDir(parent);
@@ -442,11 +459,21 @@ class VVVFS {
      */
     async createDir(path: string) {
         const targetPath = joinPath(path);
-        if (await this.exists(targetPath)) {
-            console.warn("目录已存在");
-            return true;
-        }
         try {
+            if (this.watchers[targetPath]) {
+                for (const handler of this.watchers[targetPath]) {
+                    if (await handler("create")) {
+                        if (this.options.throwError) {
+                            throw new VVVFSError("CreateDir", "创建目录失败：监听器取消了操作");
+                        }
+                        return false;
+                    }
+                }
+            }
+            if (await this.exists(targetPath)) {
+                console.warn("目录已存在");
+                return true;
+            }
             const { name, parent } = parsePath(targetPath);
             if (!(await this.exists(parent))) {
                 if (parent == "/") {
@@ -507,6 +534,16 @@ class VVVFS {
     async write(path: string, content: Blob) {
         try {
             const targetPath = joinPath(path);
+            if (this.watchers[targetPath]) {
+                for (const handler of this.watchers[targetPath]) {
+                    if (await handler("write")) {
+                        if (this.options.throwError) {
+                            throw new VVVFSError("Write", "写入文件失败：监听器取消了操作");
+                        }
+                        return false;
+                    }
+                }
+            }
             if (!(await this.exists(targetPath))) {
                 const success = await this.createFile(targetPath);
                 if (!success) {
@@ -594,6 +631,16 @@ class VVVFS {
     async read(path: string) {
         try {
             const targetPath = joinPath(path);
+            if (this.watchers[targetPath]) {
+                for (const handler of this.watchers[targetPath]) {
+                    if (await handler("read")) {
+                        if (this.options.throwError) {
+                            throw new VVVFSError("Read", "读取文件失败：监听器取消了操作");
+                        }
+                        return null;
+                    }
+                }
+            }
             if (!(await this.exists(targetPath))) {
                 console.warn("文件不存在");
                 if (this.options.throwError) {
@@ -704,6 +751,23 @@ class VVVFS {
     async list(path: string) {
         try {
             const targetPath = joinPath(path);
+            if (this.watchers[targetPath]) {
+                for (const handler of this.watchers[targetPath]) {
+                    if (await handler("list")) {
+                        if (this.options.throwError) {
+                            throw new VVVFSError("List", "列出目录下的文件失败：监听器取消了操作");
+                        }
+                        return [];
+                    }
+                }
+            }
+            if (!(await this.exists(targetPath))) {
+                console.warn("路径不存在");
+                if (this.options.throwError) {
+                    throw new VVVFSError("List", "路径不存在");
+                }
+                return [];
+            }
             if (!(await this.isDir(targetPath))) {
                 console.warn("路径不是目录");
                 if (this.options.throwError) {
@@ -731,6 +795,16 @@ class VVVFS {
         try {
             const sourcePath = joinPath(path);
             const { name, parent } = parsePath(sourcePath);
+            if (this.watchers[sourcePath]) {
+                for (const handler of this.watchers[sourcePath]) {
+                    if (await handler("rename")) {
+                        if (this.options.throwError) {
+                            throw new VVVFSError("Rename", "重命名文件失败：监听器取消了操作");
+                        }
+                        return false;
+                    }
+                }
+            }
             if (!(await this.exists(sourcePath))) {
                 console.warn("文件不存在");
                 if (this.options.throwError) {
@@ -790,6 +864,16 @@ class VVVFS {
     async delete(path: string) {
         try {
             const targetPath = joinPath(path);
+            if (this.watchers[targetPath]) {
+                for (const handler of this.watchers[targetPath]) {
+                    if (await handler("delete")) {
+                        if (this.options.throwError) {
+                            throw new VVVFSError("Delete", "删除文件失败：监听器取消了操作");
+                        }
+                        return false;
+                    }
+                }
+            }
             if (!(await this.exists(targetPath))) {
                 console.warn("文件不存在");
                 if (this.options.throwError) {
@@ -803,13 +887,17 @@ class VVVFS {
                 for (const file of files) {
                     await this.delete(joinPath(targetPath, file));
                 }
-                const dirRecord = await this.db.files.where({ name, path: parent, type: "dir" }).first();
+                const dirRecord = await this.db.files
+                    .where({ name, path: parent, type: "dir" })
+                    .first();
                 if (dirRecord) {
                     await this.db.files.delete(dirRecord.id!);
                 }
                 return true;
             } else {
-                const fileRecord = await this.db.files.where({ name, path: parent, type: "file" }).first();
+                const fileRecord = await this.db.files
+                    .where({ name, path: parent, type: "file" })
+                    .first();
                 if (fileRecord) {
                     await this.db.files.delete(fileRecord.id!);
                 }
@@ -832,6 +920,19 @@ class VVVFS {
         try {
             const sourcePath = joinPath(path);
             const destinationPath = joinPath(newPath);
+            if (this.watchers[sourcePath]) {
+                for (const handler of this.watchers[sourcePath]) {
+                    if (await handler("move")) {
+                        if (this.options.throwError) {
+                            throw new VVVFSError("Move", "移动文件失败：监听器取消了操作");
+                        }
+                        return false;
+                    }
+                }
+            }
+            if (sourcePath === destinationPath) {
+                return true;
+            }
             if (await this.exists(destinationPath)) {
                 console.warn("目标文件已存在");
                 if (this.options.throwError) {
@@ -861,14 +962,18 @@ class VVVFS {
                 for (const child of children) {
                     await this.move(joinPath(sourcePath, child), joinPath(destinationPath, child));
                 }
-                const dirRecord = await this.db.files.where({ name, path: parent, type: "dir" }).first();
+                const dirRecord = await this.db.files
+                    .where({ name, path: parent, type: "dir" })
+                    .first();
                 if (dirRecord) {
                     await this.db.files.delete(dirRecord.id!);
                 }
                 return true;
             } else {
                 await this.createDir(newParent);
-                const fileRecord = await this.db.files.where({ name, path: parent, type: "file" }).first();
+                const fileRecord = await this.db.files
+                    .where({ name, path: parent, type: "file" })
+                    .first();
                 if (fileRecord) {
                     await this.db.files.update(fileRecord.id!, { name: newName, path: newParent });
                     return true;
@@ -892,6 +997,16 @@ class VVVFS {
         try {
             const sourcePath = joinPath(path);
             const destinationPath = joinPath(newPath);
+            if (this.watchers[sourcePath]) {
+                for (const handler of this.watchers[sourcePath]) {
+                    if (await handler("copy")) {
+                        if (this.options.throwError) {
+                            throw new VVVFSError("Copy", "复制文件失败：监听器取消了操作");
+                        }
+                        return false;
+                    }
+                }
+            }
             if (await this.exists(destinationPath)) {
                 console.warn("目标文件已存在");
                 if (this.options.throwError) {
@@ -923,7 +1038,9 @@ class VVVFS {
                 }
                 return true;
             } else {
-                const fileRecord = await this.db.files.where({ name, path: parent, type: "file" }).first();
+                const fileRecord = await this.db.files
+                    .where({ name, path: parent, type: "file" })
+                    .first();
                 if (fileRecord) {
                     await this.db.files.add({
                         name: newName,
@@ -993,6 +1110,13 @@ class VVVFS {
             return null;
         }
     }
+    async watch(path: string, handler: (type: string) => Promise<boolean>) {
+        path = joinPath(path);
+        if (!this.watchers[path]) {
+            this.watchers[path] = [];
+        }
+        this.watchers[path].push(handler);
+    }
 }
 function parsePath(path: string) {
     path = joinPath(path);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vvvfs",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "一个使用IndexDB实现的虚拟文件系统",
   "keywords": [
     "Virtual",