vscode-fs 0.0.4 → 0.0.6

package/dist/index.cjs

@@ -167,10 +167,11 @@ function joinPath(basePath, ...segments) {
 	return vscode_uri.Utils.joinPath(vscode_uri.URI.file(basePath), ...segments).fsPath;
 }
 async function createNodeFileSystem() {
-	const [fs, trash, glob] = await Promise.all([
+	const [fs, trash, glob, watch] = await Promise.all([
 		import("node:fs"),
 		import("trash").then((m) => m.default),
-		import("tinyglobby").then((m) => m.glob)
+		import("tinyglobby").then((m) => m.glob),
+		import("chokidar").then((m) => m.watch)
 	]);
 	async function resolveFileType(path) {
 		const lstats = await fs.promises.lstat(path);
@@ -324,9 +325,57 @@ async function createNodeFileSystem() {
 				deep: options?.deep,
 				fs
 			}));
+		},
+		createWatcher: async (pattern, options) => {
+			const watcher = watch(pattern.pattern, { cwd: pattern.baseUri.fsPath });
+			return new Promise((resolve) => {
+				watcher.on("ready", () => {
+					const fileSystemWatcher = new NodeFileSystemWatcherImpl(watcher, options);
+					if (options?.ignoreChangeEvents !== true) watcher.on("add", (path) => fileSystemWatcher.onDidCreateListeners.forEach((listener) => listener(vscode_uri.URI.file(path))));
+					if (options?.ignoreChangeEvents !== true) watcher.on("change", (path) => fileSystemWatcher.onDidChangeListeners.forEach((listener) => listener(vscode_uri.URI.file(path))));
+					if (options?.ignoreDeleteEvents !== true) watcher.on("unlink", (path) => fileSystemWatcher.onDidDeleteListeners.forEach((listener) => listener(vscode_uri.URI.file(path))));
+					resolve(fileSystemWatcher);
+				});
+			});
 		}
 	};
 }
+var NodeFileSystemWatcherImpl = class {
+	constructor(watcher, options) {
+		this.watcher = watcher;
+		this.options = options;
+	}
+	get ignoreChangeEvents() {
+		return this.options?.ignoreChangeEvents ?? false;
+	}
+	get ignoreCreateEvents() {
+		return this.options?.ignoreCreateEvents ?? false;
+	}
+	get ignoreDeleteEvents() {
+		return this.options?.ignoreDeleteEvents ?? false;
+	}
+	get isDisposed() {
+		return this.watcher.closed;
+	}
+	onDidCreateListeners = /* @__PURE__ */ new Set();
+	onDidChangeListeners = /* @__PURE__ */ new Set();
+	onDidDeleteListeners = /* @__PURE__ */ new Set();
+	onDidCreate(listener) {
+		this.onDidCreateListeners.add(listener);
+		return { dispose: () => this.onDidCreateListeners.delete(listener) };
+	}
+	onDidChange(listener) {
+		this.onDidChangeListeners.add(listener);
+		return { dispose: () => this.onDidChangeListeners.delete(listener) };
+	}
+	onDidDelete(listener) {
+		this.onDidDeleteListeners.add(listener);
+		return { dispose: () => this.onDidDeleteListeners.delete(listener) };
+	}
+	dispose() {
+		this.watcher.close();
+	}
+};
 
 //#endregion
 Object.defineProperty(exports, 'FileSystemError', {

package/dist/index.d.cts

@@ -212,6 +212,70 @@ interface FileSystem {
      */
     deep?: number;
   }): Promise<URI[]>;
+  createWatcher(pattern: RelativePattern, options?: {
+    /**
+     * Ignore create events.
+     *
+     * @default false
+     */
+    ignoreCreateEvents?: boolean;
+    /**
+     * Ignore change events.
+     *
+     * @default false
+     */
+    ignoreChangeEvents?: boolean;
+    /**
+     * Ignore delete events.
+     *
+     * @default false
+     */
+    ignoreDeleteEvents?: boolean;
+  }): Promise<FileSystemWatcher>;
+}
+interface Disposable {
+  /** Dispose resources. */
+  dispose(): unknown;
+}
+/**
+ * A file system watcher notifies about changes to files and folders
+ * on disk or from other {@link FileSystemProvider FileSystemProviders}.
+ *
+ * To get an instance of a `FileSystemWatcher` use
+ * {@link workspace.createFileSystemWatcher createFileSystemWatcher}.
+ */
+interface FileSystemWatcher extends Disposable {
+  /**
+   * true if this file system watcher has been created such that
+   * it ignores creation file system events.
+   */
+  readonly ignoreCreateEvents: boolean;
+  /**
+   * true if this file system watcher has been created such that
+   * it ignores change file system events.
+   */
+  readonly ignoreChangeEvents: boolean;
+  /**
+   * true if this file system watcher has been created such that
+   * it ignores delete file system events.
+   */
+  readonly ignoreDeleteEvents: boolean;
+  /**
+   * true if this file system watcher has been disposed.
+   */
+  readonly isDisposed: boolean;
+  /**
+   * An event which fires on file/folder creation.
+   */
+  onDidCreate(listener: (e: URI) => unknown): Disposable;
+  /**
+   * An event which fires on file/folder change.
+   */
+  onDidChange(listener: (e: URI) => unknown): Disposable;
+  /**
+   * An event which fires on file/folder deletion.
+   */
+  onDidDelete(listener: (e: URI) => unknown): Disposable;
 }
 /**
  * The `FileStat`-type represents metadata about a file
@@ -337,4 +401,4 @@ declare function toFileSystemError(error: NodeJS.ErrnoException): FileSystemErro
 //#region src/node.d.ts
 declare function createNodeFileSystem(): Promise<FileSystem>;
 //#endregion
-export { FileStat, FileSystem, FileSystemError, FileSystemProviderErrorCode, FileType, IsDirectory, IsFile, IsSymbolicLink, RelativePattern, createFileSystemError, createNodeFileSystem, toFileSystemError };
+export { Disposable, FileStat, FileSystem, FileSystemError, FileSystemProviderErrorCode, FileSystemWatcher, FileType, IsDirectory, IsFile, IsSymbolicLink, RelativePattern, createFileSystemError, createNodeFileSystem, toFileSystemError };

package/dist/index.d.mts

@@ -212,6 +212,70 @@ interface FileSystem {
      */
     deep?: number;
   }): Promise<URI[]>;
