vscode-fs 0.0.3 → 0.0.4

package/dist/index.cjs

@@ -46,6 +46,54 @@ let FileSystemProviderErrorCode = /* @__PURE__ */ function(FileSystemProviderErr
 	FileSystemProviderErrorCode["Unknown"] = "Unknown";
 	return FileSystemProviderErrorCode;
 }({});
+/**
+* A relative pattern is a helper to construct glob patterns that are matched
+* relatively to a base file path. The base path can either be an absolute file
+* path as string or uri or a {@link WorkspaceFolder workspace folder}, which is the
+* preferred way of creating the relative pattern.
+*/
+var RelativePattern = class {
+	/**
+	* A base file path to which this pattern will be matched against relatively. The
+	* file path must be absolute, should not have any trailing path separators and
+	* not include any relative segments (`.` or `..`).
+	*/
+	baseUri;
+	/**
+	* A file glob pattern like `*.{ts,js}` that will be matched on file paths
+	* relative to the base path.
+	*
+	* Example: Given a base of `/home/work/folder` and a file path of `/home/work/folder/index.js`,
+	* the file glob pattern will match on `index.js`.
+	*/
+	pattern;
+	/**
+	* Creates a new relative pattern object with a base file path and pattern to match. This pattern
+	* will be matched on file paths relative to the base.
+	*
+	* Example:
+	* ```ts
+	* const folder = vscode.workspace.workspaceFolders?.[0];
+	* if (folder) {
+	*
+	*   // Match any TypeScript file in the root of this workspace folder
+	*   const pattern1 = new vscode.RelativePattern(folder, '*.ts');
+	*
+	*   // Match any TypeScript file in `someFolder` inside this workspace folder
+	*   const pattern2 = new vscode.RelativePattern(folder, 'someFolder/*.ts');
+	* }
+	* ```
+	*
+	* @param base A base to which this pattern will be matched against relatively. It is recommended
+	* to pass in a {@link WorkspaceFolder workspace folder} if the pattern should match inside the workspace.
+	* Otherwise, a uri or string should only be used if the pattern is for a file path outside the workspace.
+	* @param pattern A file glob pattern like `*.{ts,js}` that will be matched on paths relative to the base.
+	*/
+	constructor(base, pattern) {
+		this.baseUri = base;
+		this.pattern = pattern;
+	}
+};
 
 //#endregion
 //#region src/error.ts
