fs-fixture 2.0.0 → 2.2.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.
 
@@ -35,8 +42,10 @@ import { createFixture } from 'fs-fixture'
 const fixture = await createFixture({
     // Nested directory syntax
     'dir-a': {
+        'file-a.txt': 'hello world',
         'dir-b': {
-            'file-a.txt': 'hello world'
+            'file-b.txt': ({ fixturePath }) => `Fixture path: ${fixturePath}`,
+            'symlink-c': ({ symlink }) => symlink('../file-a.txt')
         }
     },
 
@@ -92,7 +101,21 @@ Path to a template fixture path, or a `FileTree` object that represents the fixt
 
 ```ts
 type FileTree = {
-    [path: string]: string | FileTree
+    [path: string]: string | FileTree | ((api: Api) => string)
+}
+
+type Api = {
+    // Fixture root path
+    fixturePath: string
+
+    // Current file path
+    filePath: string
+
+    // Get path from the root of the fixture
+    getPath: (subpath: string) => string
+
+    // Create a symlink
+    symlink: (target: string) => Symlink
 }
 ```
 
@@ -103,7 +126,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 +134,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 s=require("fs/promises"),n=require("path"),y=require("fs"),m=require("os");typeof Symbol.asyncDispose!="symbol"&&Object.defineProperty(Symbol,"asyncDispose",{configurable:!1,enumerable:!1,writable:!1,value:Symbol.for("asyncDispose")});class w{path;constructor(t){this.path=t}getPath(t){return n.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 g=y.realpathSync(m.tmpdir()),b=`fs-fixture-${Date.now()}`;let l=0;const F=()=>(l+=1,l);class h{target;path;constructor(t){this.target=t}}const p=(r,t,i)=>{const e=[];for(const u in r){if(!Object.hasOwn(r,u))continue;const o=n.join(t,u);let a=r[u];if(typeof a=="function"){const f=Object.assign(Object.create(i),{filePath:o}),c=a(f);if(c instanceof h){c.path=o,e.push(c);continue}else a=c}typeof a=="string"?e.push({path:o,content:a}):e.push(...p(a,o,i))}return e},P=async r=>{const t=n.join(g,`${b}-${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:e=>n.join(t,e),symlink:e=>new h(e)};await Promise.all(p(r,t,i).map(async e=>{await s.mkdir(n.dirname(e.path),{recursive:!0}),e instanceof h?await s.symlink(e.target,e.path):await s.writeFile(e.path,e.content)}))}}return new w(t)};exports.createFixture=P;

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,21 @@ declare class FsFixture {
     [Symbol.asyncDispose](): Promise<void>;
 }
 
+declare class Symlink {
+    target: string;
+    path?: string;
+    constructor(target: string);
+}
+type ApiBase = {
+    fixturePath: string;
+    getPath(subpath: string): string;
+    symlink(targetPath: string): Symlink;
+};
+type Api = ApiBase & {
+    filePath: string;
+};
 type FileTree = {
-    [path: string]: string | FileTree;
+    [path: string]: string | FileTree | ((api: Api) => string | Symlink);
 };
 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,21 @@ declare class FsFixture {
     [Symbol.asyncDispose](): Promise<void>;
 }
 
+declare class Symlink {
+    target: string;
+    path?: string;
+    constructor(target: string);
+}
+type ApiBase = {
+    fixturePath: string;
+    getPath(subpath: string): string;
+    symlink(targetPath: string): Symlink;
+};
+type Api = ApiBase & {
+    filePath: string;
+};
 type FileTree = {
-    [path: string]: string | FileTree;
+    [path: string]: string | FileTree | ((api: Api) => string | Symlink);
 };
 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 s from"fs/promises";import n from"path";import m from"fs";import y from"os";typeof Symbol.asyncDispose!="symbol"&&Object.defineProperty(Symbol,"asyncDispose",{configurable:!1,enumerable:!1,writable:!1,value:Symbol.for("asyncDispose")});class w{path;constructor(t){this.path=t}getPath(t){return n.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 g=m.realpathSync(y.tmpdir()),b=`fs-fixture-${Date.now()}`;let l=0;const P=()=>(l+=1,l);class h{target;path;constructor(t){this.target=t}}const f=(r,t,i)=>{const e=[];for(const p in r){if(!Object.hasOwn(r,p))continue;const o=n.join(t,p);let a=r[p];if(typeof a=="function"){const u=Object.assign(Object.create(i),{filePath:o}),c=a(u);if(c instanceof h){c.path=o,e.push(c);continue}else a=c}typeof a=="string"?e.push({path:o,content:a}):e.push(...f(a,o,i))}return e},d=async r=>{const t=n.join(g,`${b}-${P()}/`);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:e=>n.join(t,e),symlink:e=>new h(e)};await Promise.all(f(r,t,i).map(async e=>{await s.mkdir(n.dirname(e.path),{recursive:!0}),e instanceof h?await s.symlink(e.target,e.path):await s.writeFile(e.path,e.content)}))}}return new w(t)};export{d as createFixture};

package/package.json

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