fs-fixture 2.4.1 → 2.6.0

package/README.md

@@ -86,7 +86,7 @@ await using fixture = await createFixture({ file: 'hello' })
 
 ## API
 
-### createFixture(source)
+### createFixture(source, options)
 
 An async function that creates a fixture from the `source` you pass in, and returns a `FsFixture` instance.
 
@@ -96,6 +96,23 @@ Type: `string | FileTree`
 Path to a template fixture path, or a `FileTree` object that represents the fixture content.
 
 
+#### options
+
+##### tempDir
+
+Type: `string`
+
+Default: `os.tmpdir()`
+
+The directory where the fixture will be created.
+
+
+##### templateFilter
+
+Type: `(source: string, destination: string) => boolean | Promise<boolean>`
+
+Function to filter files to copy when using a template path. Return `true` to copy the item, `false` to ignore it.
+
 ### Types
 #### FileTree
 

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";var m=Object.defineProperty;var a=(r,t)=>m(r,"name",{value:t,configurable:!0});var s=require("fs/promises"),c=require("path"),w=require("fs"),g=require("os");typeof Symbol.asyncDispose!="symbol"&&Object.defineProperty(Symbol,"asyncDispose",{configurable:!1,enumerable:!1,writable:!1,value:Symbol.for("asyncDispose")});class b{static{a(this,"FsFixture")}path;constructor(t){this.path=t}getPath(...t){return c.join(this.path,...t)}exists(t=""){return s.access(this.getPath(t)).then(()=>!0,()=>!1)}rm(t=""){return s.rm(this.getPath(t),{recursive:!0,force:!0})}writeFile(t,i){return s.writeFile(this.getPath(t),i)}writeJson(t,i){return this.writeFile(t,JSON.stringify(i,null,2))}readFile(t,i){return s.readFile(this.getPath(t),i)}async[Symbol.asyncDispose](){await this.rm()}}const F=w.realpathSync(g.tmpdir()),P=`fs-fixture-${Date.now()}`;let p=0;const d=a(()=>(p+=1,p),"getId");class l{static{a(this,"Symlink")}target;type;path;constructor(t,i){this.target=t,this.type=i}}const y=a((r,t,i)=>{const e=[];for(const o in r){if(!Object.hasOwn(r,o))continue;const u=c.join(t,o);let n=r[o];if(typeof n=="function"){const f=Object.assign(Object.create(i),{filePath:u}),h=n(f);if(h instanceof l){h.path=u,e.push(h);continue}else n=h}typeof n=="string"?e.push({path:u,content:n}):e.push(...y(n,u,i))}return e},"flattenFileTree"),j=a(async r=>{const t=c.join(F,`${P}-${d()}/`);if(await s.mkdir(t,{recursive:!0}),r){if(typeof r=="string")await s.cp(r,t,{recursive:!0});else if(typeof r=="object"){const i={fixturePath:t,getPath:a((...e)=>c.join(t,...e),"getPath"),symlink:a((e,o)=>new l(e,o),"symlink")};await Promise.all(y(r,t,i).map(async e=>{await s.mkdir(c.dirname(e.path),{recursive:!0}),e instanceof l?await s.symlink(e.target,e.path,e.type):await s.writeFile(e.path,e.content)}))}}return new b(t)},"createFixture");exports.createFixture=j;
+"use strict";var w=Object.defineProperty;var n=(r,t)=>w(r,"name",{value:t,configurable:!0});var c=require("node:fs/promises"),u=require("node:path"),h=require("fs/promises"),g=require("path"),b=require("fs"),v=require("os");typeof Symbol.asyncDispose!="symbol"&&Object.defineProperty(Symbol,"asyncDispose",{configurable:!1,enumerable:!1,writable:!1,value:Symbol.for("asyncDispose")});class F{static{n(this,"FsFixture")}path;constructor(t){this.path=t}getPath(...t){return g.join(this.path,...t)}exists(t=""){return h.access(this.getPath(t)).then(()=>!0,()=>!1)}rm(t=""){return h.rm(this.getPath(t),{recursive:!0,force:!0})}writeFile(t,i){return h.writeFile(this.getPath(t),i)}writeJson(t,i){return this.writeFile(t,JSON.stringify(i,null,2))}readFile(t,i){return h.readFile(this.getPath(t),i)}async[Symbol.asyncDispose](){await this.rm()}}const d=b.realpathSync(v.tmpdir()),P=`fs-fixture-${Date.now()}`;let y=0;const j=n(()=>(y+=1,y),"getId");class p{static{n(this,"Symlink")}target;type;path;constructor(t,i){this.target=t,this.type=i}}const f=n((r,t,i)=>{const s=[];for(const o in r){if(!Object.hasOwn(r,o))continue;const e=u.join(t,o);let a=r[o];if(typeof a=="function"){const m=Object.assign(Object.create(i),{filePath:e}),l=a(m);if(l instanceof p){l.path=e,s.push(l);continue}else a=l}typeof a=="string"?s.push({path:e,content:a}):s.push(...f(a,e,i))}return s},"flattenFileTree"),D=n(async(r,t)=>{const i=t?.tempDir?u.resolve(t.tempDir):d,s=u.join(i,`${P}-${j()}/`);if(await c.mkdir(s,{recursive:!0}),r){if(typeof r=="string")await c.cp(r,s,{recursive:!0,filter:t?.templateFilter});else if(typeof r=="object"){const o={fixturePath:s,getPath:n((...e)=>u.join(s,...e),"getPath"),symlink:n((e,a)=>new p(e,a),"symlink")};await Promise.all(f(r,s,o).map(async e=>{await c.mkdir(u.dirname(e.path),{recursive:!0}),e instanceof p?await c.symlink(e.target,e.path,e.type):await c.writeFile(e.path,e.content)}))}}return new F(s)},"createFixture");exports.createFixture=D;