@@ -119,7 +167,11 @@ function joinPath(basePath, ...segments) {
 	return vscode_uri.Utils.joinPath(vscode_uri.URI.file(basePath), ...segments).fsPath;
 }
 async function createNodeFileSystem() {
-	const [fs, trash] = await Promise.all([import("node:fs"), import("trash").then((m) => m.default)]);
+	const [fs, trash, glob] = await Promise.all([
+		import("node:fs"),
+		import("trash").then((m) => m.default),
+		import("tinyglobby").then((m) => m.glob)
+	]);
 	async function resolveFileType(path) {
 		const lstats = await fs.promises.lstat(path);
 		if (!lstats.isSymbolicLink()) return {
@@ -169,6 +221,9 @@ async function createNodeFileSystem() {
 		}
 		throw createFileSystemError(`Unsupported file type: ${sourcePath}`, FileSystemProviderErrorCode.Unknown);
 	}
+	function pathToUris(pathToUris) {
+		return pathToUris.map((path) => vscode_uri.URI.file(path));
+	}
 	return {
 		stat: (uri) => wrap(async () => {
 			const { type, stats } = await resolveFileType(uri.fsPath);
@@ -254,6 +309,21 @@ async function createNodeFileSystem() {
 			} catch {
 				return false;
 			}
+		},
+		glob: async (pattern, options) => {
+			return pathToUris(await glob(pattern.pattern, {
+				absolute: true,
+				cwd: pattern.baseUri.fsPath,
+				onlyFiles: options?.onlyFiles,
+				onlyDirectories: options?.onlyDirectories,
+				followSymbolicLinks: options?.followSymbolicLinks,
+				ignore: options?.ignore,
+				dot: options?.dot,
+				expandDirectories: options?.expandDirectories,
+				extglob: options?.extglob,
+				deep: options?.deep,
+				fs
+			}));
 		}
 	};
 }
@@ -267,6 +337,7 @@ Object.defineProperty(exports, 'FileSystemError', {
 });
 exports.FileSystemProviderErrorCode = FileSystemProviderErrorCode;
 exports.FileType = FileType;
+exports.RelativePattern = RelativePattern;
 exports.createFileSystemError = createFileSystemError;
 exports.createNodeFileSystem = createNodeFileSystem;
 exports.toFileSystemError = toFileSystemError;

package/dist/index.d.cts

@@ -146,6 +146,72 @@ interface FileSystem {
    * @throws It will not throw any errors if the file, directory, or symbolic link does not exist.
    */
   exists(uri: URI): Promise<FileStat | false>;
+  /**
+   * Glob files by pattern.
+   *
+   * @param globPattern The glob pattern.
+   * @param options The options for the glob.
+   * @param options.onlyFiles Only include files in the results. Default is `true`.
+   * @param options.onlyDirectories Only include directories in the results. Default is `false`.
+   * @param options.followSymbolicLinks Follow symbolic links in the results. Default is `true`.
+   * @param options.ignore Ignore files in the results. Default is `[]`.
+   * @param options.dot Include files and directories that start with a dot like `.gitignore`. Default is `true`.
+   * @param options.expandDirectories Whether to automatically expand directory patterns. Default is `true`. Important to disable if migrating from [`fast-glob`](https://github.com/mrmlnc/fast-glob).
+   * @param options.extglob Enables support for extglobs, like `+(pattern)`. Default is `true`.
+   * @param options.deep Maximum directory depth to crawl. Default is `Infinity`.
+   * @returns An array of file uris.
+   */
+  glob(globPattern: RelativePattern, options?: {
+    /**
+     * Only include files in the results.
+     *
+     * @default true
+     */
+    onlyFiles?: boolean;
+    /**
+     * Only include directories in the results.
+     *
+     * @default false
+     */
+    onlyDirectories?: boolean;
+    /**
+     * Follow symbolic links in the results.
+     *
+     * @default true
+     */
+    followSymbolicLinks?: boolean;
+    /**
+     * Ignore files in the results.
+     *
+     * @default []
+     */
+    ignore?: string[];
+    /**
+     * Include files and directories that start with a dot like `.gitignore`.
+     *
+     * @default true
+     */
+    dot?: boolean;
+    /**
+     * Whether to automatically expand directory patterns.
+     *
+     * Important to disable if migrating from [`fast-glob`](https://github.com/mrmlnc/fast-glob).
+     *
+     * @default true
+     */
+    expandDirectories?: boolean;
+    /**
+     * Enables support for extglobs, like `+(pattern)`.
+     *
+     * @default true
+     */
+    extglob?: boolean;
+    /**
+     * Maximum directory depth to crawl.
+     * @default Infinity
+     */
+    deep?: number;
+  }): Promise<URI[]>;
 }
 /**
  * The `FileStat`-type represents metadata about a file
@@ -218,6 +284,51 @@ declare enum FileSystemProviderErrorCode {
   Unavailable = "Unavailable",
   Unknown = "Unknown"
 }
+/**
+ * A relative pattern is a helper to construct glob patterns that are matched
+ * relatively to a base file path. The base path can either be an absolute file
+ * path as string or uri or a {@link WorkspaceFolder workspace folder}, which is the
+ * preferred way of creating the relative pattern.
+ */
+declare class RelativePattern {
+  /**
+   * A base file path to which this pattern will be matched against relatively. The
+   * file path must be absolute, should not have any trailing path separators and
+   * not include any relative segments (`.` or `..`).
+   */
+  baseUri: URI;
+  /**
+   * A file glob pattern like `*.{ts,js}` that will be matched on file paths
+   * relative to the base path.
+   *
+   * Example: Given a base of `/home/work/folder` and a file path of `/home/work/folder/index.js`,
+   * the file glob pattern will match on `index.js`.
+   */
+  pattern: string;
+  /**
+   * Creates a new relative pattern object with a base file path and pattern to match. This pattern
+   * will be matched on file paths relative to the base.
+   *
+   * Example:
+   * ```ts
+   * const folder = vscode.workspace.workspaceFolders?.[0];
+   * if (folder) {
+   *
+   *   // Match any TypeScript file in the root of this workspace folder
+   *   const pattern1 = new vscode.RelativePattern(folder, '*.ts');
+   *
+   *   // Match any TypeScript file in `someFolder` inside this workspace folder
+   *   const pattern2 = new vscode.RelativePattern(folder, 'someFolder/*.ts');
+   * }
+   * ```
+   *
+   * @param base A base to which this pattern will be matched against relatively. It is recommended
+   * to pass in a {@link WorkspaceFolder workspace folder} if the pattern should match inside the workspace.
+   * Otherwise, a uri or string should only be used if the pattern is for a file path outside the workspace.
+   * @param pattern A file glob pattern like `*.{ts,js}` that will be matched on paths relative to the base.
+   */
+  constructor(base: URI, pattern: string);
+}
 //#endregion
 //#region src/error.d.ts
 declare function createFileSystemError(error: Error | string, code: FileSystemProviderErrorCode): FileSystemError;
@@ -226,4 +337,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, createFileSystemError, createNodeFileSystem, toFileSystemError };
+export { FileStat, FileSystem, FileSystemError, FileSystemProviderErrorCode, FileType, IsDirectory, IsFile, IsSymbolicLink, RelativePattern, createFileSystemError, createNodeFileSystem, toFileSystemError };

package/dist/index.d.mts

@@ -146,6 +146,72 @@ interface FileSystem {
    * @throws It will not throw any errors if the file, directory, or symbolic link does not exist.
    */
   exists(uri: URI): Promise<FileStat | false>;
+  /**
+   * Glob files by pattern.
+   *
+   * @param globPattern The glob pattern.
+   * @param options The options for the glob.
+   * @param options.onlyFiles Only include files in the results. Default is `true`.
+   * @param options.onlyDirectories Only include directories in the results. Default is `false`.
+   * @param options.followSymbolicLinks Follow symbolic links in the results. Default is `true`.
+   * @param options.ignore Ignore files in the results. Default is `[]`.
+   * @param options.dot Include files and directories that start with a dot like `.gitignore`. Default is `true`.
+   * @param options.expandDirectories Whether to automatically expand directory patterns. Default is `true`. Important to disable if migrating from [`fast-glob`](https://github.com/mrmlnc/fast-glob).
+   * @param options.extglob Enables support for extglobs, like `+(pattern)`. Default is `true`.
+   * @param options.deep Maximum directory depth to crawl. Default is `Infinity`.
+   * @returns An array of file uris.
+   */
+  glob(globPattern: RelativePattern, options?: {
+    /**
+     * Only include files in the results.
+     *
+     * @default true
+     */
+    onlyFiles?: boolean;
+    /**
+     * Only include directories in the results.
+     *
+     * @default false
+     */
+    onlyDirectories?: boolean;
+    /**
+     * Follow symbolic links in the results.
+     *
+     * @default true
+     */
+    followSymbolicLinks?: boolean;
+    /**
+     * Ignore files in the results.
+     *
+     * @default []
+     */
+    ignore?: string[];
+    /**
+     * Include files and directories that start with a dot like `.gitignore`.
+     *
+     * @default true
+     */
+    dot?: boolean;
+    /**
+     * Whether to automatically expand directory patterns.
+     *
+     * Important to disable if migrating from [`fast-glob`](https://github.com/mrmlnc/fast-glob).
+     *
+     * @default true
+     */
+    expandDirectories?: boolean;
+    /**
+     * Enables support for extglobs, like `+(pattern)`.
+     *
+     * @default true
+     */
+    extglob?: boolean;
+    /**
+     * Maximum directory depth to crawl.
+     * @default Infinity
+     */
+    deep?: number;
+  }): Promise<URI[]>;
 }
 /**
  * The `FileStat`-type represents metadata about a file
@@ -218,6 +284,51 @@ declare enum FileSystemProviderErrorCode {
   Unavailable = "Unavailable",
   Unknown = "Unknown"
 }
+/**
+ * A relative pattern is a helper to construct glob patterns that are matched
+ * relatively to a base file path. The base path can either be an absolute file
+ * path as string or uri or a {@link WorkspaceFolder workspace folder}, which is the
+ * preferred way of creating the relative pattern.
+ */
+declare class RelativePattern {
+  /**
+   * A base file path to which this pattern will be matched against relatively. The
+   * file path must be absolute, should not have any trailing path separators and
+   * not include any relative segments (`.` or `..`).
+   */
+  baseUri: URI;
+  /**
+   * A file glob pattern like `*.{ts,js}` that will be matched on file paths
+   * relative to the base path.
+   *
+   * Example: Given a base of `/home/work/folder` and a file path of `/home/work/folder/index.js`,
+   * the file glob pattern will match on `index.js`.
+   */
+  pattern: string;
+  /**
+   * Creates a new relative pattern object with a base file path and pattern to match. This pattern
+   * will be matched on file paths relative to the base.
+   *
+   * Example:
+   * ```ts
+   * const folder = vscode.workspace.workspaceFolders?.[0];
+   * if (folder) {
+   *
+   *   // Match any TypeScript file in the root of this workspace folder
+   *   const pattern1 = new vscode.RelativePattern(folder, '*.ts');
+   *
+   *   // Match any TypeScript file in `someFolder` inside this workspace folder
+   *   const pattern2 = new vscode.RelativePattern(folder, 'someFolder/*.ts');
+   * }
+   * ```
+   *
+   * @param base A base to which this pattern will be matched against relatively. It is recommended
+   * to pass in a {@link WorkspaceFolder workspace folder} if the pattern should match inside the workspace.
+   * Otherwise, a uri or string should only be used if the pattern is for a file path outside the workspace.
+   * @param pattern A file glob pattern like `*.{ts,js}` that will be matched on paths relative to the base.
+   */
+  constructor(base: URI, pattern: string);
+}
 //#endregion
 //#region src/error.d.ts
 declare function createFileSystemError(error: Error | string, code: FileSystemProviderErrorCode): FileSystemError;
@@ -226,4 +337,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, createFileSystemError, createNodeFileSystem, toFileSystemError };
+export { FileStat, FileSystem, FileSystemError, FileSystemProviderErrorCode, FileType, IsDirectory, IsFile, IsSymbolicLink, RelativePattern, createFileSystemError, createNodeFileSystem, toFileSystemError };

