@scalvert/bin-tester 0.1.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',
     });
 
@@ -69,31 +69,124 @@ describe('Some tests', () => {
 
 ## API
 
-```ts
-class BinTesterProject extends Project {
-    private _dirChanged;
-    constructor(name: string, version?: string, cb?: (project: Project) => void);
-    gitInit(): execa.ExecaChildProcess<string>;
-    chdir(): void;
-    dispose(): void;
-}
-
-interface BinTesterOptions {
-    binPath: string;
-    projectConstructor?: any;
-}
-
-interface RunOptions {
-    args?: string[];
-    execaOptions?: execa.Options<string>;
-}
-
-interface createBinTesterResult<TProject extends BinTesterProject> {
-    runBin: (runOptions?: RunOptions) => execa.ExecaChildProcess<string>;
-    setupProject: () => Promise<TProject>;
-    setupTmpDir: () => Promise<string>;
-    teardownProject: () => void;
-}
-
-function createBinTester<TProject extends BinTesterProject>(options: BinTesterOptions): createBinTesterResult<TProject>;
-```
+<!--DOCS_START-->
+## Classes
+
+<dl>
+<dt><a href="#BinTesterProject">BinTesterProject</a></dt>
+<dd></dd>
+</dl>
+
+## Functions
+
+<dl>
+<dt><a href="#createBinTester">createBinTester(options)</a> ⇒ <code>CreateBinTesterResult.&lt;TProject&gt;</code></dt>
+<dd><p>Creates the bin tester API functions to use within tests.</p></dd>
+</dl>
+
+<a name="BinTesterProject"></a>
+
+## BinTesterProject
+**Kind**: global class  
+
+* [BinTesterProject](#BinTesterProject)
+    * [new BinTesterProject(name, version, cb)](#new_BinTesterProject_new)
+    * [.gitInit()](#BinTesterProject+gitInit) ⇒ <code>\*</code>
+    * [.chdir()](#BinTesterProject+chdir)
+    * [.writeDirJSON(dirJSON)](#BinTesterProject+writeDirJSON) ⇒ <code>\*</code>
+    * [.dispose()](#BinTesterProject+dispose) ⇒ <code>void</code>
+
+<a name="new_BinTesterProject_new"></a>
+
+### new BinTesterProject(name, version, cb)
+<p>Constructs an instance of a BinTesterProject.</p>
+
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| name | <code>string</code> | <code>&quot;fake-project&quot;</code> | <p>The name of the project. Used within the package.json as the name property.</p> |
+| version | <code>string</code> |  | <p>The version of the project. Used within the package.json as the version property.</p> |
+| cb | <code>function</code> |  | <p>An optional callback for additional setup steps after the project is constructed.</p> |
+
+<a name="BinTesterProject+gitInit"></a>
+
+### binTesterProject.gitInit() ⇒ <code>\*</code>
+<p>Runs <code>git init</code> inside a project.</p>
+
+**Kind**: instance method of [<code>BinTesterProject</code>](#BinTesterProject)  
+**Returns**: <code>\*</code> - <p>{execa.ExecaChildProcess<string>}</p>  
+<a name="BinTesterProject+chdir"></a>
+
+### binTesterProject.chdir()
+<p>Changes a directory from inside the project.</p>
+
+**Kind**: instance method of [<code>BinTesterProject</code>](#BinTesterProject)  
+<a name="BinTesterProject+writeDirJSON"></a>
+
+### binTesterProject.writeDirJSON(dirJSON) ⇒ <code>\*</code>
+<p>Writes a directory struture in the project directory.</p>
+
+**Kind**: instance method of [<code>BinTesterProject</code>](#BinTesterProject)  
+**Returns**: <code>\*</code> - <p>{Promise<void>}</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| dirJSON | <code>fixturify.DirJSON</code> | <p>A JSON object representing the directory structure to create.</p> |
+
+<a name="BinTesterProject+dispose"></a>
+
+### binTesterProject.dispose() ⇒ <code>void</code>
+<p>Correctly disposes of the project, observing when the directory has been changed.</p>
+
+**Kind**: instance method of [<code>BinTesterProject</code>](#BinTesterProject)  
+<a name="createBinTester"></a>
+
+## createBinTester(options) ⇒ <code>CreateBinTesterResult.&lt;TProject&gt;</code>
+<p>Creates the bin tester API functions to use within tests.</p>
+
+**Kind**: global function  
+**Returns**: <code>CreateBinTesterResult.&lt;TProject&gt;</code> - <ul>
+<li>A project instance.</li>
+</ul>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| options | <code>BinTesterOptions.&lt;TProject&gt;</code> | <p>An object of bin tester options</p> |
+
+
+* [createBinTester(options)](#createBinTester) ⇒ <code>CreateBinTesterResult.&lt;TProject&gt;</code>
+    * [~runBin(...args)](#createBinTester..runBin) ⇒ <code>execa.ExecaChildProcess.&lt;string&gt;</code>
+    * [~setupProject()](#createBinTester..setupProject)
+    * [~setupTmpDir()](#createBinTester..setupTmpDir)
+    * [~teardownProject()](#createBinTester..teardownProject)
+
+<a name="createBinTester..runBin"></a>
+
+### createBinTester~runBin(...args) ⇒ <code>execa.ExecaChildProcess.&lt;string&gt;</code>
+**Kind**: inner method of [<code>createBinTester</code>](#createBinTester)  
+**Returns**: <code>execa.ExecaChildProcess.&lt;string&gt;</code> - <p>An instance of execa's child process.</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ...args | <code>RunBinArgs</code> | <p>Arguments or execa options.</p> |
+
+<a name="createBinTester..setupProject"></a>
+
+### createBinTester~setupProject()
+<p>Sets up the specified project for use within tests.</p>
+
+**Kind**: inner method of [<code>createBinTester</code>](#createBinTester)  
+<a name="createBinTester..setupTmpDir"></a>
+
+### createBinTester~setupTmpDir()
+<p>Sets up a tmp directory for use within tests.</p>
+
+**Kind**: inner method of [<code>createBinTester</code>](#createBinTester)  
+<a name="createBinTester..teardownProject"></a>
+
+### createBinTester~teardownProject()
+<p>Tears the project down, ensuring the tmp directory is removed. Shoud be paired with setupProject.</p>
+
+**Kind**: inner method of [<code>createBinTester</code>](#createBinTester)  
+
+<!--DOCS_END-->

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

@@ -9,7 +9,7 @@ declare class BinTesterProject extends Project {
      *
      * @param {string} name - The name of the project. Used within the package.json as the name property.
      * @param {string} version - The version of the project. Used within the package.json as the version property.
-     * @param {(project: Project) => void} cb - An optional callback for additional setup steps after the project is constructed.
+     * @param {Function} cb - An optional callback for additional setup steps after the project is constructed.
      */
     constructor(name?: string, version?: string, cb?: (project: Project) => void);
     /**
@@ -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 {
     /**
@@ -90,7 +90,6 @@ declare type RunBinArgs = [...binArgs: string[], execaOptions: execa.Options<str
 /**
  * Creates the bin tester API functions to use within tests.
  *
- * @typedef TProject - The type of BinTesterProject used.
  * @param {BinTesterOptions<TProject>} options - An object of bin tester options
  * @returns {CreateBinTesterResult<TProject>} - A project instance.
  */

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.1.0",
+  "version": "1.0.0",
   "description": "A test harness to invoke a CLI in a tmp directory",
   "keywords": [
     "cli",
@@ -28,7 +28,7 @@
   "types": "./dist/index.d.ts",
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --dts --clean",
-    "docs:generate": "npm run build && readme-api-generator dist/index.js",
+    "docs:generate": "readme-api-generator ./src --ts",
     "lint": "eslint .",
     "prepublishOnly": "npm run build",
     "test": "npm run lint && vitest run",
@@ -44,7 +44,12 @@
     "fixturify-project": "^4.1.0"
   },
   "devDependencies": {
-    "@scalvert/readme-api-generator": "^0.1.0",
+    "@babel/plugin-proposal-class-properties": "^7.16.7",
+    "@babel/plugin-proposal-object-rest-spread": "^7.17.3",
+    "@babel/plugin-transform-typescript": "^7.16.8",
+    "@babel/preset-env": "^7.16.11",
+    "@babel/preset-typescript": "^7.16.7",
+    "@scalvert/readme-api-generator": "^0.2.0",
     "@typescript-eslint/eslint-plugin": "^5.14.0",
     "@typescript-eslint/parser": "^5.14.0",
     "eslint": "^8.10.0",