fs-fixture 1.0.0 → 1.2.0

package/README.md

@@ -119,3 +119,9 @@ class FsFixture {
     readFile(filePath: string, encoding?: BufferEncoding): Promise<string | Buffer>
 }
 ```
+
+## Related
+
+### [manten](https://github.com/privatenumber/manten)
+
+Lightweight testing library for Node.js

package/dist/index.cjs

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

package/dist/{index.d.ts → index.d.cts}

@@ -29,9 +29,9 @@ declare class FsFixture {
     readFile(filePath: string, encoding?: BufferEncoding): Promise<string | Buffer>;
 }
 
-declare type FileTree = {
+type FileTree = {
     [path: string]: string | FileTree;
 };
-declare function createFixture(source: string | FileTree): Promise<FsFixture>;
+declare function createFixture(source?: string | FileTree): Promise<FsFixture>;
 
 export { FileTree, FsFixture, createFixture };

package/dist/index.d.mts

@@ -0,0 +1,37 @@
+declare class FsFixture {
+    /**
+    Path to the fixture directory.
+    */
+    path: string;
+    /**
+    Create a Fixture instance from a path. Does not create the fixture directory.
+    */
+    constructor(fixturePath: string);
+    /**
+    Check if the fixture exists. Pass in a subpath to check if it exists.
+    */
+    exists(subpath?: string): Promise<boolean>;
+    /**
+    Delete the fixture directory. Pass in a subpath to delete it.
+    */
+    rm(subpath?: string): Promise<void>;
+    /**
+    Create a file in the fixture directory.
+    */
+    writeFile(filePath: string, content: string): Promise<void>;
+    /**
+    Create a JSON file in the fixture directory.
+    */
+    writeJson(filePath: string, json: any): Promise<void>;
+    /**
+    Read a file from the fixture directory.
+    */
+    readFile(filePath: string, encoding?: BufferEncoding): Promise<string | Buffer>;
+}
+
+type FileTree = {
+    [path: string]: string | FileTree;
+};
+declare function createFixture(source?: string | FileTree): Promise<FsFixture>;
+
+export { FileTree, FsFixture, createFixture };

package/dist/index.mjs

@@ -1 +1 @@
-import h,{promises as n}from"fs";import i from"path";import l from"os";class f{path;constructor(t){this.path=t}exists(t=""){return n.access(i.join(this.path,t)).then(()=>!0,()=>!1)}rm(t=""){return n.rm(i.join(this.path,t),{recursive:!0,force:!0})}writeFile(t,e){return n.writeFile(i.join(this.path,t),e)}writeJson(t,e){return this.writeFile(t,JSON.stringify(e,null,2))}readFile(t,e){return n.readFile(i.join(this.path,t),e)}}const a=i.join(h.realpathSync(l.tmpdir()),"test-fixtures",Date.now().toString());let u=0;function c(){return u+=1,u}const{hasOwnProperty:m}=Object.prototype,w=(r,t)=>m.call(r,t);function p(r,t){const e=[];for(const o in r){if(!w(r,o))continue;const s=r[o];typeof s=="string"?e.push({path:i.join(t,o),content:s}):e.push(...p(s,i.join(t,o)))}return e}async function j(r){let t;return typeof r=="string"?(t=i.join(a,`${i.basename(r)}-${c()}`),await n.mkdir(t,{recursive:!0}),await n.cp(r,t,{recursive:!0})):(t=i.join(a,`fixture-${c()}`),await Promise.all(p(r,t).map(async e=>{await n.mkdir(i.dirname(e.path),{recursive:!0}),await n.writeFile(e.path,e.content)}))),new f(t)}export{j as createFixture};
+import p,{promises as i}from"fs";import n from"path";import u from"os";class h{path;constructor(t){this.path=t}exists(t=""){return i.access(n.join(this.path,t)).then(()=>!0,()=>!1)}rm(t=""){return i.rm(n.join(this.path,t),{recursive:!0,force:!0})}writeFile(t,e){return i.writeFile(n.join(this.path,t),e)}writeJson(t,e){return this.writeFile(t,JSON.stringify(e,null,2))}readFile(t,e){return i.readFile(n.join(this.path,t),e)}}const f=p.realpathSync(u.tmpdir()),l=`fs-fixture-${Date.now()}`;let a=0;function m(){return a+=1,a}const{hasOwnProperty:w}=Object.prototype,y=(r,t)=>w.call(r,t);function c(r,t){const e=[];for(const o in r){if(!y(r,o))continue;const s=r[o];typeof s=="string"?e.push({path:n.join(t,o),content:s}):e.push(...c(s,n.join(t,o)))}return e}async function F(r){const t=n.join(f,`${l}-${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(n.dirname(e.path),{recursive:!0}),await i.writeFile(e.path,e.content)}))),new h(t)}export{F as createFixture};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fs-fixture",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Easily create test fixtures at a temporary file-system path",
   "keywords": [
     "test",
@@ -22,13 +22,18 @@
   "files": [
     "dist"
   ],
-  "main": "./dist/index.js",
+  "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
+  "types": "./dist/index.d.cts",
   "exports": {
-    "require": "./dist/index.js",
-    "import": "./dist/index.mjs",
-    "types": "./dist/index.d.ts"
+    "require": {
+      "types": "./dist/index.d.cts",
+      "default": "./dist/index.cjs"
+    },
+    "import": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    }
   },
   "imports": {
     "#fs-fixture": {
@@ -36,5 +41,8 @@
       "development": "./src/index.ts",
       "default": "./dist/index.mjs"
     }
+  },
+  "engines": {
+    "node": ">=16.7.0"
   }
 }

package/dist/index.js

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