@better-fs-tools/just-bash 0.1.0 → 0.2.0

package/README.md

@@ -34,9 +34,6 @@ const read = createReadTool({
 
 console.log(textOf(await read({ path: "src/index.ts" })));
 // 1|const a = 1;
-//
-// [read:weak-identity] The sandbox backend has no stable identity, ...
-// [read:buffered-backend] The sandbox backend buffers whole objects instead of streaming them.
 ```
 
 The same filesystem, with the write tools:
@@ -62,10 +59,6 @@ const edit = createEditTool({ ...shared, locks: memoryLocks() });
 await read({ path: "src/index.ts" });
 console.log(textOf(await edit({ path: "src/index.ts", edits: [{ oldText: "1", newText: "2" }] })));
 // Edited src/index.ts: 1 replacement at line 1.
-// 1|const a = 2;
-//
-// [edit:not-atomic] The sandbox backend does not replace files atomically, ...
-// [edit:no-compare-and-swap] The sandbox backend cannot check the file version ...
 console.log(await bash.readFile("/workspace/src/index.ts")); // const a = 2;
 ```
 
@@ -73,9 +66,9 @@ console.log(await bash.readFile("/workspace/src/index.ts")); // const a = 2;
 
 - `justBashFileSystem(fs, options)` takes the shared `FileSystemRootOptions` and `maxBufferedBytes` from `@better-fs-tools/fs`. It checks each path against `allowedRoots` and `denyRoots` before it touches the backend, and again after `realpath()`. `cwd` must be absolute and defaults to `/`.
 - `id` defaults to `"just-bash"`. It namespaces versions, so two backends that share one state store need two ids.
-- `maxBufferedBytes` defaults to 16 MiB. `just-bash` returns whole buffers, so reads are buffered and results have a `buffered-backend` note. A larger file gives `too-large`, which the tools report as `TOO_LARGE`.
+- `maxBufferedBytes` defaults to 16 MiB. `just-bash` returns whole buffers, so reads are buffered. A larger file gives `too-large`, which the tools report as `TOO_LARGE`.
 - Reads are buffered inside `open()`, so the whole file has left the backend before the read tool's `authorize` runs. The core still passes no byte to a classifier, a converter, or the model until `authorize` allows it. If a denied read must not reach the backend, deny it in the adapter with `denyRoots` or `allowedRoots`.
-- `identity` defaults to `"none"`: change detection compares size and modification time, and results have a `weak-identity` note. With `identity: "required"`, the backend's `stat()` must give an identity or a device and inode for every file. A file without one is refused as `UNSUPPORTED_BACKEND`.
+- `identity` defaults to `"none"`: change detection compares size and modification time. With `identity: "required"`, the backend's `stat()` must give an identity or a device and inode for every file. A file without one is refused as `UNSUPPORTED_BACKEND`.
 - `symlinks` defaults to `"reject"`, which refuses a symlink in any component of the path, as in the Node and Cloudflare adapters. `"follow-within-roots"` follows links, and the real path must still be inside the roots.
 - The resolved options are on the filesystem as `cwd`, `allowedRoots`, `denyRoots`, `maxBufferedBytes`, `identity`, and `symlinks`.
 - For a read-only view, wrap it: `readOnlyFileSystem(justBashFileSystem(bash, options))` from `@better-fs-tools/fs` drops the write methods.
@@ -87,7 +80,7 @@ console.log(await bash.readFile("/workspace/src/index.ts")); // const a = 2;
 `write()` needs `writeFile`, `mkdir`, `chmod`, and `utimes` on the backend, and `remove()` needs `rm`. They are checked when a write runs, not when the filesystem is built, so a backend without them still serves reads. A write to such a backend gives `unsupported`, which the tools report as `UNSUPPORTED_BACKEND`. The `fs` parameter has the type `JustBashBackend`: `lstat`, `realpath`, `stat`, `readFileBuffer`, and `readdir` are required, and `readdirWithFileTypes` and the write methods are optional. A full `IFileSystem` fits it, and so does a read-only backend, with no cast.
 
 - Writes apply the same roots, deny roots, and symlink policy as `open()`. Under `"reject"`, a symlink anywhere on the path is refused. Under `"follow-within-roots"`, a link inside the roots is followed to its real path and the link stays. A link out of the roots and a dangling link are refused.
-- `writeCapabilities` is `{ atomic: false, compareAndSwap: false, preserveMode: true }`. A write is `writeFile` and then `chmod`, and `IFileSystem` has no version check, so the adapter checks the precondition with a fresh stat just before the write. The write tools add a `not-atomic` and a `no-compare-and-swap` note.
+- `writeCapabilities` is `{ compareAndSwap: false }`. A write is `writeFile` and then `chmod`, so it is not atomic. `IFileSystem` has no version check, so the adapter checks the precondition with a fresh stat just before the write.
 - `InMemoryFs` resets the mode to `0o644` on every write, so a replace calls `chmod` with the old mode.
 - `InMemoryFs` keeps `mtime` when two writes fall in one millisecond. When a replace leaves `mtime` where it was, the adapter moves it on by one millisecond with `utimes`, so every write through the adapter changes the version.
 - `identity: "required"` makes the write tools trust the version, which is the identity, size, and `mtime`. Another writer that changes a file to the same size inside the same millisecond is then not seen. With the default, `identity: "none"`, the write tools also compare the content hash of what the model read.

package/dist/contract.d.ts

@@ -19,7 +19,7 @@ export type JustBashBackend = Pick<IFileSystem, "lstat" | "realpath" | "stat" |
 export interface JustBashFileSystemOptions extends FileSystemRootOptions, BufferedFileSystemOptions {
 }
 /**
- * `writeCapabilities` is `{ atomic: false, compareAndSwap: false, preserveMode: true }`.
+ * `writeCapabilities` is `{ compareAndSwap: false }`.
  * The write methods need `writeFile`, `mkdir`, `chmod`, `utimes`, and `rm` on
  * the backend. They are checked when a write runs, so a backend without them
  * still serves reads.

package/dist/index.d.ts

@@ -11,8 +11,8 @@ export type { JustBashBackend, JustBashFileSystem, JustBashFileSystemOptions } f
  * returned, not the backend's own directory read.
  *
  * `stat`, `write` and `remove` keep the same roots, deny roots and symlink
- * policy as `open()`. `writeCapabilities` is `{ atomic: false,
- * compareAndSwap: false, preserveMode: true }`. There is no `stage()`. For a
+ * policy as `open()`. `writeCapabilities` is `{ compareAndSwap: false }`.
+ * There is no `stage()`. For a
  * read-only view, wrap the result in `readOnlyFileSystem()` from
  * `@better-fs-tools/fs`.
  */

package/dist/index.js

@@ -11,8 +11,8 @@ export { justBashCommandRunner } from "./command-runner.js";
  * returned, not the backend's own directory read.
  *
  * `stat`, `write` and `remove` keep the same roots, deny roots and symlink
- * policy as `open()`. `writeCapabilities` is `{ atomic: false,
- * compareAndSwap: false, preserveMode: true }`. There is no `stage()`. For a
+ * policy as `open()`. `writeCapabilities` is `{ compareAndSwap: false }`.
+ * There is no `stage()`. For a
  * read-only view, wrap the result in `readOnlyFileSystem()` from
  * `@better-fs-tools/fs`.
  */
@@ -29,10 +29,7 @@ function readMethods(fs, configured) {
     const { id, cwd, allowedRoots, denyRoots, maxBufferedBytes, identity, symlinks } = configured;
     return {
         id,
-        capabilities: Object.freeze({
-            streaming: false,
-            identity: identity === "required",
-        }),
+        capabilities: Object.freeze({ identity: identity === "required" }),
         paths: posixPaths,
         cwd,
         allowedRoots,

package/dist/write.js

@@ -1,9 +1,7 @@
 import { posixPaths } from "@better-fs-tools/fs";
 import { AdapterRefusal, authorizeCanonical, authorizeRequested, backendCall, canonicalPath, display, fingerprint, inspect, refuse, refuseSymlinkComponents, requireRegularFile, requireStatKey, toFileSystemError, } from "./policy.js";
 export const JUST_BASH_WRITE_CAPABILITIES = Object.freeze({
-    atomic: false,
     compareAndSwap: false,
-    preserveMode: true,
 });
 export function justBashWrites(fs, settings) {
     const { id, cwd, allowedRoots, denyRoots, maxBufferedBytes, identity, symlinks } = settings;
@@ -102,7 +100,6 @@ export function justBashWrites(fs, settings) {
         identity: after?.exists === true && identity === "required" ? after.version : null,
         size: after?.exists === true ? after.stat.size : null,
         createdDirectories: created,
-        atomic: JUST_BASH_WRITE_CAPABILITIES.atomic,
     });
     return {
         async stat(requested, options = {}) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-fs-tools/just-bash",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "A readable and writable filesystem and a bash command runner over just-bash.",
   "license": "MIT",
   "repository": {
@@ -29,12 +29,12 @@
     "access": "public"
   },
   "dependencies": {
-    "@better-fs-tools/fs": "^0.1.0",
-    "@better-fs-tools/shell": "^0.1.0"
+    "@better-fs-tools/fs": "^0.2.0",
+    "@better-fs-tools/shell": "^0.2.0"
   },
   "devDependencies": {
-    "@better-fs-tools/read": "^0.1.0",
-    "@better-fs-tools/write": "^0.1.0",
+    "@better-fs-tools/read": "^0.2.0",
+    "@better-fs-tools/write": "^0.2.0",
     "just-bash": "3.4.2"
   },
   "peerDependencies": {