fs-fixture 2.11.0 → 2.13.0

package/README.md

@@ -17,6 +17,7 @@ Simple API to create disposable test fixtures on disk. Tiny (`1.1 kB` gzipped) w
 - 💾 Binary file support with Buffers
 - 🎯 TypeScript-first with full type safety
 - 🔄 File methods inherit types directly from Node.js `fs` module
+- 🔌 Pluggable filesystem — use with @platformatic/vfs, memfs, or any `fs/promises`-compatible API
 
 ## Installation
 
@@ -149,6 +150,19 @@ const fixture = await createFixture({
 })
 ```
 
+**Symlinks:**
+```ts
+const fixture = await createFixture({
+    'index.js': 'import pkg from \'pkg\'',
+
+    // Symlink individual file or directory
+    'node_modules/pkg': ({ symlink }) => symlink(process.cwd()),
+
+    // Symlink entire directory (useful for sharing node_modules)
+    node_modules: ({ symlink }) => symlink(path.resolve('node_modules'))
+})
+```
+
 **Binary files:**
 ```ts
 const fixture = await createFixture({
@@ -172,6 +186,31 @@ const fixture = await createFixture({
 })
 ```
 
+### Custom filesystem
+
+Pass any `fs/promises`-compatible API via the `fs` option to use a virtual filesystem instead of disk:
+
+```ts
+import { create, MemoryProvider } from '@platformatic/vfs'
+import { createFixture } from 'fs-fixture'
+
+const fs = create(new MemoryProvider()).promises
+const fixture = await createFixture({
+    'package.json': JSON.stringify({ name: 'test' }),
+    'src/index.js': 'export default 42'
+}, { fs })
+
+await fixture.readFile('src/index.js', 'utf8') // 'export default 42'
+```
+
+Works with any library that implements the `fs/promises` API shape, including [@platformatic/vfs](https://github.com/platformatic/vfs), the future [`node:vfs`](https://github.com/nodejs/node/pull/61478), and [memfs](https://github.com/streamich/memfs).
+
+> [!NOTE]
+> With a custom fs, files only exist in that fs instance. Use `fixture.readFile()` or `fixture.fs` to access them — `fixture.path` is a virtual path that doesn't exist on the real disk.
+
+> [!NOTE]
+> Template directory sources (string paths) are not supported with custom filesystems because most virtual fs implementations lack recursive `cp`. Use a `FileTree` object instead.
+
 ## API
 
 ### `createFixture(source?, options?)`
@@ -182,6 +221,7 @@ Creates a temporary fixture directory and returns a `FsFixture` instance.
 - `source` (optional): String path to template directory, or `FileTree` object defining the structure
 - `options.tempDir` (optional): Custom temp directory. Defaults to `os.tmpdir()`
 - `options.templateFilter` (optional): Filter function when copying from template directory
+- `options.fs` (optional): Custom `fs/promises`-compatible API for virtual filesystem support
 
 **Returns:** `Promise<FsFixture>`
 
@@ -197,6 +237,7 @@ const fixture = await createFixture({}, { tempDir: './custom-temp' })
 | Method | Description |
 |--------|-------------|
 | `fixture.path` | Absolute path to the fixture directory |
+| `fixture.fs` | The underlying `fs/promises` API used by the fixture |
 | `getPath(...paths)` | Get absolute path to file/directory in fixture |
 | `exists(path?)` | Check if file/directory exists |
 | `rm(path?)` | Delete file/directory (or entire fixture if no path) |
@@ -228,6 +269,34 @@ type Api = {
 ```
 </details>
 
+<details>
+<summary><strong>FsPromises</strong></summary>
+
+The subset of `fs/promises` methods that custom filesystem implementations must provide:
+
+```ts
+type FsPromises = {
+    // Required
+    readFile(path: string, options?): Promise<Buffer | string>
+    writeFile(path: string, data: string | Buffer, options?): Promise<void>
+    readdir(path: string, options?): Promise<string[] | Dirent[]>
+    mkdir(path: string, options?): Promise<string | undefined>
+    rename(oldPath: string, newPath: string): Promise<void>
+    access(path: string, mode?: number): Promise<void>
+
+    // Optional
+    rm?(path: string, options?): Promise<void>
+    unlink?(path: string): Promise<void>
+    rmdir?(path: string): Promise<void>
+    symlink?(target: string, path: string, type?: string): Promise<void>
+    cp?(source: string, destination: string, options?): Promise<void>
+    mkdtemp?(prefix: string): Promise<string>
+}
+```
+
+If `rm` is not available, fs-fixture falls back to recursive removal using `readdir({ withFileTypes })` + `unlink` + `rmdir`. If `mkdtemp` is not available, fixture paths are generated with a counter.
+</details>
+
 ## Related
 
 ### [manten](https://github.com/privatenumber/manten)

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";var g=Object.defineProperty;var c=(s,e)=>g(s,"name",{value:e,configurable:!0});var n=require("node:fs/promises"),f=require("node:path"),P=require("node:url"),v=require("node:fs"),F=require("node:os");typeof Symbol.asyncDispose!="symbol"&&Object.defineProperty(Symbol,"asyncDispose",{configurable:!1,enumerable:!1,writable:!1,value:Symbol.for("asyncDispose")});class b{static{c(this,"FsFixture")}path;constructor(e){this.path=e}getPath(...e){return f.join(this.path,...e)}exists(e=""){return n.access(this.getPath(e)).then(()=>!0,()=>!1)}rm(e=""){return n.rm(this.getPath(e),{recursive:!0,force:!0})}cp(e,t,i){return t?t.endsWith(f.sep)&&(t+=f.basename(e)):t=f.basename(e),n.cp(e,this.getPath(t),i)}mkdir(e){return n.mkdir(this.getPath(e),{recursive:!0})}mv(e,t){return n.rename(this.getPath(e),this.getPath(t))}readFile=c(((e,t)=>n.readFile(this.getPath(e),t)),"readFile");readdir=c(((e,t)=>n.readdir(this.getPath(e||""),t)),"readdir");writeFile=c(((e,t,...i)=>n.writeFile(this.getPath(e),t,...i)),"writeFile");async readJson(e){const t=await this.readFile(e,"utf8");return JSON.parse(t)}writeJson(e,t,i=2){return this.writeFile(e,JSON.stringify(t,null,i))}async[Symbol.asyncDispose](){await this.rm()}}const D=v.realpathSync(F.tmpdir());class p{static{c(this,"PathBase")}constructor(e){this.path=e}}class y extends p{static{c(this,"Directory")}}class m extends p{static{c(this,"File")}constructor(e,t){super(e),this.content=t}}class u extends p{static{c(this,"Symlink")}constructor(e,t,i){super(i??""),this.target=e,this.type=t}}const d=c((s,e,t)=>{const i=[];for(const h in s){if(!Object.hasOwn(s,h))continue;const o=f.join(e,h);let a=s[h];if(typeof a=="function"){const r=Object.assign(Object.create(t),{filePath:o}),l=a(r);if(l instanceof u){const w=new u(l.target,l.type,o);i.push(w);continue}else a=l}if(typeof a=="string"||Buffer.isBuffer(a))i.push(new m(o,a));else if(a&&typeof a=="object"&&!Array.isArray(a))i.push(new y(o),...d(a,o,t));else throw new TypeError(`Invalid file content for path "${o}". Functions must return a string, Buffer, Symlink, or a nested FileTree object. Received: ${String(a)}`)}return i},"flattenFileTree"),j=c(async(s,e)=>{const t=e?.tempDir?f.resolve(typeof e.tempDir=="string"?e.tempDir:P.fileURLToPath(e.tempDir)):D;e?.tempDir&&await n.mkdir(t,{recursive:!0});const i=await n.mkdtemp(f.join(t,"fs-fixture-"));if(s){if(typeof s=="string")await n.cp(s,i,{recursive:!0,filter:e?.templateFilter});else if(typeof s=="object"){const o=d(s,i,{fixturePath:i,getPath:c((...r)=>f.join(i,...r),"getPath"),symlink:c((r,l)=>new u(r,l),"symlink")}),a=new Set;for(const r of o)r instanceof y?a.add(r.path):(r instanceof m||r instanceof u)&&a.add(f.dirname(r.path));await Promise.all(Array.from(a).map(r=>n.mkdir(r,{recursive:!0}))),await Promise.all(o.map(async r=>{r instanceof u?await n.symlink(r.target,r.path,r.type):r instanceof m&&await n.writeFile(r.path,r.content)}))}}return new b(i)},"createFixture");exports.createFixture=j;
+"use strict";var v=Object.defineProperty;var o=(r,e)=>v(r,"name",{value:e,configurable:!0});var y=require("node:fs/promises"),c=require("node:path"),F=require("node:url"),b=require("node:fs"),j=require("node:os");const w=o(async(r,e)=>{try{await r.unlink(e);return}catch(i){if(D(i))return}const t=await r.readdir(e,{withFileTypes:!0});await Promise.all(t.map(i=>{const n=c.join(e,i.name);return i.isDirectory()?w(r,n):r.unlink(n)})),await r.rmdir(e)},"recursiveRm"),D=o(r=>r instanceof Error&&"code"in r&&r.code==="ENOENT","isEnoent");typeof Symbol.asyncDispose!="symbol"&&Object.defineProperty(Symbol,"asyncDispose",{configurable:!1,enumerable:!1,writable:!1,value:Symbol.for("asyncDispose")});class x{static{o(this,"FsFixture")}path;fs;constructor(e,t){this.path=e,this.fs=t??y}getPath(...e){return c.join(this.path,...e)}exists(e=""){return this.fs.access(this.getPath(e)).then(()=>!0,()=>!1)}rm(e=""){const t=this.getPath(e);if(this.fs.rm)return this.fs.rm(t,{recursive:!0,force:!0});if(!this.fs.unlink||!this.fs.rmdir)throw new Error("rm() requires the fs API to support rm(), or unlink() + rmdir()");return w(this.fs,t)}cp(e,t,i){if(!this.fs.cp)throw new Error("cp() requires the fs API to support cp()");return t?(t.endsWith("/")||t.endsWith(c.sep))&&(t+=c.basename(e)):t=c.basename(e),this.fs.cp(e,this.getPath(t),i)}mkdir(e){return this.fs.mkdir(this.getPath(e),{recursive:!0})}mv(e,t){return this.fs.rename(this.getPath(e),this.getPath(t))}readFile=o(((e,t)=>this.fs.readFile(this.getPath(e),t)),"readFile");readdir=o(((e,t)=>this.fs.readdir(this.getPath(e||""),t)),"readdir");writeFile=o(((e,t,...i)=>this.fs.writeFile(this.getPath(e),t,...i)),"writeFile");async readJson(e){const t=await this.readFile(e,"utf8");return JSON.parse(t)}writeJson(e,t,i=2){return this.writeFile(e,JSON.stringify(t,null,i))}async[Symbol.asyncDispose](){await this.rm()}}const T=b.realpathSync(j.tmpdir());class m{static{o(this,"PathBase")}path;constructor(e){this.path=e}}class d extends m{static{o(this,"Directory")}}class p extends m{static{o(this,"File")}content;constructor(e,t){super(e),this.content=t}}class h extends m{static{o(this,"Symlink")}target;type;constructor(e,t,i){super(i??""),this.target=e,this.type=t}}const g=o((r,e,t)=>{const i=[];for(const n in r){if(!Object.hasOwn(r,n))continue;const f=c.join(e,n);let a=r[n];if(typeof a=="function"){const l=Object.assign(Object.create(t),{filePath:f}),u=a(l);if(u instanceof h){const s=new h(u.target,u.type,f);i.push(s);continue}else a=u}if(typeof a=="string"||Buffer.isBuffer(a))i.push(new p(f,a));else if(a&&typeof a=="object"&&!Array.isArray(a))i.push(new d(f),...g(a,f,t));else throw new TypeError(`Invalid file content for path "${f}". Functions must return a string, Buffer, Symlink, or a nested FileTree object. Received: ${String(a)}`)}return i},"flattenFileTree");let k=0;const q=o(async(r,e)=>{const t=e?.fs??y,i=e?.tempDir?c.resolve(typeof e.tempDir=="string"?e.tempDir:F.fileURLToPath(e.tempDir)):T;e?.tempDir&&await t.mkdir(i,{recursive:!0});let n;if(t.mkdtemp?n=await t.mkdtemp(c.join(i,"fs-fixture-")):(k+=1,n=c.join(i,`fs-fixture-${process.pid}-${k}`),await t.mkdir(n,{recursive:!0})),r){if(typeof r=="string"){if(!t.cp)throw new TypeError("Template directory sources require the fs API to support cp()");await t.cp(r,n,{recursive:!0,filter:e?.templateFilter})}else if(typeof r=="object"){const a=g(r,n,{fixturePath:n,getPath:o((...s)=>c.join(n,...s),"getPath"),symlink:o((s,P)=>new h(s,P),"symlink")}),l=new Set;for(const s of a)s instanceof d?l.add(s.path):(s instanceof p||s instanceof h)&&l.add(c.dirname(s.path));if(await Promise.all(Array.from(l).map(s=>t.mkdir(s,{recursive:!0}))),a.some(s=>s instanceof h)&&!t.symlink)throw new TypeError("Symlinks require the fs API to support symlink()");await Promise.all(a.map(async s=>{s instanceof h?await t.symlink(s.target,s.path,s.type):s instanceof p&&await t.writeFile(s.path,s.content)}))}}return new x(n,e?.fs)},"createFixture");exports.createFixture=q;

package/dist/index.d.cts

@@ -1,17 +1,69 @@
 import { CopyOptions } from 'node:fs';
 import fs from 'node:fs/promises';
 
+/**
+ * A subset of `fs/promises` methods used by FsFixture.
+ * Compatible with Node.js `fs/promises`, `@platformatic/vfs`,
+ * `memfs`, and other fs-compatible implementations.
+ *
+ * Pass a custom implementation to `createFixture({ fs })`
+ * to use a virtual filesystem.
+ */
+type FsPromises = {
+    readFile: {
+        (path: string, options?: {
+            encoding?: null;
+        } | null): Promise<Buffer>;
+        (path: string, options: BufferEncoding | {
+            encoding: BufferEncoding;
+        }): Promise<string>;
+    };
+    writeFile(path: string, data: string | Buffer, options?: BufferEncoding | {
+        encoding?: BufferEncoding;
+    } | null): Promise<void>;
+    readdir: {
+        (path: string, options?: {
+            withFileTypes?: false;
+        }): Promise<string[]>;
+        (path: string, options: {
+            withFileTypes: true;
+        }): Promise<Array<{
+            name: string;
+            isFile(): boolean;
+            isDirectory(): boolean;
+        }>>;
+    };
+    mkdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<string | undefined>;
+    rename(oldPath: string, newPath: string): Promise<void>;
+    access(path: string, mode?: number): Promise<void>;
+    rm?(path: string, options?: {
+        recursive?: boolean;
+        force?: boolean;
+    }): Promise<void>;
+    unlink?(path: string): Promise<void>;
+    rmdir?(path: string): Promise<void>;
+    symlink?(target: string, path: string, type?: string | null): Promise<void>;
+    cp?(source: string, destination: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    mkdtemp?(prefix: string): Promise<string>;
+};
+
 declare class FsFixture {
     /**
      * Path to the fixture directory.
      */
     readonly path: string;
+    readonly fs: FsPromises;
     /**
      * Create a Fixture instance from a path. Does not create the fixture directory.
      *
      * @param fixturePath - The path to the fixture directory
+     * @param fsApi - Optional fs/promises-compatible API. Defaults to real node:fs/promises.
      */
-    constructor(fixturePath: string);
+    constructor(fixturePath: string, fsApi?: FsPromises);
     /**
      * Get the full path to a subpath in the fixture directory.
      *
@@ -160,8 +212,8 @@ declare class PathBase {
 type SymlinkType = 'file' | 'dir' | 'junction';
 declare class Symlink extends PathBase {
     readonly target: string;
-    readonly type?: SymlinkType | undefined;
-    constructor(target: string, type?: SymlinkType | undefined, filePath?: string);
+    readonly type?: SymlinkType;
+    constructor(target: string, type?: SymlinkType, filePath?: string);
 }
 
 type ApiBase = {
@@ -196,6 +248,22 @@ type CreateFixtureOptions = {
      * Return `true` to copy the item, `false` to ignore it.
      */
     templateFilter?: FilterFunction;
+    /**
+     * Custom fs/promises-compatible API for fixture operations.
+     * Use this to create fixtures in a virtual filesystem instead of on disk.
+     *
+     * Required: readFile, writeFile, readdir (with withFileTypes),
+     * mkdir, rename, access.
+     * Optional: rm (or unlink + rmdir as fallback), symlink, cp, mkdtemp.
+     *
+     * @example
+     * ```ts
+     * import { create, MemoryProvider } from '@platformatic/vfs'
+     * const vfs = create(new MemoryProvider())
+     * const fixture = await createFixture({ 'file.txt': 'hi' }, { fs: vfs.promises })
+     * ```
+     */
+    fs?: FsPromises;
 };
 /**
  * Create a temporary test fixture directory.
@@ -229,4 +297,4 @@ type CreateFixtureOptions = {
 declare const createFixture: (source?: string | FileTree, options?: CreateFixtureOptions) => Promise<FsFixture>;
 
 export { createFixture };
-export type { CreateFixtureOptions, FileTree, FsFixtureType as FsFixture };
+export type { CreateFixtureOptions, FileTree, FsFixtureType as FsFixture, FsPromises };

package/dist/index.d.mts

@@ -1,17 +1,69 @@
 import { CopyOptions } from 'node:fs';
 import fs from 'node:fs/promises';
 
+/**
+ * A subset of `fs/promises` methods used by FsFixture.
+ * Compatible with Node.js `fs/promises`, `@platformatic/vfs`,
+ * `memfs`, and other fs-compatible implementations.
+ *
+ * Pass a custom implementation to `createFixture({ fs })`
+ * to use a virtual filesystem.
+ */
+type FsPromises = {
+    readFile: {
+        (path: string, options?: {
+            encoding?: null;
+        } | null): Promise<Buffer>;
+        (path: string, options: BufferEncoding | {
+            encoding: BufferEncoding;
+        }): Promise<string>;
+    };
+    writeFile(path: string, data: string | Buffer, options?: BufferEncoding | {
+        encoding?: BufferEncoding;
+    } | null): Promise<void>;
+    readdir: {
+        (path: string, options?: {
+            withFileTypes?: false;
+        }): Promise<string[]>;
+        (path: string, options: {
+            withFileTypes: true;
+        }): Promise<Array<{
+            name: string;
+            isFile(): boolean;
+            isDirectory(): boolean;
+        }>>;
+    };
+    mkdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<string | undefined>;
+    rename(oldPath: string, newPath: string): Promise<void>;
+    access(path: string, mode?: number): Promise<void>;
+    rm?(path: string, options?: {
+        recursive?: boolean;
+        force?: boolean;
+    }): Promise<void>;
+    unlink?(path: string): Promise<void>;
+    rmdir?(path: string): Promise<void>;
+    symlink?(target: string, path: string, type?: string | null): Promise<void>;
+    cp?(source: string, destination: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    mkdtemp?(prefix: string): Promise<string>;
+};
+
 declare class FsFixture {
     /**
      * Path to the fixture directory.
      */
     readonly path: string;
+    readonly fs: FsPromises;
     /**
      * Create a Fixture instance from a path. Does not create the fixture directory.
      *
      * @param fixturePath - The path to the fixture directory
+     * @param fsApi - Optional fs/promises-compatible API. Defaults to real node:fs/promises.
      */
-    constructor(fixturePath: string);
+    constructor(fixturePath: string, fsApi?: FsPromises);
     /**
      * Get the full path to a subpath in the fixture directory.
      *
@@ -160,8 +212,8 @@ declare class PathBase {
 type SymlinkType = 'file' | 'dir' | 'junction';
 declare class Symlink extends PathBase {
     readonly target: string;
-    readonly type?: SymlinkType | undefined;
-    constructor(target: string, type?: SymlinkType | undefined, filePath?: string);
+    readonly type?: SymlinkType;
+    constructor(target: string, type?: SymlinkType, filePath?: string);
 }
 
 type ApiBase = {
@@ -196,6 +248,22 @@ type CreateFixtureOptions = {
      * Return `true` to copy the item, `false` to ignore it.
      */
     templateFilter?: FilterFunction;
+    /**
+     * Custom fs/promises-compatible API for fixture operations.
+     * Use this to create fixtures in a virtual filesystem instead of on disk.
+     *
+     * Required: readFile, writeFile, readdir (with withFileTypes),
+     * mkdir, rename, access.
+     * Optional: rm (or unlink + rmdir as fallback), symlink, cp, mkdtemp.
+     *
+     * @example
+     * ```ts
+     * import { create, MemoryProvider } from '@platformatic/vfs'
+     * const vfs = create(new MemoryProvider())
+     * const fixture = await createFixture({ 'file.txt': 'hi' }, { fs: vfs.promises })
+     * ```
+     */
+    fs?: FsPromises;
 };
 /**
  * Create a temporary test fixture directory.
@@ -229,4 +297,4 @@ type CreateFixtureOptions = {
 declare const createFixture: (source?: string | FileTree, options?: CreateFixtureOptions) => Promise<FsFixture>;
 
 export { createFixture };
-export type { CreateFixtureOptions, FileTree, FsFixtureType as FsFixture };
+export type { CreateFixtureOptions, FileTree, FsFixtureType as FsFixture, FsPromises };

package/dist/index.mjs

@@ -1 +1 @@
-var g=Object.defineProperty;var o=(s,e)=>g(s,"name",{value:e,configurable:!0});import n from"node:fs/promises";import f from"node:path";import{fileURLToPath as P}from"node:url";import F from"node:fs";import b from"node:os";typeof Symbol.asyncDispose!="symbol"&&Object.defineProperty(Symbol,"asyncDispose",{configurable:!1,enumerable:!1,writable:!1,value:Symbol.for("asyncDispose")});class D{static{o(this,"FsFixture")}path;constructor(e){this.path=e}getPath(...e){return f.join(this.path,...e)}exists(e=""){return n.access(this.getPath(e)).then(()=>!0,()=>!1)}rm(e=""){return n.rm(this.getPath(e),{recursive:!0,force:!0})}cp(e,t,i){return t?t.endsWith(f.sep)&&(t+=f.basename(e)):t=f.basename(e),n.cp(e,this.getPath(t),i)}mkdir(e){return n.mkdir(this.getPath(e),{recursive:!0})}mv(e,t){return n.rename(this.getPath(e),this.getPath(t))}readFile=o(((e,t)=>n.readFile(this.getPath(e),t)),"readFile");readdir=o(((e,t)=>n.readdir(this.getPath(e||""),t)),"readdir");writeFile=o(((e,t,...i)=>n.writeFile(this.getPath(e),t,...i)),"writeFile");async readJson(e){const t=await this.readFile(e,"utf8");return JSON.parse(t)}writeJson(e,t,i=2){return this.writeFile(e,JSON.stringify(t,null,i))}async[Symbol.asyncDispose](){await this.rm()}}const j=F.realpathSync(b.tmpdir());class h{static{o(this,"PathBase")}constructor(e){this.path=e}}class y extends h{static{o(this,"Directory")}}class u extends h{static{o(this,"File")}constructor(e,t){super(e),this.content=t}}class m extends h{static{o(this,"Symlink")}constructor(e,t,i){super(i??""),this.target=e,this.type=t}}const d=o((s,e,t)=>{const i=[];for(const p in s){if(!Object.hasOwn(s,p))continue;const c=f.join(e,p);let a=s[p];if(typeof a=="function"){const r=Object.assign(Object.create(t),{filePath:c}),l=a(r);if(l instanceof m){const w=new m(l.target,l.type,c);i.push(w);continue}else a=l}if(typeof a=="string"||Buffer.isBuffer(a))i.push(new u(c,a));else if(a&&typeof a=="object"&&!Array.isArray(a))i.push(new y(c),...d(a,c,t));else throw new TypeError(`Invalid file content for path "${c}". Functions must return a string, Buffer, Symlink, or a nested FileTree object. Received: ${String(a)}`)}return i},"flattenFileTree"),v=o(async(s,e)=>{const t=e?.tempDir?f.resolve(typeof e.tempDir=="string"?e.tempDir:P(e.tempDir)):j;e?.tempDir&&await n.mkdir(t,{recursive:!0});const i=await n.mkdtemp(f.join(t,"fs-fixture-"));if(s){if(typeof s=="string")await n.cp(s,i,{recursive:!0,filter:e?.templateFilter});else if(typeof s=="object"){const c=d(s,i,{fixturePath:i,getPath:o((...r)=>f.join(i,...r),"getPath"),symlink:o((r,l)=>new m(r,l),"symlink")}),a=new Set;for(const r of c)r instanceof y?a.add(r.path):(r instanceof u||r instanceof m)&&a.add(f.dirname(r.path));await Promise.all(Array.from(a).map(r=>n.mkdir(r,{recursive:!0}))),await Promise.all(c.map(async r=>{r instanceof m?await n.symlink(r.target,r.path,r.type):r instanceof u&&await n.writeFile(r.path,r.content)}))}}return new D(i)},"createFixture");export{v as createFixture};
+var F=Object.defineProperty;var o=(r,t)=>F(r,"name",{value:t,configurable:!0});import y from"node:fs/promises";import c from"node:path";import{fileURLToPath as b}from"node:url";import j from"node:fs";import v from"node:os";const w=o(async(r,t)=>{try{await r.unlink(t);return}catch(i){if(D(i))return}const e=await r.readdir(t,{withFileTypes:!0});await Promise.all(e.map(i=>{const n=c.join(t,i.name);return i.isDirectory()?w(r,n):r.unlink(n)})),await r.rmdir(t)},"recursiveRm"),D=o(r=>r instanceof Error&&"code"in r&&r.code==="ENOENT","isEnoent");typeof Symbol.asyncDispose!="symbol"&&Object.defineProperty(Symbol,"asyncDispose",{configurable:!1,enumerable:!1,writable:!1,value:Symbol.for("asyncDispose")});class x{static{o(this,"FsFixture")}path;fs;constructor(t,e){this.path=t,this.fs=e??y}getPath(...t){return c.join(this.path,...t)}exists(t=""){return this.fs.access(this.getPath(t)).then(()=>!0,()=>!1)}rm(t=""){const e=this.getPath(t);if(this.fs.rm)return this.fs.rm(e,{recursive:!0,force:!0});if(!this.fs.unlink||!this.fs.rmdir)throw new Error("rm() requires the fs API to support rm(), or unlink() + rmdir()");return w(this.fs,e)}cp(t,e,i){if(!this.fs.cp)throw new Error("cp() requires the fs API to support cp()");return e?(e.endsWith("/")||e.endsWith(c.sep))&&(e+=c.basename(t)):e=c.basename(t),this.fs.cp(t,this.getPath(e),i)}mkdir(t){return this.fs.mkdir(this.getPath(t),{recursive:!0})}mv(t,e){return this.fs.rename(this.getPath(t),this.getPath(e))}readFile=o(((t,e)=>this.fs.readFile(this.getPath(t),e)),"readFile");readdir=o(((t,e)=>this.fs.readdir(this.getPath(t||""),e)),"readdir");writeFile=o(((t,e,...i)=>this.fs.writeFile(this.getPath(t),e,...i)),"writeFile");async readJson(t){const e=await this.readFile(t,"utf8");return JSON.parse(e)}writeJson(t,e,i=2){return this.writeFile(t,JSON.stringify(e,null,i))}async[Symbol.asyncDispose](){await this.rm()}}const T=j.realpathSync(v.tmpdir());class p{static{o(this,"PathBase")}path;constructor(t){this.path=t}}class d extends p{static{o(this,"Directory")}}class u extends p{static{o(this,"File")}content;constructor(t,e){super(t),this.content=e}}class h extends p{static{o(this,"Symlink")}target;type;constructor(t,e,i){super(i??""),this.target=t,this.type=e}}const g=o((r,t,e)=>{const i=[];for(const n in r){if(!Object.hasOwn(r,n))continue;const f=c.join(t,n);let a=r[n];if(typeof a=="function"){const l=Object.assign(Object.create(e),{filePath:f}),m=a(l);if(m instanceof h){const s=new h(m.target,m.type,f);i.push(s);continue}else a=m}if(typeof a=="string"||Buffer.isBuffer(a))i.push(new u(f,a));else if(a&&typeof a=="object"&&!Array.isArray(a))i.push(new d(f),...g(a,f,e));else throw new TypeError(`Invalid file content for path "${f}". Functions must return a string, Buffer, Symlink, or a nested FileTree object. Received: ${String(a)}`)}return i},"flattenFileTree");let k=0;const E=o(async(r,t)=>{const e=t?.fs??y,i=t?.tempDir?c.resolve(typeof t.tempDir=="string"?t.tempDir:b(t.tempDir)):T;t?.tempDir&&await e.mkdir(i,{recursive:!0});let n;if(e.mkdtemp?n=await e.mkdtemp(c.join(i,"fs-fixture-")):(k+=1,n=c.join(i,`fs-fixture-${process.pid}-${k}`),await e.mkdir(n,{recursive:!0})),r){if(typeof r=="string"){if(!e.cp)throw new TypeError("Template directory sources require the fs API to support cp()");await e.cp(r,n,{recursive:!0,filter:t?.templateFilter})}else if(typeof r=="object"){const a=g(r,n,{fixturePath:n,getPath:o((...s)=>c.join(n,...s),"getPath"),symlink:o((s,P)=>new h(s,P),"symlink")}),l=new Set;for(const s of a)s instanceof d?l.add(s.path):(s instanceof u||s instanceof h)&&l.add(c.dirname(s.path));if(await Promise.all(Array.from(l).map(s=>e.mkdir(s,{recursive:!0}))),a.some(s=>s instanceof h)&&!e.symlink)throw new TypeError("Symlinks require the fs API to support symlink()");await Promise.all(a.map(async s=>{s instanceof h?await e.symlink(s.target,s.path,s.type):s instanceof u&&await e.writeFile(s.path,s.content)}))}}return new x(n,t?.fs)},"createFixture");export{E as createFixture};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fs-fixture",
-  "version": "2.11.0",
+  "version": "2.13.0",
   "description": "Easily create test fixtures at a temporary file-system path",
   "keywords": [
     "test",
@@ -20,8 +20,10 @@
     "email": "hiroki.osame@gmail.com"
   },
   "files": [
-    "dist"
+    "dist",
+    "skills"
   ],
+  "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.cts",

package/skills/fs-fixture/SKILL.md

@@ -0,0 +1,95 @@
+---
+name: fs-fixture
+description: Create disposable file system test fixtures from objects, templates, or empty directories with automatic cleanup. Use when writing tests that need temporary files, directories, symlinks, or JSON fixtures on disk. Keywords - fs, tmp, temp, fixture, testing utility, cleanup, dispose.
+---
+
+## Quick Start
+
+```ts
+import { createFixture } from 'fs-fixture'
+
+// From object — keys are paths, values are content
+const fixture = await createFixture({
+    'package.json': JSON.stringify({ name: 'test' }),
+    'src/index.js': 'export default 42',
+})
+
+// Use fixture.path, fixture.readFile(), etc.
+await fixture.rm() // Cleanup when done
+```
+
+Auto-cleanup with `using` (TypeScript 5.2+):
+```ts
+await using fixture = await createFixture({ 'file.txt': 'content' })
+// Automatically cleaned up when scope exits
+```
+
+## createFixture(source?, options?)
+
+| Source | Behavior |
+|--------|----------|
+| `{ path: content }` | Create files from object. Nested objects create directories. |
+| `'./path'` | Copy template directory into fixture |
+| _(omitted)_ | Empty temporary directory |
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `tempDir` | `string \| URL` | `os.tmpdir()` | Custom parent directory |
+| `templateFilter` | `(src, dest) => boolean` | — | Filter files when copying template |
+
+## FsFixture Methods
+
+| Method | Description |
+|--------|-------------|
+| `fixture.path` | Absolute path to fixture root |
+| `getPath(...paths)` | Resolve path relative to fixture root |
+| `exists(path?)` | Check existence (returns `boolean`) |
+| `readFile(path, encoding?)` | Read file — `'utf8'` returns `string`, omit for `Buffer` |
+| `writeFile(path, content)` | Write string or Buffer |
+| `readJson<T>(path)` | Read and parse JSON with type parameter |
+| `writeJson(path, data, space?)` | Write JSON (default: 2-space indent, `0` for minified) |
+| `readdir(path, options?)` | List directory (`{ withFileTypes: true }` for Dirent[]) |
+| `mkdir(path)` | Create directory recursively |
+| `cp(source, dest?)` | Copy external file/directory into fixture |
+| `mv(source, dest)` | Move or rename within fixture |
+| `rm(path?)` | Delete path, or entire fixture if omitted |
+
+## FileTree Values
+
+| Type | Example |
+|------|---------|
+| `string` | `'file content'` |
+| `Buffer` | `Buffer.from([0x89, 0x50])` |
+| Nested object | `{ dir: { 'file.txt': 'content' } }` |
+| Function | `({ fixturePath, filePath, getPath, symlink }) => symlink('./target')` |
+
+Path syntax — these are equivalent:
+```ts
+// Nested objects
+{ src: { utils: { 'helper.js': 'code' } } }
+
+// Slash-separated keys
+{ 'src/utils/helper.js': 'code' }
+```
+
+## Patterns
+
+### Symlinks
+```ts
+const fixture = await createFixture({
+    'target.txt': 'real file',
+    'link.txt': ({ symlink }) => symlink('./target.txt'),
+    'node_modules/pkg': ({ symlink }) => symlink(process.cwd()),
+})
+```
+
+### Dynamic content
+```ts
+const fixture = await createFixture({
+    'info.txt': ({ fixturePath }) => `Root: ${fixturePath}`,
+})
+```
+
+## Related
+
+Commonly used with `manten` test framework.