fs-fixture 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Hiroki Osame <hiroki.osame@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,121 @@
+# fs-fixture
+
+Easily create test fixtures at a temporary file-system path.
+
+<sub>Support this project by ⭐️ starring and sharing it. [Follow me](https://github.com/privatenumber) to see what other cool projects I'm working on! ❤️</sub>
+
+## Usage
+
+### JSON input
+
+Pass in an object representing the test fixture.
+
+```ts
+import { createFixture } from 'fs-fixture'
+
+test('my test using json fixture', async () => {
+    // Pass in a JSON representing the test fixture
+    const fixture = await createFixture({
+        // Nested directory syntax
+        directoryA: {
+            directoryB: {
+                fileNameA: 'fileContent'
+            }
+        },
+
+        // Directory path syntax - Same as above
+        'directoryA/directoryB/fileNameB': 'fileContent'
+    })
+
+    /*
+    Your test code here...
+
+    // Log fixture path
+    console.log(fixture.path)
+
+    // Check if relative path exists
+    console.log(await fixture.exists('./file'))
+    */
+
+    // Cleanup fixture
+    await fixture.rm()
+})
+```
+
+### Template path input
+
+Pass in a path to a test fixture template directory to make a copy of it.
+
+```ts
+test('my test using template path', async () => {
+    // Pass in a path to a fixture template path, and it will make a copy of it
+    const fixture = await createFixture('./fixtures/template-a')
+
+    /* Your test code here... */
+
+    // Cleanup fixture
+    await fixture.rm()
+})
+```
+
+## API
+
+### createFixture(source)
+
+An async function that creates a fixture from the `source` you pass in, and returns a `FsFixture` instance.
+
+#### source
+Type: `string | FileTree`
+
+Path to a template fixture path, or a `FileTree` object that represents the fixture content.
+
+
+### Types
+#### FileTree
+
+```ts
+type FileTree = {
+    [path: string]: string | FileTree
+}
+```
+
+#### FsFixture
+
+```ts
+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>
+}
+```

package/dist/index.d.ts

@@ -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>;
+}
+
+declare type FileTree = {
+    [path: string]: string | FileTree;
+};
+declare function createFixture(source: string | FileTree): Promise<FsFixture>;
+
+export { FileTree, FsFixture, createFixture };

package/dist/index.js

@@ -0,0 +1 @@
+"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;

package/dist/index.mjs

@@ -0,0 +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};

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "fs-fixture",
+  "version": "1.0.0",
+  "description": "Easily create test fixtures at a temporary file-system path",
+  "keywords": [
+    "test",
+    "fixture",
+    "temporary",
+    "file-system",
+    "disk",
+    "json",
+    "object",
+    "template"
+  ],
+  "license": "MIT",
+  "repository": "privatenumber/fs-fixture",
+  "funding": "https://github.com/privatenumber/fs-fixture?sponsor=1",
+  "author": {
+    "name": "Hiroki Osame",
+    "email": "hiroki.osame@gmail.com"
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "require": "./dist/index.js",
+    "import": "./dist/index.mjs",
+    "types": "./dist/index.d.ts"
+  },
+  "imports": {
+    "#fs-fixture": {
+      "types": "./src/index.ts",
+      "development": "./src/index.ts",
+      "default": "./dist/index.mjs"
+    }
+  }
+}