package/dist/index.d.cts

@@ -1,3 +1,5 @@
+import { CopyOptions } from 'node:fs';
+
 declare class FsFixture {
     /**
     Path to the fixture directory.
@@ -40,6 +42,7 @@ declare class FsFixture {
 }
 type FsFixtureType = FsFixture;
 
+type FilterFunction = CopyOptions['filter'];
 type SymlinkType = 'file' | 'dir' | 'junction';
 declare class Symlink {
     target: string;
@@ -62,6 +65,18 @@ type Api = ApiBase & {
 type FileTree = {
     [path: string]: string | FileTree | ((api: Api) => string | Symlink);
 };
-declare const createFixture: (source?: string | FileTree) => Promise<FsFixture>;
+type CreateFixtureOptions = {
+    /**
+     * The temporary directory to create the fixtures in.
+     * Defaults to `os.tmpdir()`.
+     */
+    tempDir?: string;
+    /**
+     * Function to filter files to copy when using a template path.
+     * Return `true` to copy the item, `false` to ignore it.
+     */
+    templateFilter?: FilterFunction;
+};
+declare const createFixture: (source?: string | FileTree, options?: CreateFixtureOptions) => Promise<FsFixture>;
 
-export { type FileTree, type FsFixtureType as FsFixture, createFixture };
+export { type CreateFixtureOptions, type FileTree, type FsFixtureType as FsFixture, createFixture };

package/dist/index.d.mts

@@ -1,3 +1,5 @@
+import { CopyOptions } from 'node:fs';
+
 declare class FsFixture {
     /**
     Path to the fixture directory.
@@ -40,6 +42,7 @@ declare class FsFixture {
 }
 type FsFixtureType = FsFixture;
 
+type FilterFunction = CopyOptions['filter'];
 type SymlinkType = 'file' | 'dir' | 'junction';
 declare class Symlink {
     target: string;
@@ -62,6 +65,18 @@ type Api = ApiBase & {
 type FileTree = {
     [path: string]: string | FileTree | ((api: Api) => string | Symlink);
 };
-declare const createFixture: (source?: string | FileTree) => Promise<FsFixture>;
+type CreateFixtureOptions = {
+    /**
+     * The temporary directory to create the fixtures in.
+     * Defaults to `os.tmpdir()`.
+     */
+    tempDir?: string;
+    /**
+     * Function to filter files to copy when using a template path.
+     * Return `true` to copy the item, `false` to ignore it.
+     */
+    templateFilter?: FilterFunction;
+};
+declare const createFixture: (source?: string | FileTree, options?: CreateFixtureOptions) => Promise<FsFixture>;
 
-export { type FileTree, type FsFixtureType as FsFixture, createFixture };
+export { type CreateFixtureOptions, type FileTree, type FsFixtureType as FsFixture, createFixture };

package/dist/index.mjs

