@scalvert/bin-tester 0.0.5 → 0.3.0

package/README.md

@@ -53,15 +53,14 @@ describe('Some tests', () => {
     expect(result.stdout).toBe('Did some stuff');
   });
 
-  // Write a file with contents to the tmp directory
   test('another test', () => {
-    project.write({
+    // Write a file with contents to the tmp directory
+    await project.writeJSON({
       'some/file.txt': 'some content',
     });
 
-    const result = await runBin({
-      args: ['--path', 'some/file.txt'], // pass some args to the bin that will be used for only this invocation
-    });
+    // pass some args to the bin that will be used for only this invocation
+    const result = await runBin('--path', 'some/file.txt');
 
     expect(result.stdout).toBe('Read "some/file.txt"');
   });
@@ -70,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)
+    * [.writeJSON(dirJSON)](#BinTesterProject+writeJSON) ⇒ <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+writeJSON"></a>
+
+### binTesterProject.writeJSON(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

@@ -53,6 +53,7 @@ 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) {
@@ -67,13 +68,14 @@ var BinTesterProject = class extends import_fixturify_project.Project {
   gitInit() {
     return (0, import_execa.default)(`git init -q ${this.baseDir}`);
   }
-  chdir() {
+  async chdir() {
     this._dirChanged = true;
+    await this.write();
     process.chdir(this.baseDir);
   }
   writeJSON(dirJSON) {
-    this.files = __spreadValues(__spreadValues({}, this.files), dirJSON);
-    return super.write();
+    this.files = (0, import_deepmerge.default)(this.files, dirJSON);
+    return this.write();
   }
   dispose() {
     if (this._dirChanged) {
@@ -88,22 +90,32 @@ var DEFAULT_BIN_TESTER_OPTIONS = {
   staticArgs: [],
   projectConstructor: BinTesterProject
 };
-var DEFAULT_RUN_OPTIONS = {
-  args: [],
-  execaOptions: {}
-};
+function parseArgs(args) {
+  if (args.length > 0 && typeof args[args.length - 1] === "object") {
+    const execaOptions = args.pop();
+    return {
+      args,
+      execaOptions
+    };
+  } else {
+    return {
+      args,
+      execaOptions: {}
+    };
+  }
+}
 function createBinTester(options) {
   let project;
   const mergedOptions = __spreadValues(__spreadValues({}, DEFAULT_BIN_TESTER_OPTIONS), options);
-  function runBin(runOptions = {}) {
-    const mergedRunOptions = __spreadValues(__spreadValues({}, DEFAULT_RUN_OPTIONS), runOptions);
+  function runBin(...args) {
+    const mergedRunOptions = parseArgs(args);
     return (0, import_execa2.default)(process.execPath, [mergedOptions.binPath, ...mergedOptions.staticArgs, ...mergedRunOptions.args], __spreadValues({
       reject: false,
       cwd: project.baseDir
     }, mergedRunOptions.execaOptions));
   }
   async function setupProject() {
-    project = new mergedOptions.projectConstructor();
+    project = "createProject" in mergedOptions ? await mergedOptions.createProject() : new BinTesterProject();
     await project.write();
     return project;
   }

package/dist/index.d.ts

@@ -1,14 +1,39 @@
 import execa from 'execa';
-import { Constructor } from 'type-fest';
 import fixturify from 'fixturify';
 import { Project } from 'fixturify-project';
 
 declare class BinTesterProject extends Project {
     private _dirChanged;
+    /**
+     * Constructs an instance of a BinTesterProject.
+     *
+     * @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 {Function} cb - An optional callback for additional setup steps after the project is constructed.
+     */
     constructor(name?: string, version?: string, cb?: (project: Project) => void);
+    /**
+     * Runs `git init` inside a project.
+     *
+     * @returns {*} {execa.ExecaChildProcess<string>}
+     */
     gitInit(): execa.ExecaChildProcess<string>;
-    chdir(): void;
+    /**
+     * 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.
+     *
+     * @returns {void}
+     */
     dispose(): void;
 }
 
@@ -22,31 +47,51 @@ interface BinTesterOptions<TProject> {
      */
     staticArgs?: string[];
     /**
-     * An optional class to use to create the project
+     * An optional function to use to create the project. Use this if you want to provide a custom implementation of a BinTesterProject.
      */
-    projectConstructor?: Constructor<TProject>;
+    createProject?: () => TProject;
 }
-interface RunOptions {
+interface RunBin {
     /**
-     * Arguments to provide to the bin script.
+     * A runBin implementation that takes no parameters.
+     *
+     * @returns {*}  {execa.ExecaChildProcess<string>}
+     * @memberof RunBin
      */
-    args?: string[];
+    (): execa.ExecaChildProcess<string>;
     /**
-     * Options to provide to execa. @see https://github.com/sindresorhus/execa#options
+     * A runBin implementation that takes varargs.
+     *
+     * @param {...RunBinArgs} args
+     * @returns {*}  {execa.ExecaChildProcess<string>}
+     * @memberof RunBin
      */
-    execaOptions?: execa.Options<string>;
+    (...args: RunBinArgs): execa.ExecaChildProcess<string>;
 }
 interface CreateBinTesterResult<TProject extends BinTesterProject> {
-    runBin: (runOptions?: RunOptions) => execa.ExecaChildProcess<string>;
+    /**
+     * Runs the configured bin function via execa.
+     */
+    runBin: RunBin;
+    /**
+     * Sets up the specified project for use within tests.
+     */
     setupProject: () => Promise<TProject>;
+    /**
+     * Sets up a tmp directory for use within tests.
+     */
     setupTmpDir: () => Promise<string>;
+    /**
+     * Tears the project down, ensuring the tmp directory is removed. Shoud be paired with setupProject.
+     */
     teardownProject: () => void;
 }
+declare type RunBinArgs = [...binArgs: string[], execaOptions: execa.Options<string>];
 /**
  * Creates the bin tester API functions to use within tests.
  *
- * @param options - An object of bin tester options
- * @returns - A project instance.
+ * @param {BinTesterOptions<TProject>} options - An object of bin tester options
+ * @returns {CreateBinTesterResult<TProject>} - A project instance.
  */
 declare function createBinTester<TProject extends BinTesterProject>(options: BinTesterOptions<TProject>): CreateBinTesterResult<TProject>;
 

package/dist/index.js

@@ -21,6 +21,7 @@ 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) {
@@ -35,13 +36,14 @@ var BinTesterProject = class extends Project {
   gitInit() {
     return execa(`git init -q ${this.baseDir}`);
   }
-  chdir() {
+  async chdir() {
     this._dirChanged = true;
+    await this.write();
     process.chdir(this.baseDir);
   }
   writeJSON(dirJSON) {
-    this.files = __spreadValues(__spreadValues({}, this.files), dirJSON);
-    return super.write();
+    this.files = deepmerge(this.files, dirJSON);
+    return this.write();
   }
   dispose() {
     if (this._dirChanged) {
@@ -56,22 +58,32 @@ var DEFAULT_BIN_TESTER_OPTIONS = {
   staticArgs: [],
   projectConstructor: BinTesterProject
 };
-var DEFAULT_RUN_OPTIONS = {
-  args: [],
-  execaOptions: {}
-};
+function parseArgs(args) {
+  if (args.length > 0 && typeof args[args.length - 1] === "object") {
+    const execaOptions = args.pop();
+    return {
+      args,
+      execaOptions
+    };
+  } else {
+    return {
+      args,
+      execaOptions: {}
+    };
+  }
+}
 function createBinTester(options) {
   let project;
   const mergedOptions = __spreadValues(__spreadValues({}, DEFAULT_BIN_TESTER_OPTIONS), options);
-  function runBin(runOptions = {}) {
-    const mergedRunOptions = __spreadValues(__spreadValues({}, DEFAULT_RUN_OPTIONS), runOptions);
+  function runBin(...args) {
+    const mergedRunOptions = parseArgs(args);
     return execa2(process.execPath, [mergedOptions.binPath, ...mergedOptions.staticArgs, ...mergedRunOptions.args], __spreadValues({
       reject: false,
       cwd: project.baseDir
     }, mergedRunOptions.execaOptions));
   }
   async function setupProject() {
-    project = new mergedOptions.projectConstructor();
+    project = "createProject" in mergedOptions ? await mergedOptions.createProject() : new BinTesterProject();
     await project.write();
     return project;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scalvert/bin-tester",
-  "version": "0.0.5",
+  "version": "0.3.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",
@@ -39,18 +39,24 @@
     "dist"
   ],
   "dependencies": {
+    "deepmerge": "^4.2.2",
     "execa": "^5.1.1",
     "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",
     "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-jsdoc": "^38.0.4",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-tsdoc": "^0.2.14",
     "eslint-plugin-unicorn": "^41.0.0",
     "fixturify": "^2.1.1",
     "prettier": "^2.5.1",