fs-fixture 2.2.0 → 2.4.0

package/README.md

@@ -112,7 +112,7 @@ type Api = {
     filePath: string
 
     // Get path from the root of the fixture
-    getPath: (subpath: string) => string
+    getPath: (...subpaths: string[]) => string
 
     // Create a symlink
     symlink: (target: string) => Symlink
@@ -136,7 +136,7 @@ class FsFixture {
     /**
     Get the full path to a subpath in the fixture directory.
     */
-    getPath(subpath: string): string
+    getPath(...subpaths: string[]): string
 
     /**
     Check if the fixture exists. Pass in a subpath to check if it exists.

package/dist/index.cjs

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

package/dist/index.d.cts

@@ -10,7 +10,7 @@ declare class FsFixture {
     /**
     Get the full path to a subpath in the fixture directory.
     */
-    getPath(subpath: string): string;
+    getPath(...subpaths: string[]): string;
     /**
     Check if the fixture exists. Pass in a subpath to check if it exists.
     */
@@ -39,15 +39,21 @@ declare class FsFixture {
     [Symbol.asyncDispose](): Promise<void>;
 }
 
+type SymlinkType = 'file' | 'dir' | 'junction';
 declare class Symlink {
     target: string;
+    type?: SymlinkType;
     path?: string;
-    constructor(target: string);
+    constructor(target: string, type?: SymlinkType);
 }
 type ApiBase = {
     fixturePath: string;
-    getPath(subpath: string): string;
-    symlink(targetPath: string): Symlink;
+    getPath(...subpaths: string[]): string;
+    symlink(targetPath: string, 
+    /**
+     * Symlink type for Windows. Defaults to auto-detect by Node.
+     */
+    type?: SymlinkType): Symlink;
 };
 type Api = ApiBase & {
     filePath: string;

package/dist/index.d.mts

@@ -10,7 +10,7 @@ declare class FsFixture {
     /**
     Get the full path to a subpath in the fixture directory.
     */
-    getPath(subpath: string): string;
+    getPath(...subpaths: string[]): string;
     /**
     Check if the fixture exists. Pass in a subpath to check if it exists.
     */
@@ -39,15 +39,21 @@ declare class FsFixture {
     [Symbol.asyncDispose](): Promise<void>;
 }
 
+type SymlinkType = 'file' | 'dir' | 'junction';
 declare class Symlink {
     target: string;
+    type?: SymlinkType;
     path?: string;
-    constructor(target: string);
+    constructor(target: string, type?: SymlinkType);
 }
 type ApiBase = {
     fixturePath: string;
-    getPath(subpath: string): string;
-    symlink(targetPath: string): Symlink;
+    getPath(...subpaths: string[]): string;
+    symlink(targetPath: string, 
+    /**
+     * Symlink type for Windows. Defaults to auto-detect by Node.
+     */
+    type?: SymlinkType): Symlink;
 };
 type Api = ApiBase & {
     filePath: string;

package/dist/index.mjs

@@ -1 +1 @@
-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};
+import s from"fs/promises";import o from"path";import y from"fs";import m 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 o.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,r){return s.writeFile(this.getPath(t),r)}writeJson(t,r){return this.writeFile(t,JSON.stringify(r,null,2))}readFile(t,r){return s.readFile(this.getPath(t),r)}async[Symbol.asyncDispose](){await this.rm()}}const g=y.realpathSync(m.tmpdir()),b=`fs-fixture-${Date.now()}`;let l=0;const P=()=>(l+=1,l);class h{target;type;path;constructor(t,r){this.target=t,this.type=r}}const u=(i,t,r)=>{const e=[];for(const n in i){if(!Object.hasOwn(i,n))continue;const c=o.join(t,n);let a=i[n];if(typeof a=="function"){const f=Object.assign(Object.create(r),{filePath:c}),p=a(f);if(p instanceof h){p.path=c,e.push(p);continue}else a=p}typeof a=="string"?e.push({path:c,content:a}):e.push(...u(a,c,r))}return e},d=async i=>{const t=o.join(g,`${b}-${P()}/`);if(await s.mkdir(t,{recursive:!0}),i){if(typeof i=="string")await s.cp(i,t,{recursive:!0});else if(typeof i=="object"){const r={fixturePath:t,getPath:(...e)=>o.join(t,...e),symlink:(e,n)=>new h(e,n)};await Promise.all(u(i,t,r).map(async e=>{await s.mkdir(o.dirname(e.path),{recursive:!0}),e instanceof h?await s.symlink(e.target,e.path,e.type):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.2.0",
+  "version": "2.4.0",
   "description": "Easily create test fixtures at a temporary file-system path",
   "keywords": [
     "test",