yeoman-test 7.2.0 → 7.3.0

package/README.md

@@ -41,7 +41,7 @@ describe('generator test', () => {
         [.withLookups({})]          // runs Environment lookups
         [.withOptions({})]          // passes options to the generator
         [.withLocalConfig({})]      // sets the generator config as soon as it is instantiated
-        [.withPrompts()]            // simulates the prompt answers
+        [.withAnswers()]            // simulates the prompt answers
         [.build(runContext => {     // instantiates Environment/Generator
           [runContext.env...]       // does something with the environment
           [runContext.generator...] // does something with the generator

package/dist/helpers.d.ts

@@ -10,8 +10,8 @@ import type { RunContextSettings } from './run-context.js';
  * Dependencies can be path (autodiscovery) or an array [<generator>, <name>]
  */
 export type Dependency = string | Parameters<Environment['registerStub']> | Parameters<Environment['register']>;
-type GeneratorNew<GenParameter extends YeomanGenerator = YeomanGenerator> = new (...args: ConstructorParameters<typeof YeomanGenerator<GenParameter['options']>>) => YeomanGenerator<GenParameter['options']>;
-type GeneratorBuilder<GenParameter extends YeomanGenerator = YeomanGenerator> = (...args: ConstructorParameters<typeof YeomanGenerator<GenParameter['options']>>) => YeomanGenerator<GenParameter['options']>;
+type GeneratorNew<GenParameter extends YeomanGenerator = YeomanGenerator> = new (...args: ConstructorParameters<typeof YeomanGenerator<GenParameter['options']>>) => GenParameter;
+type GeneratorBuilder<GenParameter extends YeomanGenerator = YeomanGenerator> = (...args: ConstructorParameters<typeof YeomanGenerator<GenParameter['options']>>) => GenParameter;
 export type GeneratorConstructor<GenParameter extends YeomanGenerator = YeomanGenerator> = GeneratorNew<GenParameter> | GeneratorBuilder<GenParameter>;
 /**
  * Collection of unit test helpers. (mostly related to Mocha syntax)
@@ -137,13 +137,13 @@ export declare class YeomanTest {
      * Run the provided Generator
      * @param GeneratorOrNamespace - Generator constructor or namespace
      */
-    run<GeneratorType extends YeomanGenerator = YeomanGenerator>(GeneratorOrNamespace: string | GeneratorConstructor, settings?: RunContextSettings, envOptions?: Options): RunContext<GeneratorType>;
+    run<GeneratorType extends YeomanGenerator = YeomanGenerator>(GeneratorOrNamespace: string | GeneratorConstructor<GeneratorType>, settings?: RunContextSettings, envOptions?: Options): RunContext<GeneratorType>;
     /**
      * Prepare a run context
      * @param  {String|Function} GeneratorOrNamespace - Generator constructor or namespace
      * @return {RunContext}
      */
-    create<GeneratorType extends YeomanGenerator = YeomanGenerator>(GeneratorOrNamespace: string | GeneratorConstructor, settings?: RunContextSettings, envOptions?: Options): RunContext<GeneratorType>;
+    create<GeneratorType extends YeomanGenerator = YeomanGenerator>(GeneratorOrNamespace: string | GeneratorConstructor<GeneratorType>, settings?: RunContextSettings, envOptions?: Options): RunContext<GeneratorType>;
 }
 declare const _default: YeomanTest;
 export default _default;

package/dist/helpers.js

@@ -9,6 +9,7 @@ import Environment from 'yeoman-environment';
 import { DummyPrompt, TestAdapter } from './adapter.js';
 import RunContext from './run-context.js';
 import testContext from './test-context.js';
+const { cloneDeep } = _;
 /**
  * Collection of unit test helpers. (mostly related to Mocha syntax)
  * @class YeomanTest
@@ -206,7 +207,7 @@ export class YeomanTest {
      * const env = createTestEnv(require('yeoman-environment').createEnv);
      */
     createTestEnv(envContructor = this.createEnv, options = { localConfigOnly: true }) {
-        const envOptions = _.cloneDeep(this.environmentOptions ?? {});
+        const envOptions = cloneDeep(this.environmentOptions ?? {});
         if (typeof options === 'boolean') {
             options = {
                 newErrorHandler: true,
@@ -243,8 +244,8 @@ export class YeomanTest {
      * @param GeneratorOrNamespace - Generator constructor or namespace
      */
     run(GeneratorOrNamespace, settings, envOptions) {
-        const contextSettings = _.cloneDeep(this.settings ?? {});
-        const generatorOptions = _.cloneDeep(this.generatorOptions ?? {});
+        const contextSettings = cloneDeep(this.settings ?? {});
+        const generatorOptions = cloneDeep(this.generatorOptions ?? {});
         const RunContext = this.getRunContextType();
         const runContext = new RunContext(GeneratorOrNamespace, { ...contextSettings, ...settings }, envOptions, this).withOptions(generatorOptions);
         if (settings?.autoCleanup !== false) {

package/dist/run-context.d.ts

@@ -67,7 +67,7 @@ export declare class RunContextBase<GeneratorType extends Generator = Generator>
      * @param settings
      * @return {this}
      */
-    constructor(generatorType: string | GeneratorConstructor | typeof Generator, settings?: RunContextSettings, envOptions?: Options, helpers?: YeomanTest);
+    constructor(generatorType: string | GeneratorConstructor<GeneratorType> | typeof Generator, settings?: RunContextSettings, envOptions?: Options, helpers?: YeomanTest);
     /**
      * Run the generator on the environment and promises a RunResult instance.
      * @return {PromiseRunResult} Promise a RunResult instance.
@@ -213,7 +213,9 @@ export declare class RunContextBase<GeneratorType extends Generator = Generator>
     /**
      * Add files to mem-fs.
      * Files will be resolved relative to targetDir.
-     * @param files
+     *
+     * Files with Object content will be merged to existing content.
+     * To avoid merging, `JSON.stringify` the content.
      */
     withFiles(files: Record<string, string | Record<string, unknown>>): this;
     withFiles(relativePath: string, files: Record<string, string | Record<string, unknown>>): this;
@@ -224,6 +226,10 @@ export declare class RunContextBase<GeneratorType extends Generator = Generator>
      * @returns
      */
     withYoRc(content: string | Record<string, unknown>): this;
+    /**
+     * Add a generator config to .yo-rc.json
+     */
+    withYoRcConfig(key: string, content: Record<string, unknown>): this;
     /**
      * Commit mem-fs files.
      */
@@ -271,7 +277,7 @@ export declare class RunContextBase<GeneratorType extends Generator = Generator>
     private setDir;
     private _createRunResultOptions;
 }
-export default class RunContext<GeneratorType extends Generator> extends RunContextBase<GeneratorType> implements Promise<RunResult<GeneratorType>> {
+export default class RunContext<GeneratorType extends Generator = Generator> extends RunContextBase<GeneratorType> implements Promise<RunResult<GeneratorType>> {
     then<TResult1 = RunResult<GeneratorType>, TResult2 = never>(onfulfilled?: ((value: RunResult<GeneratorType>) => TResult1 | PromiseLike<TResult1>) | undefined | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | undefined): Promise<TResult1 | TResult2>;
     catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | undefined): Promise<RunResult<GeneratorType> | TResult>;
     finally(onfinally?: (() => void) | undefined | undefined): Promise<RunResult<GeneratorType>>;

package/dist/run-context.js

@@ -9,6 +9,7 @@ import tempDirectory from 'temp-dir';
 import MemFsEditor from 'mem-fs-editor';
 import RunResult from './run-result.js';
 import defaultHelpers from './helpers.js';
+const { camelCase, kebabCase, merge: lodashMerge, set: lodashSet } = _;
 export class RunContextBase extends EventEmitter {
     mockedGenerators = {};
     env;
@@ -234,8 +235,8 @@ export class RunContextBase extends EventEmitter {
         // Add options as both kebab and camel case. This is to stay backward compatibles with
         // the switch we made to meow for options parsing.
         for (const key of Object.keys(options)) {
-            options[_.camelCase(key)] = options[key];
-            options[_.kebabCase(key)] = options[key];
+            options[camelCase(key)] = options[key];
+            options[kebabCase(key)] = options[key];
         }
         this.options = { ...this.options, ...options };
         return this;
@@ -346,7 +347,8 @@ export class RunContextBase extends EventEmitter {
                     this.editor.write(resolvedFile, content);
                 }
                 else {
-                    this.editor.writeJSON(resolvedFile, content);
+                    const fileContent = this.editor.readJSON(resolvedFile, {});
+                    this.editor.writeJSON(resolvedFile, lodashMerge(fileContent, content));
                 }
             }
         });
@@ -362,6 +364,13 @@ export class RunContextBase extends EventEmitter {
             '.yo-rc.json': content,
         });
     }
+    /**
+     * Add a generator config to .yo-rc.json
+     */
+    withYoRcConfig(key, content) {
+        const yoRcContent = lodashSet({}, key, content);
+        return this.withYoRc(yoRcContent);
+    }
     /**
      * Commit mem-fs files.
      */

package/dist/run-result.d.ts

@@ -37,7 +37,7 @@ export type RunResultOptions<GeneratorType extends Generator> = {
 /**
  * This class provides utilities for testing generated content.
  */
-export default class RunResult<GeneratorType extends Generator> {
+export default class RunResult<GeneratorType extends Generator = Generator> {
     env: any;
     generator: GeneratorType;
     cwd: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-test",
-  "version": "7.2.0",
+  "version": "7.3.0",
   "description": "Test utilities for Yeoman generators",
   "homepage": "http://yeoman.io/authoring/testing.html",
   "author": "The Yeoman Team",