@effected/walker 0.20.1 → 0.22.0

package/node-sync.d.ts

@@ -0,0 +1,102 @@
+import "@effected/glob";
+import "effect";
+/**
+ * The stats {@link WalkerSyncFileSystem} answers — a structural subset of
+ * `node:fs` `Stats`, so `statSync` / `lstatSync` satisfy it verbatim.
+ *
+ * @public
+ */
+interface WalkerSyncStats {
+  /** Whether the entry is a regular file. */
+  isFile(): boolean;
+  /** Whether the entry is a directory. */
+  isDirectory(): boolean;
+  /** Whether the entry is a symbolic link (only ever true for `lstat`). */
+  isSymbolicLink(): boolean;
+  /** Modification time, epoch milliseconds. */
+  readonly mtimeMs: number;
+  /** Size in bytes. */
+  readonly size: number;
+}
+/**
+ * The synchronous file operations the sync walk needs, supplied by the
+ * consumer — `node:fs` satisfies it (`nodeWalkerFileSystem` from
+ * `@effected/walker/node-sync`).
+ *
+ * @remarks
+ * Every member reports failure by throwing a node-shaped error. A `code` of
+ * `"ENOENT"` is the benign vanished-path race (empty, never recorded); any
+ * other throw from `readDirectory` or `realPath` is an unreadable directory,
+ * handled per `onUnreadable`. A throwing `stat` or `lstat` reads as "no
+ * entry", exactly as the `Effect` walk reads its failed `stat` and `lstat`.
+ *
+ * @public
+ */
+interface WalkerSyncFileSystem {
+  /** The entry names inside the directory at `path` (`readdirSync`). */
+  readonly readDirectory: (path: string) => ReadonlyArray<string>;
+  /** Stats of `path`, following links (`statSync`). */
+  readonly stat: (path: string) => WalkerSyncStats;
+  /** Stats of `path` itself, not following a final link (`lstatSync`). */
+  readonly lstat: (path: string) => WalkerSyncStats;
+  /** The real path of `path`, links resolved (`realpathSync`). */
+  readonly realPath: (path: string) => string;
+}
+/**
+ * The synchronous path operations the sync forms need — a structural subset
+ * of `node:path`, so the module itself (or its `win32` / `posix` variant)
+ * satisfies it. It shapes only the absolute paths handed to the
+ * {@link WalkerSyncFileSystem}; matching is POSIX-relative by the glob
+ * contract.
+ *
+ * @remarks
+ * The members mirror core's `Path` service, so a sync form judges
+ * absoluteness, ascends and compares ceilings exactly as its `Effect` twin
+ * does under the `Path` layer of the same platform.
+ *
+ * @public
+ */
+interface WalkerSyncPath {
+  /** The implementation's separator (`path.sep`). */
+  readonly sep: string;
+  /** Join segments with the implementation's separator (like `path.join`). */
+  readonly join: (...segments: ReadonlyArray<string>) => string;
+  /** The parent directory of a path (like `path.dirname`); a fixpoint at the root. */
+  readonly dirname: (path: string) => string;
+  /** Resolve segments to a normalized path (like `path.resolve`). */
+  readonly resolve: (...segments: ReadonlyArray<string>) => string;
+  /** Whether a path is absolute under this implementation (like `path.isAbsolute`). */
+  readonly isAbsolute: (path: string) => boolean;
+}
+/**
+ * The platform half of every sync walk.
+ *
+ * @public
+ */
+interface WalkerSyncOps {
+  /** File operations. */
+  readonly fileSystem: WalkerSyncFileSystem;
+  /** Path joining. */
+  readonly path: WalkerSyncPath;
+}
+/**
+ * `WalkerSyncFileSystem` over `node:fs`: `readdirSync`, `statSync`,
+ * `lstatSync`, `realpathSync`.
+ *
+ * @public
+ */
+export declare const nodeWalkerFileSystem: WalkerSyncFileSystem;
+/**
+ * `WalkerSyncPath` over `node:path` (the host platform's separator).
+ *
+ * @public
+ */
+export declare const nodeWalkerPath: WalkerSyncPath;
+/**
+ * Both bindings, to spread into `descendSync` options.
+ *
+ * @public
+ */
+export declare const nodeWalkerSyncOps: WalkerSyncOps;
+export type { WalkerSyncFileSystem, WalkerSyncOps, WalkerSyncPath, WalkerSyncStats };
+//# sourceMappingURL=node-sync.d.ts.map

package/node-sync.js

@@ -0,0 +1,61 @@
+import { lstatSync, readdirSync, realpathSync, statSync } from "node:fs";
+import * as path from "node:path";
+
+// src/node-sync.ts
+/**
+* The Node.js binding for the synchronous walk — a ready-made
+* `WalkerSyncFileSystem` over `node:fs` and `WalkerSyncPath` over `node:path`,
+* so adopting `descendSync` is one import.
+*
+* Deliberately a **separate subpath** (`@effected/walker/node-sync`), not part
+* of the main entry: the main entry takes its platform through `R` (or, for the
+* sync forms, from the caller) and imports nothing platform-shaped.
+*
+* @example
+* ```ts
+* import { GlobPattern } from "@effected/glob";
+* import { descendSync } from "@effected/walker";
+* import { nodeWalkerSyncOps } from "@effected/walker/node-sync";
+* import { Result } from "effect";
+*
+* const pattern = Result.getOrThrow(GlobPattern.compileResult("src/**"));
+* const files = descendSync(pattern, { cwd: process.cwd(), ...nodeWalkerSyncOps });
+* ```
+*
+* @packageDocumentation
+*/
+/**
+* `WalkerSyncFileSystem` over `node:fs`: `readdirSync`, `statSync`,
+* `lstatSync`, `realpathSync`.
+*
+* @public
+*/
+const nodeWalkerFileSystem = {
+	readDirectory: (p) => readdirSync(p),
+	stat: (p) => statSync(p),
+	lstat: (p) => lstatSync(p),
+	realPath: (p) => realpathSync(p)
+};
+/**
+* `WalkerSyncPath` over `node:path` (the host platform's separator).
+*
+* @public
+*/
+const nodeWalkerPath = {
+	sep: path.sep,
+	join: path.join,
+	dirname: path.dirname,
+	resolve: path.resolve,
+	isAbsolute: path.isAbsolute
+};
+/**
+* Both bindings, to spread into `descendSync` options.
+*
+* @public
+*/
+const nodeWalkerSyncOps = {
+	fileSystem: nodeWalkerFileSystem,
+	path: nodeWalkerPath
+};
+
+export { nodeWalkerFileSystem, nodeWalkerPath, nodeWalkerSyncOps };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/walker",
-	"version": "0.20.1",
+	"version": "0.22.0",
 	"private": false,
 	"description": "Path traversal as Effect primitives: ascend a directory chain to the first matching candidate, or descend a tree expanding a glob against the filesystem.",
 	"keywords": [
@@ -34,10 +34,15 @@
 			"import": "./index.js",
 			"default": "./index.js"
 		},
+		"./node-sync": {
+			"types": "./node-sync.d.ts",
+			"import": "./node-sync.js",
+			"default": "./node-sync.js"
+		},
 		"./package.json": "./package.json"
 	},
 	"peerDependencies": {
-		"@effected/glob": "^0.14.0",
+		"@effected/glob": "^0.16.0",
 		"effect": "^4.0.0"
 	},
 	"engines": {