@scalvert/bin-tester 0.3.0 → 1.0.0

package/README.md

@@ -47,15 +47,15 @@ describe('Some tests', () => {
   });
 
   // Run the bin and do something with the result
-  test('a test', () => {
+  test('a test', async () => {
     const result = await runBin();
 
     expect(result.stdout).toBe('Did some stuff');
   });
 
-  test('another test', () => {
+  test('another test', async () => {
     // Write a file with contents to the tmp directory
-    await project.writeJSON({
+    await project.writeDirJSON({
       'some/file.txt': 'some content',
     });
 
@@ -93,7 +93,7 @@ describe('Some tests', () => {
     * [new BinTesterProject(name, version, cb)](#new_BinTesterProject_new)
     * [.gitInit()](#BinTesterProject+gitInit) ⇒ <code>\*</code>
     * [.chdir()](#BinTesterProject+chdir)
-    * [.writeJSON(dirJSON)](#BinTesterProject+writeJSON) ⇒ <code>\*</code>
+    * [.writeDirJSON(dirJSON)](#BinTesterProject+writeDirJSON) ⇒ <code>\*</code>
     * [.dispose()](#BinTesterProject+dispose) ⇒ <code>void</code>
 
 <a name="new_BinTesterProject_new"></a>
@@ -121,9 +121,9 @@ describe('Some tests', () => {
 <p>Changes a directory from inside the project.</p>
 
 **Kind**: instance method of [<code>BinTesterProject</code>](#BinTesterProject)  
-<a name="BinTesterProject+writeJSON"></a>
+<a name="BinTesterProject+writeDirJSON"></a>
 
-### binTesterProject.writeJSON(dirJSON) ⇒ <code>\*</code>
+### binTesterProject.writeDirJSON(dirJSON) ⇒ <code>\*</code>
 <p>Writes a directory struture in the project directory.</p>
 
 **Kind**: instance method of [<code>BinTesterProject</code>](#BinTesterProject)  

package/dist/index.cjs

@@ -73,7 +73,7 @@ var BinTesterProject = class extends import_fixturify_project.Project {
     await this.write();
     process.chdir(this.baseDir);
   }
-  writeJSON(dirJSON) {
+  writeDirJSON(dirJSON) {
     this.files = (0, import_deepmerge.default)(this.files, dirJSON);
     return this.write();
   }

package/dist/index.d.ts

@@ -28,7 +28,7 @@ declare class BinTesterProject extends Project {
      * @param {fixturify.DirJSON} dirJSON - A JSON object representing the directory structure to create.
      * @returns {*} {Promise<void>}
      */
-    writeJSON(dirJSON: fixturify.DirJSON): Promise<void>;
+    writeDirJSON(dirJSON: fixturify.DirJSON): Promise<void>;
     /**
      * Correctly disposes of the project, observing when the directory has been changed.
      *
@@ -49,7 +49,7 @@ interface BinTesterOptions<TProject> {
     /**
      * An optional function to use to create the project. Use this if you want to provide a custom implementation of a BinTesterProject.
      */
-    createProject?: () => TProject;
+    createProject?: () => Promise<TProject>;
 }
 interface RunBin {
     /**

package/dist/index.js

@@ -41,7 +41,7 @@ var BinTesterProject = class extends Project {
     await this.write();
     process.chdir(this.baseDir);
   }
-  writeJSON(dirJSON) {
+  writeDirJSON(dirJSON) {
     this.files = deepmerge(this.files, dirJSON);
     return this.write();
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scalvert/bin-tester",
-  "version": "0.3.0",
+  "version": "1.0.0",
   "description": "A test harness to invoke a CLI in a tmp directory",
   "keywords": [
     "cli",