fs-fixture 2.0.0 → 2.1.0

package/README.md

@@ -1,4 +1,11 @@
-# fs-fixture [![Latest version](https://badgen.net/npm/v/fs-fixture)](https://npm.im/fs-fixture) [![npm downloads](https://badgen.net/npm/dm/fs-fixture)](https://npm.im/fs-fixture)
+<p align="center">
+	<img width="160" src=".github/logo.webp">
+</p>
+<h1 align="center">
+	<sup>fs-fixture</sup>
+	<br>
+	<a href="https://npm.im/fs-fixture"><img src="https://badgen.net/npm/v/fs-fixture"></a> <a href="https://npm.im/fs-fixture"><img src="https://badgen.net/npm/dm/fs-fixture"></a>
+</h1>
 
 Simple API to create disposable test fixtures on disk.
 
@@ -36,7 +43,8 @@ const fixture = await createFixture({
     // Nested directory syntax
     'dir-a': {
         'dir-b': {
-            'file-a.txt': 'hello world'
+            'file-a.txt': 'hello world',
+            'file-b.txt': ({ fixturePath }) => `Fixture path: ${fixturePath}`
         }
     },
 
@@ -103,7 +111,7 @@ class FsFixture {
     /**
     Path to the fixture directory.
     */
-    path: string
+    readonly path: string
 
     /**
     Create a Fixture instance from a path. Does not create the fixture directory.
@@ -111,8 +119,8 @@ class FsFixture {
     constructor(fixturePath: string)
 
     /**
-	Get the full path to a subpath in the fixture directory.
-	*/
+    Get the full path to a subpath in the fixture directory.
+    */
     getPath(subpath: string): string
 
     /**

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";var i=require("fs/promises"),s=require("path"),u=require("fs"),l=require("os");typeof Symbol.asyncDispose!="symbol"&&Object.defineProperty(Symbol,"asyncDispose",{configurable:!1,enumerable:!1,writable:!1,value:Symbol.for("asyncDispose")});class h{path;constructor(t){this.path=t}getPath(t){return s.join(this.path,t)}exists(t=""){return i.access(this.getPath(t)).then(()=>!0,()=>!1)}rm(t=""){return i.rm(this.getPath(t),{recursive:!0,force:!0})}writeFile(t,e){return i.writeFile(this.getPath(t),e)}writeJson(t,e){return this.writeFile(t,JSON.stringify(e,null,2))}readFile(t,e){return i.readFile(this.getPath(t),e)}async[Symbol.asyncDispose](){await this.rm()}}const f=u.realpathSync(l.tmpdir()),p=`fs-fixture-${Date.now()}`;let o=0;const y=()=>(o+=1,o),c=(r,t)=>{const e=[];for(const a in r){if(!Object.hasOwn(r,a))continue;const n=r[a];typeof n=="string"?e.push({path:s.join(t,a),content:n}):e.push(...c(n,s.join(t,a)))}return e},m=async r=>{const t=s.join(f,`${p}-${y()}`);return await i.mkdir(t,{recursive:!0}),r&&(typeof r=="string"?await i.cp(r,t,{recursive:!0}):typeof r=="object"&&await Promise.all(c(r,t).map(async e=>{await i.mkdir(s.dirname(e.path),{recursive:!0}),await i.writeFile(e.path,e.content)}))),new h(t)};exports.createFixture=m;
+"use strict";var i=require("fs/promises"),a=require("path"),l=require("fs"),f=require("os");typeof Symbol.asyncDispose!="symbol"&&Object.defineProperty(Symbol,"asyncDispose",{configurable:!1,enumerable:!1,writable:!1,value:Symbol.for("asyncDispose")});class h{path;constructor(t){this.path=t}getPath(t){return a.join(this.path,t)}exists(t=""){return i.access(this.getPath(t)).then(()=>!0,()=>!1)}rm(t=""){return i.rm(this.getPath(t),{recursive:!0,force:!0})}writeFile(t,e){return i.writeFile(this.getPath(t),e)}writeJson(t,e){return this.writeFile(t,JSON.stringify(e,null,2))}readFile(t,e){return i.readFile(this.getPath(t),e)}async[Symbol.asyncDispose](){await this.rm()}}const p=l.realpathSync(f.tmpdir()),y=`fs-fixture-${Date.now()}`;let c=0;const m=()=>(c+=1,c),u=(r,t,e)=>{const o=[];for(const n in r){if(!Object.hasOwn(r,n))continue;let s=r[n];typeof s=="function"&&(s=s(e)),typeof s=="string"?o.push({path:a.join(t,n),content:s}):o.push(...u(s,a.join(t,n),e))}return o},w=async r=>{const t=a.join(p,`${y}-${m()}/`);return await i.mkdir(t,{recursive:!0}),r&&(typeof r=="string"?await i.cp(r,t,{recursive:!0}):typeof r=="object"&&await Promise.all(u(r,t,{fixturePath:t}).map(async e=>{await i.mkdir(a.dirname(e.path),{recursive:!0}),await i.writeFile(e.path,e.content)}))),new h(t)};exports.createFixture=w;

package/dist/index.d.cts

@@ -2,7 +2,7 @@ declare class FsFixture {
     /**
     Path to the fixture directory.
     */
-    path: string;
+    readonly path: string;
     /**
     Create a Fixture instance from a path. Does not create the fixture directory.
     */
@@ -30,7 +30,8 @@ declare class FsFixture {
     /**
     Read a file from the fixture directory.
     */
-    readFile(filePath: string, encoding?: BufferEncoding): Promise<string | Buffer>;
+    readFile(filePath: string, encoding?: null): Promise<Buffer>;
+    readFile(filePath: string, encoding: BufferEncoding): Promise<string>;
     /**
      * Resource management cleanup
      * https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-2.html
@@ -38,8 +39,11 @@ declare class FsFixture {
     [Symbol.asyncDispose](): Promise<void>;
 }
 
+type Api = {
+    fixturePath: string;
+};
 type FileTree = {
-    [path: string]: string | FileTree;
+    [path: string]: string | FileTree | ((api: Api) => string);
 };
 declare const createFixture: (source?: string | FileTree) => Promise<FsFixture>;
 

package/dist/index.d.mts

@@ -2,7 +2,7 @@ declare class FsFixture {
     /**
     Path to the fixture directory.
     */
-    path: string;
+    readonly path: string;
     /**
     Create a Fixture instance from a path. Does not create the fixture directory.
     */
@@ -30,7 +30,8 @@ declare class FsFixture {
     /**
     Read a file from the fixture directory.
     */
-    readFile(filePath: string, encoding?: BufferEncoding): Promise<string | Buffer>;
+    readFile(filePath: string, encoding?: null): Promise<Buffer>;
+    readFile(filePath: string, encoding: BufferEncoding): Promise<string>;
     /**
      * Resource management cleanup
      * https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-2.html
@@ -38,8 +39,11 @@ declare class FsFixture {
     [Symbol.asyncDispose](): Promise<void>;
 }
 
+type Api = {
+    fixturePath: string;
+};
 type FileTree = {
-    [path: string]: string | FileTree;
+    [path: string]: string | FileTree | ((api: Api) => string);
 };
 declare const createFixture: (source?: string | FileTree) => Promise<FsFixture>;
 

package/dist/index.mjs

@@ -1 +1 @@
-import i from"fs/promises";import s from"path";import l from"fs";import f from"os";typeof Symbol.asyncDispose!="symbol"&&Object.defineProperty(Symbol,"asyncDispose",{configurable:!1,enumerable:!1,writable:!1,value:Symbol.for("asyncDispose")});class p{path;constructor(t){this.path=t}getPath(t){return s.join(this.path,t)}exists(t=""){return i.access(this.getPath(t)).then(()=>!0,()=>!1)}rm(t=""){return i.rm(this.getPath(t),{recursive:!0,force:!0})}writeFile(t,e){return i.writeFile(this.getPath(t),e)}writeJson(t,e){return this.writeFile(t,JSON.stringify(e,null,2))}readFile(t,e){return i.readFile(this.getPath(t),e)}async[Symbol.asyncDispose](){await this.rm()}}const u=l.realpathSync(f.tmpdir()),h=`fs-fixture-${Date.now()}`;let o=0;const m=()=>(o+=1,o),c=(r,t)=>{const e=[];for(const a in r){if(!Object.hasOwn(r,a))continue;const n=r[a];typeof n=="string"?e.push({path:s.join(t,a),content:n}):e.push(...c(n,s.join(t,a)))}return e},y=async r=>{const t=s.join(u,`${h}-${m()}`);return await i.mkdir(t,{recursive:!0}),r&&(typeof r=="string"?await i.cp(r,t,{recursive:!0}):typeof r=="object"&&await Promise.all(c(r,t).map(async e=>{await i.mkdir(s.dirname(e.path),{recursive:!0}),await i.writeFile(e.path,e.content)}))),new p(t)};export{y as createFixture};
+import i from"fs/promises";import a from"path";import l from"fs";import p from"os";typeof Symbol.asyncDispose!="symbol"&&Object.defineProperty(Symbol,"asyncDispose",{configurable:!1,enumerable:!1,writable:!1,value:Symbol.for("asyncDispose")});class u{path;constructor(t){this.path=t}getPath(t){return a.join(this.path,t)}exists(t=""){return i.access(this.getPath(t)).then(()=>!0,()=>!1)}rm(t=""){return i.rm(this.getPath(t),{recursive:!0,force:!0})}writeFile(t,e){return i.writeFile(this.getPath(t),e)}writeJson(t,e){return this.writeFile(t,JSON.stringify(e,null,2))}readFile(t,e){return i.readFile(this.getPath(t),e)}async[Symbol.asyncDispose](){await this.rm()}}const h=l.realpathSync(p.tmpdir()),m=`fs-fixture-${Date.now()}`;let c=0;const y=()=>(c+=1,c),f=(r,t,e)=>{const o=[];for(const n in r){if(!Object.hasOwn(r,n))continue;let s=r[n];typeof s=="function"&&(s=s(e)),typeof s=="string"?o.push({path:a.join(t,n),content:s}):o.push(...f(s,a.join(t,n),e))}return o},w=async r=>{const t=a.join(h,`${m}-${y()}/`);return await i.mkdir(t,{recursive:!0}),r&&(typeof r=="string"?await i.cp(r,t,{recursive:!0}):typeof r=="object"&&await Promise.all(f(r,t,{fixturePath:t}).map(async e=>{await i.mkdir(a.dirname(e.path),{recursive:!0}),await i.writeFile(e.path,e.content)}))),new u(t)};export{w as createFixture};

package/package.json

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