package/dist/index.mjs

@@ -45,6 +45,54 @@ let FileSystemProviderErrorCode = /* @__PURE__ */ function(FileSystemProviderErr
 	FileSystemProviderErrorCode["Unknown"] = "Unknown";
 	return FileSystemProviderErrorCode;
 }({});
+/**
+* A relative pattern is a helper to construct glob patterns that are matched
+* relatively to a base file path. The base path can either be an absolute file
+* path as string or uri or a {@link WorkspaceFolder workspace folder}, which is the
+* preferred way of creating the relative pattern.
+*/
+var RelativePattern = class {
+	/**
+	* A base file path to which this pattern will be matched against relatively. The
+	* file path must be absolute, should not have any trailing path separators and
+	* not include any relative segments (`.` or `..`).
+	*/
+	baseUri;
+	/**
+	* A file glob pattern like `*.{ts,js}` that will be matched on file paths
+	* relative to the base path.
+	*
+	* Example: Given a base of `/home/work/folder` and a file path of `/home/work/folder/index.js`,
+	* the file glob pattern will match on `index.js`.
+	*/
+	pattern;
+	/**
+	* Creates a new relative pattern object with a base file path and pattern to match. This pattern
+	* will be matched on file paths relative to the base.
+	*
+	* Example:
+	* ```ts
+	* const folder = vscode.workspace.workspaceFolders?.[0];
+	* if (folder) {
+	*
+	*   // Match any TypeScript file in the root of this workspace folder
+	*   const pattern1 = new vscode.RelativePattern(folder, '*.ts');
+	*
+	*   // Match any TypeScript file in `someFolder` inside this workspace folder
+	*   const pattern2 = new vscode.RelativePattern(folder, 'someFolder/*.ts');
+	* }
+	* ```
+	*
+	* @param base A base to which this pattern will be matched against relatively. It is recommended
+	* to pass in a {@link WorkspaceFolder workspace folder} if the pattern should match inside the workspace.
+	* Otherwise, a uri or string should only be used if the pattern is for a file path outside the workspace.
+	* @param pattern A file glob pattern like `*.{ts,js}` that will be matched on paths relative to the base.
+	*/
+	constructor(base, pattern) {
+		this.baseUri = base;
+		this.pattern = pattern;
+	}
+};
 
 //#endregion
 //#region src/error.ts
