@rust-gear/glob 0.2.0 → 0.2.1

package/README.md

@@ -13,20 +13,20 @@ npm install --save-dev @rust-gear/glob
 ```js
 import { globSync, glob } from "@rust-gear/glob";
 
-const files = globSync("src/**/*.rs", { cwd: process.cwd() });
+const files = globSync("src/**/*.rs");
 console.log(files);
 
-const filesAsync = await glob("src/**/*.rs", { cwd: process.cwd() });
+const filesAsync = await glob("src/**/*.rs");
 console.log(filesAsync);
 ```
 
 ## Options
 
-You must pass an options object as the second argument to `globSync`/`glob`.  
-The `cwd` option is **required**.
+You can pass an options object as the second argument to `globSync/glob`.
 
-> **Note:**  
-> If you need to search an absolute path, set it as `cwd` and use a relative pattern.
+> **Return path type:**  
+> If the pattern is absolute, absolute paths are returned.  
+> If the pattern is relative, paths are returned relative to the specified `cwd`.
 
 | Option  | Type     | Description                                            |
 | :------ | :------- | :----------------------------------------------------- |
@@ -36,18 +36,28 @@ The `cwd` option is **required**.
 ### Example
 
 ```js
+// Relative pattern, returns paths relative to cwd
 const files = globSync("**/*.rs", {
   cwd: "src",
   exclude: ["**/test/**", "**/target/**"],
 });
+
+// Convert all relative paths to absolute paths
+const absFiles = globSync("**/*.rs", {
+  cwd: "src",
+  exclude: ["**/test/**", "**/target/**"],
+}).map((f) => path.resolve(cwd(), f));
+
+// Absolute pattern, returns absolute paths
+const absoluteFiles = globSync("/Users/foo/project/src/**/*.rs");
 ```
 
 ## API
 
-**globSync(pattern: string \| string[], options: GlobOptions): string[]**  
+**globSync(pattern: string \| string[], options?: GlobOptions): string[]**  
 Synchronously returns an array of file paths.
 
-**glob(pattern: string \| string[], options: GlobOptions): Promise<string[]>**  
+**glob(pattern: string \| string[], options?: GlobOptions): Promise<string[]>**  
 Asynchronously returns an array of file paths.
 
 ## License

package/index.d.ts

@@ -5,7 +5,7 @@
 
 export interface GlobOptions {
   exclude?: Array<string>
-  cwd: string
+  cwd?: string
 }
-export declare function globSync(patterns: string | Array<string>, options: GlobOptions): Array<string>
-export declare function glob(patterns: string | Array<string>, options: GlobOptions): Promise<Array<string>>
+export declare function globSync(patterns: string | Array<string>, options?: GlobOptions | undefined | null): Array<string>
+export declare function glob(patterns: string | Array<string>, options?: GlobOptions | undefined | null): Promise<Array<string>>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rust-gear/glob",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Node.js bindings for Rust glob library",
   "keywords": [
     "rust-gear",
@@ -53,14 +53,14 @@
     "@napi-rs/cli": "^2.18.4"
   },
   "optionalDependencies": {
-    "@rust-gear/glob-darwin-arm64": "0.2.0",
-    "@rust-gear/glob-darwin-x64": "0.2.0",
-    "@rust-gear/glob-linux-arm64-gnu": "0.2.0",
-    "@rust-gear/glob-linux-arm64-musl": "0.2.0",
-    "@rust-gear/glob-linux-x64-gnu": "0.2.0",
-    "@rust-gear/glob-linux-x64-musl": "0.2.0",
-    "@rust-gear/glob-win32-arm64-msvc": "0.2.0",
-    "@rust-gear/glob-win32-ia32-msvc": "0.2.0",
-    "@rust-gear/glob-win32-x64-msvc": "0.2.0"
+    "@rust-gear/glob-darwin-arm64": "0.2.1",
+    "@rust-gear/glob-darwin-x64": "0.2.1",
+    "@rust-gear/glob-linux-arm64-gnu": "0.2.1",
+    "@rust-gear/glob-linux-arm64-musl": "0.2.1",
+    "@rust-gear/glob-linux-x64-gnu": "0.2.1",
+    "@rust-gear/glob-linux-x64-musl": "0.2.1",
+    "@rust-gear/glob-win32-arm64-msvc": "0.2.1",
+    "@rust-gear/glob-win32-ia32-msvc": "0.2.1",
+    "@rust-gear/glob-win32-x64-msvc": "0.2.1"
   }
 }