yeoman-test 8.0.0-rc.1 → 8.0.0

package/dist/run-context.d.ts

@@ -46,6 +46,7 @@ export declare class RunContextBase<GeneratorType extends BaseGenerator = Defaul
     targetDirectory?: string;
     editor: MemFsEditor;
     memFs: Store<MemFsEditorFile>;
+    spawnStub?: any;
     mockedGeneratorFactory: MockedGeneratorFactory;
     protected environmentPromise?: PromiseRunResult<GeneratorType>;
     private args;
@@ -202,6 +203,7 @@ export declare class RunContextBase<GeneratorType extends BaseGenerator = Defaul
      * });
      */
     withGenerators(dependencies: Dependency[]): this;
+    withSpawnMock(stub?: import("sinon").SinonStub<any[], any>): this;
     withMockedGeneratorFactory(mockedGeneratorFactory: MockedGeneratorFactory): this;
     /**
      * Create mocked generators

package/dist/run-context.js

@@ -9,10 +9,12 @@ import { camelCase, kebabCase, merge as lodashMerge, set as lodashSet } from 'lo
 import { resetFileCommitStates } from 'mem-fs-editor/state';
 import { create as createMemFs } from 'mem-fs';
 import tempDirectory from 'temp-dir';
+import { stub as sinonStub } from 'sinon';
 import { create as createMemFsEditor } from 'mem-fs-editor';
 import RunResult from './run-result.js';
 import defaultHelpers from './helpers.js';
 import testContext from './test-context.js';
+// eslint-disable-next-line unicorn/prefer-event-target
 export class RunContextBase extends EventEmitter {
     mockedGenerators = {};
     env;
@@ -23,6 +25,7 @@ export class RunContextBase extends EventEmitter {
     targetDirectory;
     editor;
     memFs;
+    spawnStub;
     mockedGeneratorFactory;
     environmentPromise;
     args = [];
@@ -308,6 +311,23 @@ export class RunContextBase extends EventEmitter {
             }
         });
     }
+    withSpawnMock(stub = sinonStub()) {
+        if (this.spawnStub) {
+            throw new Error('Multiple withSpawnMock calls');
+        }
+        this.spawnStub = stub;
+        return this.onEnvironment(env => {
+            env.on('compose', (_namespace, generator) => {
+                const createCallback = method => function (...args) {
+                    stub.call(this, method, ...args);
+                };
+                generator.spawnCommand = createCallback('spawnCommand');
+                generator.spawnCommandSync = createCallback('spawnCommandSync');
+                generator.spawn = createCallback('spawn');
+                generator.spawnSync = createCallback('spawnSync');
+            });
+        });
+    }
     withMockedGeneratorFactory(mockedGeneratorFactory) {
         this.mockedGeneratorFactory = mockedGeneratorFactory;
         return this;
@@ -534,6 +554,7 @@ export class RunContextBase extends EventEmitter {
             settings: {
                 ...this.settings,
             },
+            spawnStub: this.spawnStub,
             oldCwd: this.oldCwd,
             cwd: this.targetDirectory,
             envOptions: this.envOptions,

package/dist/run-result.d.ts

@@ -31,6 +31,7 @@ export type RunResultOptions<GeneratorType extends BaseGenerator> = {
      * The mocked generators of the context.
      */
     mockedGenerators: Record<string, BaseGenerator>;
+    spawnStub?: any;
     settings: RunContextSettings;
     helpers: YeomanTest;
 };
@@ -46,12 +47,14 @@ export default class RunResult<GeneratorType extends BaseGenerator = BaseGenerat
     fs: MemFsEditor;
     mockedGenerators: any;
     options: RunResultOptions<GeneratorType>;
+    spawnStub?: any;
     constructor(options: RunResultOptions<GeneratorType>);
     /**
      * Create another RunContext reusing the settings.
      * See helpers.create api
      */
     create<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GetGeneratorConstructor<GeneratorType>, settings?: RunContextSettings, envOptions?: BaseEnvironmentOptions): import("./run-context.js").default<GeneratorType>;
+    getSpawnArgsUsingDefaultImplementation(): any;
     /**
      * Return an object with fs changes.
      * @param {Function} filter - parameter forwarded to mem-fs-editor#dump

package/dist/run-result.js

@@ -23,6 +23,7 @@ export default class RunResult {
     fs;
     mockedGenerators;
     options;
+    spawnStub;
     constructor(options) {
         if (options.memFs && !options.cwd) {
             throw new Error('CWD option is required for mem-fs tests');
@@ -34,6 +35,7 @@ export default class RunResult {
         this.memFs = options.memFs;
         this.fs = this.memFs && createMemFsEditor(this.memFs);
         this.mockedGenerators = options.mockedGenerators || {};
+        this.spawnStub = options.spawnStub;
         this.options = options;
     }
     /**
@@ -50,6 +52,12 @@ export default class RunResult {
             autoCleanup: false,
         }, { ...this.options.envOptions, ...envOptions });
     }
+    getSpawnArgsUsingDefaultImplementation() {
+        if (!this.spawnStub) {
+            throw new Error('Spawn stub was not found');
+        }
+        return this.spawnStub.getCalls().map(call => call.args);
+    }
     /**
      * Return an object with fs changes.
      * @param {Function} filter - parameter forwarded to mem-fs-editor#dump
@@ -208,7 +216,7 @@ export default class RunResult {
      * result.assertTextEqual('I have a yellow cat', 'I have a yellow cat');
      */
     assertTextEqual(value, expected) {
-        const eol = string => string.replace(/\r\n/g, '\n');
+        const eol = string => string.replaceAll('\r\n', '\n');
         assert.equal(eol(value), eol(expected));
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-test",
-  "version": "8.0.0-rc.1",
+  "version": "8.0.0",
   "description": "Test utilities for Yeoman generators",
   "keywords": [
     "yeoman",
@@ -41,33 +41,33 @@
     "lodash-es": "^4.17.21",
     "mem-fs": "^3.0.0",
     "mem-fs-editor": "^10.0.2",
-    "sinon": "^15.1.0",
+    "sinon": "^16.0.0",
     "temp-dir": "^3.0.0",
-    "type-fest": "^3.10.0"
+    "type-fest": "^4.3.1"
   },
   "devDependencies": {
     "@types/inquirer": "^9.0.3",
     "@types/lodash": "^4.14.195",
     "@types/node": "^16.18.19",
     "@types/sinon": "^10.0.13",
-    "c8": "^7.13.0",
+    "c8": "^8.0.0",
     "coveralls": "^3.1.1",
     "esmocha": "^1.0.1",
     "husky": "^8.0.2",
     "jsdoc": "^4.0.2",
-    "lint-staged": "^13.0.3",
-    "prettier": "^2.2.1",
+    "lint-staged": "^14.0.1",
+    "prettier": "^3.0.3",
     "prettier-plugin-packagejson": "^2.3.0",
     "tui-jsdoc-template": "^1.2.2",
-    "typescript": "^5.0.4",
-    "xo": "^0.54.2",
+    "typescript": "~5.2.2",
+    "xo": "0.56.0",
     "yeoman-environment": "^3.18.3",
     "yeoman-generator": "^5.9.0"
   },
   "peerDependencies": {
     "@yeoman/types": "^1.0.1",
     "yeoman-environment": "^3.18.3 || ^4.0.0-alpha.6",
-    "yeoman-generator": "^5.9.0 || ^6.0.0-beta.4"
+    "yeoman-generator": "^5.9.0 || ^6.0.0"
   },
   "peerDependenciesMeta": {
     "yeoman-environment": {