+  createWatcher(pattern: RelativePattern, options?: {
+    /**
+     * Ignore create events.
+     *
+     * @default false
+     */
+    ignoreCreateEvents?: boolean;
+    /**
+     * Ignore change events.
+     *
+     * @default false
+     */
+    ignoreChangeEvents?: boolean;
+    /**
+     * Ignore delete events.
+     *
+     * @default false
+     */
+    ignoreDeleteEvents?: boolean;
+  }): Promise<FileSystemWatcher>;
+}
+interface Disposable {
+  /** Dispose resources. */
+  dispose(): unknown;
+}
+/**
+ * A file system watcher notifies about changes to files and folders
+ * on disk or from other {@link FileSystemProvider FileSystemProviders}.
+ *
+ * To get an instance of a `FileSystemWatcher` use
+ * {@link workspace.createFileSystemWatcher createFileSystemWatcher}.
+ */
+interface FileSystemWatcher extends Disposable {
+  /**
+   * true if this file system watcher has been created such that
+   * it ignores creation file system events.
+   */
+  readonly ignoreCreateEvents: boolean;
+  /**
+   * true if this file system watcher has been created such that
+   * it ignores change file system events.
+   */
+  readonly ignoreChangeEvents: boolean;
+  /**
+   * true if this file system watcher has been created such that
+   * it ignores delete file system events.
+   */
+  readonly ignoreDeleteEvents: boolean;
+  /**
+   * true if this file system watcher has been disposed.
+   */
+  readonly isDisposed: boolean;
+  /**
+   * An event which fires on file/folder creation.
+   */
+  onDidCreate(listener: (e: URI) => unknown): Disposable;
+  /**
+   * An event which fires on file/folder change.
+   */
+  onDidChange(listener: (e: URI) => unknown): Disposable;
+  /**
+   * An event which fires on file/folder deletion.
+   */
+  onDidDelete(listener: (e: URI) => unknown): Disposable;
 }
 /**
  * The `FileStat`-type represents metadata about a file
@@ -337,4 +401,4 @@ declare function toFileSystemError(error: NodeJS.ErrnoException): FileSystemErro
 //#region src/node.d.ts
 declare function createNodeFileSystem(): Promise<FileSystem>;
 //#endregion
-export { FileStat, FileSystem, FileSystemError, FileSystemProviderErrorCode, FileType, IsDirectory, IsFile, IsSymbolicLink, RelativePattern, createFileSystemError, createNodeFileSystem, toFileSystemError };
+export { Disposable, FileStat, FileSystem, FileSystemError, FileSystemProviderErrorCode, FileSystemWatcher, FileType, IsDirectory, IsFile, IsSymbolicLink, RelativePattern, createFileSystemError, createNodeFileSystem, toFileSystemError };

package/dist/index.mjs

@@ -166,10 +166,11 @@ function joinPath(basePath, ...segments) {
 	return Utils.joinPath(URI.file(basePath), ...segments).fsPath;
 }
 async function createNodeFileSystem() {
-	const [fs, trash, glob] = await Promise.all([
+	const [fs, trash, glob, watch] = await Promise.all([
 		import("node:fs"),
 		import("trash").then((m) => m.default),
-		import("tinyglobby").then((m) => m.glob)
+		import("tinyglobby").then((m) => m.glob),
+		import("chokidar").then((m) => m.watch)
 	]);
 	async function resolveFileType(path) {
 		const lstats = await fs.promises.lstat(path);
@@ -323,9 +324,57 @@ async function createNodeFileSystem() {
 				deep: options?.deep,
 				fs
 			}));
+		},
+		createWatcher: async (pattern, options) => {
+			const watcher = watch(pattern.pattern, { cwd: pattern.baseUri.fsPath });
+			return new Promise((resolve) => {
+				watcher.on("ready", () => {
+					const fileSystemWatcher = new NodeFileSystemWatcherImpl(watcher, options);
+					if (options?.ignoreChangeEvents !== true) watcher.on("add", (path) => fileSystemWatcher.onDidCreateListeners.forEach((listener) => listener(URI.file(path))));
+					if (options?.ignoreChangeEvents !== true) watcher.on("change", (path) => fileSystemWatcher.onDidChangeListeners.forEach((listener) => listener(URI.file(path))));
+					if (options?.ignoreDeleteEvents !== true) watcher.on("unlink", (path) => fileSystemWatcher.onDidDeleteListeners.forEach((listener) => listener(URI.file(path))));
+					resolve(fileSystemWatcher);
+				});
+			});
 		}
 	};
 }
+var NodeFileSystemWatcherImpl = class {
+	constructor(watcher, options) {
+		this.watcher = watcher;
+		this.options = options;
+	}
+	get ignoreChangeEvents() {
+		return this.options?.ignoreChangeEvents ?? false;
+	}
+	get ignoreCreateEvents() {
+		return this.options?.ignoreCreateEvents ?? false;
+	}
+	get ignoreDeleteEvents() {
+		return this.options?.ignoreDeleteEvents ?? false;
+	}
+	get isDisposed() {
+		return this.watcher.closed;
+	}
+	onDidCreateListeners = /* @__PURE__ */ new Set();
+	onDidChangeListeners = /* @__PURE__ */ new Set();
+	onDidDeleteListeners = /* @__PURE__ */ new Set();
+	onDidCreate(listener) {
+		this.onDidCreateListeners.add(listener);
+		return { dispose: () => this.onDidCreateListeners.delete(listener) };
+	}
+	onDidChange(listener) {
+		this.onDidChangeListeners.add(listener);
+		return { dispose: () => this.onDidChangeListeners.delete(listener) };
+	}
+	onDidDelete(listener) {
+		this.onDidDeleteListeners.add(listener);
+		return { dispose: () => this.onDidDeleteListeners.delete(listener) };
+	}
+	dispose() {
+		this.watcher.close();
+	}
+};
 
 //#endregion
 export { FileSystemError, FileSystemProviderErrorCode, FileType, RelativePattern, createFileSystemError, createNodeFileSystem, toFileSystemError };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vscode-fs",
   "type": "module",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "VSCode like simple、serializable and cross-platform file system utilities.",
   "author": "Naily Zero <zero@naily.cc> (https://naily.cc)",
   "license": "MIT",
@@ -45,6 +45,7 @@
     "vscode-uri": "^3.1.0"
   },
   "dependencies": {
+    "chokidar": "^5.0.0",
     "tinyglobby": "^0.2.15",
     "trash": "^10.1.1"
   },