@@ -118,7 +166,11 @@ function joinPath(basePath, ...segments) {
 	return Utils.joinPath(URI.file(basePath), ...segments).fsPath;
 }
 async function createNodeFileSystem() {
-	const [fs, trash] = await Promise.all([import("node:fs"), import("trash").then((m) => m.default)]);
+	const [fs, trash, glob] = await Promise.all([
+		import("node:fs"),
+		import("trash").then((m) => m.default),
+		import("tinyglobby").then((m) => m.glob)
+	]);
 	async function resolveFileType(path) {
 		const lstats = await fs.promises.lstat(path);
 		if (!lstats.isSymbolicLink()) return {
@@ -168,6 +220,9 @@ async function createNodeFileSystem() {
 		}
 		throw createFileSystemError(`Unsupported file type: ${sourcePath}`, FileSystemProviderErrorCode.Unknown);
 	}
+	function pathToUris(pathToUris) {
+		return pathToUris.map((path) => URI.file(path));
+	}
 	return {
 		stat: (uri) => wrap(async () => {
 			const { type, stats } = await resolveFileType(uri.fsPath);
@@ -253,9 +308,24 @@ async function createNodeFileSystem() {
 			} catch {
 				return false;
 			}
+		},
+		glob: async (pattern, options) => {
+			return pathToUris(await glob(pattern.pattern, {
+				absolute: true,
+				cwd: pattern.baseUri.fsPath,
+				onlyFiles: options?.onlyFiles,
+				onlyDirectories: options?.onlyDirectories,
+				followSymbolicLinks: options?.followSymbolicLinks,
+				ignore: options?.ignore,
+				dot: options?.dot,
+				expandDirectories: options?.expandDirectories,
+				extglob: options?.extglob,
+				deep: options?.deep,
+				fs
+			}));
 		}
 	};
 }
 
 //#endregion
-export { FileSystemError, FileSystemProviderErrorCode, FileType, createFileSystemError, createNodeFileSystem, toFileSystemError };
+export { FileSystemError, FileSystemProviderErrorCode, FileType, RelativePattern, createFileSystemError, createNodeFileSystem, toFileSystemError };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vscode-fs",
   "type": "module",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "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": {
+    "tinyglobby": "^0.2.15",
     "trash": "^10.1.1"
   },
   "devDependencies": {