fs-fixture 2.5.0 → 2.7.0

package/README.md

@@ -13,7 +13,7 @@ Tiny (`560 B` gzipped) and no dependencies!
 
 ### Example
 ```ts
-import fs from 'fs/promises'
+import fs from 'node:fs/promises'
 import { createFixture } from 'fs-fixture'
 
 const fixture = await createFixture({
@@ -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
 
@@ -148,6 +165,11 @@ class FsFixture {
     */
     rm(subpath?: string): Promise<void>
 
+    /**
+    Copy a path into the fixture directory.
+    */
+    cp(sourcePath: string, destinationSubpath?: string): Promise<void>
+
     /**
     Create a file in the fixture directory.
     */

package/dist/index.cjs

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

package/dist/index.d.cts

@@ -1,3 +1,5 @@
+import { CopyOptions } from 'node:fs';
+
 declare class FsFixture {
     /**
     Path to the fixture directory.
@@ -20,6 +22,10 @@ declare class FsFixture {
     */
     rm(subpath?: string): Promise<void>;
     /**
+    Copy a path into the fixture directory.
+    */
+    cp(sourcePath: string, destinationSubpath: string, options?: CopyOptions): Promise<void>;
+    /**
     Create a file in the fixture directory.
     */
     writeFile(filePath: string, content: string): Promise<void>;
@@ -40,6 +46,7 @@ declare class FsFixture {
 }
 type FsFixtureType = FsFixture;
 
+type FilterFunction = CopyOptions['filter'];
 type SymlinkType = 'file' | 'dir' | 'junction';
 declare class Symlink {
     target: string;
@@ -68,6 +75,11 @@ type CreateFixtureOptions = {
      * 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>;
 

package/dist/index.d.mts

@@ -1,3 +1,5 @@
+import { CopyOptions } from 'node:fs';
+
 declare class FsFixture {
     /**
     Path to the fixture directory.
@@ -20,6 +22,10 @@ declare class FsFixture {
     */
     rm(subpath?: string): Promise<void>;
     /**
+    Copy a path into the fixture directory.
+    */
+    cp(sourcePath: string, destinationSubpath: string, options?: CopyOptions): Promise<void>;
+    /**
     Create a file in the fixture directory.
     */
     writeFile(filePath: string, content: string): Promise<void>;
@@ -40,6 +46,7 @@ declare class FsFixture {
 }
 type FsFixtureType = FsFixture;
 
+type FilterFunction = CopyOptions['filter'];
 type SymlinkType = 'file' | 'dir' | 'junction';
 declare class Symlink {
     target: string;
@@ -68,6 +75,11 @@ type CreateFixtureOptions = {
      * 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>;
 

package/dist/index.mjs

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

package/package.json

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