@@ -1 +1 @@
-var m=Object.defineProperty;var a=(r,t)=>m(r,"name",{value:t,configurable:!0});import s from"fs/promises";import c from"path";import w from"fs";import g from"os";typeof Symbol.asyncDispose!="symbol"&&Object.defineProperty(Symbol,"asyncDispose",{configurable:!1,enumerable:!1,writable:!1,value:Symbol.for("asyncDispose")});class b{static{a(this,"FsFixture")}path;constructor(t){this.path=t}getPath(...t){return c.join(this.path,...t)}exists(t=""){return s.access(this.getPath(t)).then(()=>!0,()=>!1)}rm(t=""){return s.rm(this.getPath(t),{recursive:!0,force:!0})}writeFile(t,i){return s.writeFile(this.getPath(t),i)}writeJson(t,i){return this.writeFile(t,JSON.stringify(i,null,2))}readFile(t,i){return s.readFile(this.getPath(t),i)}async[Symbol.asyncDispose](){await this.rm()}}const P=w.realpathSync(g.tmpdir()),d=`fs-fixture-${Date.now()}`;let u=0;const F=a(()=>(u+=1,u),"getId");class l{static{a(this,"Symlink")}target;type;path;constructor(t,i){this.target=t,this.type=i}}const f=a((r,t,i)=>{const e=[];for(const o in r){if(!Object.hasOwn(r,o))continue;const p=c.join(t,o);let n=r[o];if(typeof n=="function"){const y=Object.assign(Object.create(i),{filePath:p}),h=n(y);if(h instanceof l){h.path=p,e.push(h);continue}else n=h}typeof n=="string"?e.push({path:p,content:n}):e.push(...f(n,p,i))}return e},"flattenFileTree"),j=a(async r=>{const t=c.join(P,`${d}-${F()}/`);if(await s.mkdir(t,{recursive:!0}),r){if(typeof r=="string")await s.cp(r,t,{recursive:!0});else if(typeof r=="object"){const i={fixturePath:t,getPath:a((...e)=>c.join(t,...e),"getPath"),symlink:a((e,o)=>new l(e,o),"symlink")};await Promise.all(f(r,t,i).map(async e=>{await s.mkdir(c.dirname(e.path),{recursive:!0}),e instanceof l?await s.symlink(e.target,e.path,e.type):await s.writeFile(e.path,e.content)}))}}return new b(t)},"createFixture");export{j as createFixture};
+var w=Object.defineProperty;var n=(r,t)=>w(r,"name",{value:t,configurable:!0});import c from"node:fs/promises";import p from"node:path";import f from"fs/promises";import g from"path";import b from"fs";import d from"os";typeof Symbol.asyncDispose!="symbol"&&Object.defineProperty(Symbol,"asyncDispose",{configurable:!1,enumerable:!1,writable:!1,value:Symbol.for("asyncDispose")});class F{static{n(this,"FsFixture")}path;constructor(t){this.path=t}getPath(...t){return g.join(this.path,...t)}exists(t=""){return f.access(this.getPath(t)).then(()=>!0,()=>!1)}rm(t=""){return f.rm(this.getPath(t),{recursive:!0,force:!0})}writeFile(t,i){return f.writeFile(this.getPath(t),i)}writeJson(t,i){return this.writeFile(t,JSON.stringify(i,null,2))}readFile(t,i){return f.readFile(this.getPath(t),i)}async[Symbol.asyncDispose](){await this.rm()}}const P=b.realpathSync(d.tmpdir()),j=`fs-fixture-${Date.now()}`;let m=0;const D=n(()=>(m+=1,m),"getId");class h{static{n(this,"Symlink")}target;type;path;constructor(t,i){this.target=t,this.type=i}}const u=n((r,t,i)=>{const s=[];for(const o in r){if(!Object.hasOwn(r,o))continue;const e=p.join(t,o);let a=r[o];if(typeof a=="function"){const y=Object.assign(Object.create(i),{filePath:e}),l=a(y);if(l instanceof h){l.path=e,s.push(l);continue}else a=l}typeof a=="string"?s.push({path:e,content:a}):s.push(...u(a,e,i))}return s},"flattenFileTree"),v=n(async(r,t)=>{const i=t?.tempDir?p.resolve(t.tempDir):P,s=p.join(i,`${j}-${D()}/`);if(await c.mkdir(s,{recursive:!0}),r){if(typeof r=="string")await c.cp(r,s,{recursive:!0,filter:t?.templateFilter});else if(typeof r=="object"){const o={fixturePath:s,getPath:n((...e)=>p.join(s,...e),"getPath"),symlink:n((e,a)=>new h(e,a),"symlink")};await Promise.all(u(r,s,o).map(async e=>{await c.mkdir(p.dirname(e.path),{recursive:!0}),e instanceof h?await c.symlink(e.target,e.path,e.type):await c.writeFile(e.path,e.content)}))}}return new F(s)},"createFixture");export{v as createFixture};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fs-fixture",
-  "version": "2.4.1",
+  "version": "2.6.0",
   "description": "Easily create test fixtures at a temporary file-system path",
   "keywords": [
     "test",