@scalvert/bin-tester 0.2.0 → 2.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,111 @@ 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)
+    * [.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+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

@@ -18,27 +18,20 @@ var __spreadValues = (a, b) => {
     }
   return a;
 };
-var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
 };
-var __reExport = (target, module2, copyDefault, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && (copyDefault || key !== "default"))
-        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
   }
-  return target;
+  return to;
 };
-var __toESM = (module2, isNodeMode) => {
-  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", !isNodeMode && module2 && module2.__esModule ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
-};
-var __toCommonJS = /* @__PURE__ */ ((cache) => {
-  return (module2, temp) => {
-    return cache && cache.get(module2) || (temp = __reExport(__markAsModule({}), module2, 1), cache && cache.set(module2, temp), temp);
-  };
-})(typeof WeakMap !== "undefined" ? /* @__PURE__ */ new WeakMap() : 0);
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
 var src_exports = {};
@@ -46,6 +39,7 @@ __export(src_exports, {
   BinTesterProject: () => BinTesterProject,
   createBinTester: () => createBinTester
 });
+module.exports = __toCommonJS(src_exports);
 
 // src/create-bin-tester.ts
 var import_execa2 = __toESM(require("execa"), 1);
@@ -53,7 +47,6 @@ var import_execa2 = __toESM(require("execa"), 1);
 // src/project.ts
 var import_execa = __toESM(require("execa"), 1);
 var import_fixturify_project = require("fixturify-project");
-var import_deepmerge = __toESM(require("deepmerge"), 1);
 var ROOT = process.cwd();
 var BinTesterProject = class extends import_fixturify_project.Project {
   constructor(name = "fake-project", version, cb) {
@@ -73,10 +66,6 @@ var BinTesterProject = class extends import_fixturify_project.Project {
     await this.write();
     process.chdir(this.baseDir);
   }
-  writeJSON(dirJSON) {
-    this.files = (0, import_deepmerge.default)(this.files, dirJSON);
-    return this.write();
-  }
   dispose() {
     if (this._dirChanged) {
       process.chdir(ROOT);
@@ -87,8 +76,7 @@ var BinTesterProject = class extends import_fixturify_project.Project {
 
 // src/create-bin-tester.ts
 var DEFAULT_BIN_TESTER_OPTIONS = {
-  staticArgs: [],
-  projectConstructor: BinTesterProject
+  staticArgs: []
 };
 function parseArgs(args) {
   if (args.length > 0 && typeof args[args.length - 1] === "object") {
@@ -135,7 +123,6 @@ function createBinTester(options) {
     setupTmpDir
   };
 }
-module.exports = __toCommonJS(src_exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BinTesterProject,

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import execa from 'execa';
-import fixturify from 'fixturify';
 import { Project } from 'fixturify-project';
 
 declare class BinTesterProject extends Project {
@@ -9,7 +8,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);
     /**
@@ -22,13 +21,6 @@ declare class BinTesterProject extends Project {
      * Changes a directory from inside the project.
      */
     chdir(): Promise<void>;
-    /**
-     * Writes a directory struture in the project directory.
-     *
-     * @param {fixturify.DirJSON} dirJSON - A JSON object representing the directory structure to create.
-     * @returns {*} {Promise<void>}
-     */
-    writeJSON(dirJSON: fixturify.DirJSON): Promise<void>;
     /**
      * Correctly disposes of the project, observing when the directory has been changed.
      *
@@ -49,7 +41,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 +82,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

@@ -21,7 +21,6 @@ import execa2 from "execa";
 // src/project.ts
 import execa from "execa";
 import { Project } from "fixturify-project";
-import deepmerge from "deepmerge";
 var ROOT = process.cwd();
 var BinTesterProject = class extends Project {
   constructor(name = "fake-project", version, cb) {
@@ -41,10 +40,6 @@ var BinTesterProject = class extends Project {
     await this.write();
     process.chdir(this.baseDir);
   }
-  writeJSON(dirJSON) {
-    this.files = deepmerge(this.files, dirJSON);
-    return this.write();
-  }
   dispose() {
     if (this._dirChanged) {
       process.chdir(ROOT);
@@ -55,8 +50,7 @@ var BinTesterProject = class extends Project {
 
 // src/create-bin-tester.ts
 var DEFAULT_BIN_TESTER_OPTIONS = {
-  staticArgs: [],
-  projectConstructor: BinTesterProject
+  staticArgs: []
 };
 function parseArgs(args) {
   if (args.length > 0 && typeof args[args.length - 1] === "object") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scalvert/bin-tester",
-  "version": "0.2.0",
+  "version": "2.0.0",
   "description": "A test harness to invoke a CLI in a tmp directory",
   "keywords": [
     "cli",
@@ -28,10 +28,11 @@
   "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",
+    "test": "npm run lint && npm run test:vitest",
+    "test:vitest": "vitest run",
     "test:watch": "vitest",
     "watch": "npm run build -- --watch src"
   },
@@ -39,12 +40,16 @@
     "dist"
   ],
   "dependencies": {
-    "deepmerge": "^4.2.2",
     "execa": "^5.1.1",
-    "fixturify-project": "^4.1.0"
+    "fixturify-project": "^5.0.2"
   },
   "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.4",
     "@typescript-eslint/eslint-plugin": "^5.14.0",
     "@typescript-eslint/parser": "^5.14.0",
     "eslint": "^8.10.0",
@@ -61,7 +66,7 @@
     "type-fest": "^2.12.0",
     "typescript": "^4.6.2",
     "vite": "^2.8.6",
-    "vitest": "^0.6.0"
+    "vitest": "^0.9.3"
   },
   "engines": {
     "node": ">=14"