@scalvert/bin-tester 1.0.0 → 2.1.1

package/README.md

@@ -93,7 +93,6 @@ describe('Some tests', () => {
     * [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>
@@ -121,18 +120,6 @@ describe('Some tests', () => {
 <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>

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);
   }
-  writeDirJSON(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") {
@@ -109,7 +97,8 @@ function createBinTester(options) {
   const mergedOptions = __spreadValues(__spreadValues({}, DEFAULT_BIN_TESTER_OPTIONS), options);
   function runBin(...args) {
     const mergedRunOptions = parseArgs(args);
-    return (0, import_execa2.default)(process.execPath, [mergedOptions.binPath, ...mergedOptions.staticArgs, ...mergedRunOptions.args], __spreadValues({
+    const binPath = typeof mergedOptions.binPath === "function" ? mergedOptions.binPath(project) : mergedOptions.binPath;
+    return (0, import_execa2.default)(process.execPath, [binPath, ...mergedOptions.staticArgs, ...mergedRunOptions.args], __spreadValues({
       reject: false,
       cwd: project.baseDir
     }, mergedRunOptions.execaOptions));
@@ -135,7 +124,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 {
@@ -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>}
-     */
-    writeDirJSON(dirJSON: fixturify.DirJSON): Promise<void>;
     /**
      * Correctly disposes of the project, observing when the directory has been changed.
      *
@@ -41,7 +33,7 @@ interface BinTesterOptions<TProject> {
     /**
      * The absolute path to the bin to invoke
      */
-    binPath: string;
+    binPath: string | (<TProject extends BinTesterProject>(project: TProject) => string);
     /**
      * An array of static arguments that will be used every time when running the bin
      */
@@ -60,13 +52,29 @@ interface RunBin {
      */
     (): execa.ExecaChildProcess<string>;
     /**
-     * A runBin implementation that takes varargs.
+     * A runBin implementation that takes string varargs.
+     *
+     * @param {...RunBinArgs} args
+     * @returns {*}  {execa.ExecaChildProcess<string>}
+     * @memberof RunBin
+     */
+    (...args: [...binArgs: string[]]): execa.ExecaChildProcess<string>;
+    /**
+     * A runBin implementation that takes an execa.Options<string> object.
+     *
+     * @param {...RunBinArgs} args
+     * @returns {*}  {execa.ExecaChildProcess<string>}
+     * @memberof RunBin
+     */
+    (...args: [execaOptions: execa.Options<string>]): execa.ExecaChildProcess<string>;
+    /**
+     * A runBin implementation that takes string or an execa.Options<string> object varargs.
      *
      * @param {...RunBinArgs} args
      * @returns {*}  {execa.ExecaChildProcess<string>}
      * @memberof RunBin
      */
-    (...args: RunBinArgs): execa.ExecaChildProcess<string>;
+    (...args: [...binArgs: string[], execaOptions: execa.Options<string>]): execa.ExecaChildProcess<string>;
 }
 interface CreateBinTesterResult<TProject extends BinTesterProject> {
     /**
@@ -86,7 +94,6 @@ interface CreateBinTesterResult<TProject extends BinTesterProject> {
      */
     teardownProject: () => void;
 }
-declare type RunBinArgs = [...binArgs: string[], execaOptions: execa.Options<string>];
 /**
  * Creates the bin tester API functions to use within tests.
  *

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);
   }
-  writeDirJSON(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") {
@@ -77,7 +71,8 @@ function createBinTester(options) {
   const mergedOptions = __spreadValues(__spreadValues({}, DEFAULT_BIN_TESTER_OPTIONS), options);
   function runBin(...args) {
     const mergedRunOptions = parseArgs(args);
-    return execa2(process.execPath, [mergedOptions.binPath, ...mergedOptions.staticArgs, ...mergedRunOptions.args], __spreadValues({
+    const binPath = typeof mergedOptions.binPath === "function" ? mergedOptions.binPath(project) : mergedOptions.binPath;
+    return execa2(process.execPath, [binPath, ...mergedOptions.staticArgs, ...mergedRunOptions.args], __spreadValues({
       reject: false,
       cwd: project.baseDir
     }, mergedRunOptions.execaOptions));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scalvert/bin-tester",
-  "version": "1.0.0",
+  "version": "2.1.1",
   "description": "A test harness to invoke a CLI in a tmp directory",
   "keywords": [
     "cli",
@@ -31,7 +31,8 @@
     "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,9 +40,8 @@
     "dist"
   ],
   "dependencies": {
-    "deepmerge": "^4.2.2",
     "execa": "^5.1.1",
-    "fixturify-project": "^4.1.0"
+    "fixturify-project": "^5.0.2"
   },
   "devDependencies": {
     "@babel/plugin-proposal-class-properties": "^7.16.7",
@@ -49,7 +49,7 @@
     "@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",
+    "@scalvert/readme-api-generator": "^0.2.4",
     "@typescript-eslint/eslint-plugin": "^5.14.0",
     "@typescript-eslint/parser": "^5.14.0",
     "eslint": "^8.10.0",
@@ -66,10 +66,10 @@
     "type-fest": "^2.12.0",
     "typescript": "^4.6.2",
     "vite": "^2.8.6",
-    "vitest": "^0.6.0"
+    "vitest": "^0.9.3"
   },
   "engines": {
-    "node": ">=14"
+    "node": "^12.22.0 || >=14"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org",