fs-fixture 2.7.1 → 2.8.0

package/README.md

@@ -170,6 +170,11 @@ class FsFixture {
     */
     cp(sourcePath: string, destinationSubpath?: string): Promise<void>
 
+    /**
+    Create a new folder in the fixture directory.
+    */
+    mkdir(folderPath: string): Promise<void>
+
     /**
     Create a file in the fixture directory.
     */

package/dist/index.cjs

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

package/dist/index.d.cts

@@ -24,7 +24,11 @@ declare class FsFixture {
     /**
     Copy a path into the fixture directory.
     */
-    cp(sourcePath: string, destinationSubpath: string, options?: CopyOptions): Promise<void>;
+    cp(sourcePath: string, destinationSubpath?: string, options?: CopyOptions): Promise<void>;
+    /**
+    Create a new folder in the fixture directory.
+    */
+    mkdir(folderPath: string): Promise<string | undefined>;
     /**
     Create a file in the fixture directory.
     */
@@ -46,7 +50,6 @@ declare class FsFixture {
 }
 type FsFixtureType = FsFixture;
 
-type FilterFunction = CopyOptions['filter'];
 type SymlinkType = 'file' | 'dir' | 'junction';
 declare class Symlink {
     target: string;
@@ -59,8 +62,8 @@ type ApiBase = {
     getPath(...subpaths: string[]): string;
     symlink(targetPath: string, 
     /**
-     * Symlink type for Windows. Defaults to auto-detect by Node.
-     */
+         * Symlink type for Windows. Defaults to auto-detect by Node.
+         */
     type?: SymlinkType): Symlink;
 };
 type Api = ApiBase & {
@@ -69,6 +72,8 @@ type Api = ApiBase & {
 type FileTree = {
     [path: string]: string | FileTree | ((api: Api) => string | Symlink);
 };
+
+type FilterFunction = CopyOptions['filter'];
 type CreateFixtureOptions = {
     /**
      * The temporary directory to create the fixtures in.
@@ -83,4 +88,4 @@ type CreateFixtureOptions = {
 };
 declare const createFixture: (source?: string | FileTree, options?: CreateFixtureOptions) => Promise<FsFixture>;
 
-export { type CreateFixtureOptions, type FileTree, type FsFixtureType as FsFixture, createFixture };
+export { type CreateFixtureOptions, type FsFixtureType as FsFixture, createFixture };

package/dist/index.d.mts

@@ -24,7 +24,11 @@ declare class FsFixture {
     /**
     Copy a path into the fixture directory.
     */
-    cp(sourcePath: string, destinationSubpath: string, options?: CopyOptions): Promise<void>;
+    cp(sourcePath: string, destinationSubpath?: string, options?: CopyOptions): Promise<void>;
+    /**
+    Create a new folder in the fixture directory.
+    */
+    mkdir(folderPath: string): Promise<string | undefined>;
     /**
     Create a file in the fixture directory.
     */
@@ -46,7 +50,6 @@ declare class FsFixture {
 }
 type FsFixtureType = FsFixture;
 
-type FilterFunction = CopyOptions['filter'];
 type SymlinkType = 'file' | 'dir' | 'junction';
 declare class Symlink {
     target: string;
@@ -59,8 +62,8 @@ type ApiBase = {
     getPath(...subpaths: string[]): string;
     symlink(targetPath: string, 
     /**
-     * Symlink type for Windows. Defaults to auto-detect by Node.
-     */
+         * Symlink type for Windows. Defaults to auto-detect by Node.
+         */
     type?: SymlinkType): Symlink;
 };
 type Api = ApiBase & {
@@ -69,6 +72,8 @@ type Api = ApiBase & {
 type FileTree = {
     [path: string]: string | FileTree | ((api: Api) => string | Symlink);
 };
+
+type FilterFunction = CopyOptions['filter'];
 type CreateFixtureOptions = {
     /**
      * The temporary directory to create the fixtures in.
@@ -83,4 +88,4 @@ type CreateFixtureOptions = {
 };
 declare const createFixture: (source?: string | FileTree, options?: CreateFixtureOptions) => Promise<FsFixture>;
 
-export { type CreateFixtureOptions, type FileTree, type FsFixtureType as FsFixture, createFixture };
+export { type CreateFixtureOptions, type FsFixtureType as FsFixture, createFixture };

package/dist/index.mjs

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

package/package.json

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