Add [Symbol.dispose] hook

README.md

@@ -18,6 +18,19 @@ Depending on your testing style, you may want to call `rm` in test teardown, or
 leave the fixture on disk for manual testing. If the latter, you can call `rm` immediately before `write`
 to reset the fixture every time it runs.
 
+[Explicit Resource Management](https://github.com/tc39/proposal-explicit-resource-management)
+may also be used to automatically call `rm` on the project when it goes out of scope.
+
+```ts
+import { tempdirProject } from "@typestrong/fs-fixture-builder";
+import { test } from "node:test"
+
+test("Something with the filesystem", () => {
+    using project = tempdirProject();
+    // project will be cleaned up automatically after the test, even if it fails
+})
+```
+
 ## CLI
 
 The command `capture-fs-fixture` is provided by this package to traverse a directory and generate code to recreate

src/fs-helpers.ts

@@ -207,7 +207,8 @@ function projectInternal(cwd: string) {
     addSymlink,
     write,
     rm,
-    copyFilesFrom
+    copyFilesFrom,
+    [Symbol.dispose]: rm,
   };
   return fixture;
 }

test/fixtures.test.ts

@@ -1,7 +1,7 @@
 import { afterEach, beforeEach, test } from "node:test"
 import { tempdirProject, type Project } from "#self"
 import { equal } from "assert";
-import { lstatSync, readFileSync } from "fs";
+import { existsSync, lstatSync, readFileSync } from "fs";
 import { join } from "path";
 
 let fixture: Project;
@@ -38,3 +38,13 @@ test("Supports defining symlinks", () => {
     const stat = lstatSync(join(fixture.cwd, "test2.txt"));
     equal(stat.isSymbolicLink(), true);
 });
+
+test("Supports explicit resource management", () => {
+    let cwd: string;
+    {
+        using fix = tempdirProject();
+        cwd = fix.cwd;
+    }
+
+    equal(existsSync(cwd), false);
+})