yeoman-test 7.4.0 → 8.0.0-alpha.1

package/dist/helpers.d.ts

@@ -149,6 +149,6 @@ export declare class YeomanTest {
      */
     prepareTemporaryDir(settings?: RunContextSettings): BasicRunContext;
 }
-declare const _default: YeomanTest;
-export default _default;
+declare const defaultHelpers: YeomanTest;
+export default defaultHelpers;
 export declare const createHelpers: (options: any) => YeomanTest;

package/dist/helpers.js

@@ -76,6 +76,9 @@ export class YeomanTest {
      */
     mockPrompt(envOrGenerator, mockedAnswers, options) {
         const environment = 'env' in envOrGenerator ? envOrGenerator.env : envOrGenerator;
+        if (!environment.adapter) {
+            throw new Error('environment is not an Environment instance');
+        }
         const { promptModule } = environment.adapter;
         for (const name of Object.keys(promptModule.prompts)) {
             promptModule.registerPrompt(name, class CustomDummyPrompt extends DummyPrompt {
@@ -273,7 +276,8 @@ export class YeomanTest {
         return context;
     }
 }
-export default new YeomanTest();
+const defaultHelpers = new YeomanTest();
+export default defaultHelpers;
 export const createHelpers = options => {
     const helpers = new YeomanTest();
     Object.assign(helpers, options);

package/dist/run-context.d.ts

@@ -3,8 +3,8 @@ import { EventEmitter } from 'node:events';
 import type Generator from 'yeoman-generator';
 import type Environment from 'yeoman-environment';
 import { type LookupOptions, type Options } from 'yeoman-environment';
-import MemFsEditor from 'mem-fs-editor';
-import MemFs from 'mem-fs';
+import { type MemFsEditor, type VinylMemFsEditorFile } from 'mem-fs-editor';
+import { type Store } from 'mem-fs';
 import RunResult, { type RunResultOptions } from './run-result.js';
 import { type GeneratorConstructor, type Dependency, type YeomanTest } from './helpers.js';
 import { type DummyPromptOptions } from './adapter.js';
@@ -21,7 +21,7 @@ export type RunContextSettings = {
     oldCwd?: string;
     forwardCwd?: boolean;
     autoCleanup?: boolean;
-    memFs?: MemFs.Store;
+    memFs?: Store;
     /**
      * File path to the generator (only used if Generator is a constructor)
      */
@@ -42,8 +42,8 @@ export declare class RunContextBase<GeneratorType extends Generator = Generator>
     readonly envOptions: Environment.Options;
     completed: boolean;
     targetDirectory?: string;
-    editor: MemFsEditor.Editor;
-    memFs: MemFs.Store;
+    editor: MemFsEditor;
+    memFs: Store<VinylMemFsEditorFile>;
     mockedGeneratorFactory: MockedGeneratorFactory;
     protected environmentPromise?: PromiseRunResult<GeneratorType>;
     private args;

package/dist/run-context.js

@@ -6,9 +6,10 @@ import { EventEmitter } from 'node:events';
 import process from 'node:process';
 import _ from 'lodash';
 import tempDirectory from 'temp-dir';
-import MemFsEditor from 'mem-fs-editor';
-import MemFsEditorState from 'mem-fs-editor/lib/state.js';
-import MemFs from 'mem-fs';
+import { create as createMemFsEditor } from 'mem-fs-editor';
+// eslint-disable-next-line n/file-extension-in-import
+import { resetFileCommitStates } from 'mem-fs-editor/state';
+import { create as createMemFs } from 'mem-fs';
 import RunResult from './run-result.js';
 import defaultHelpers from './helpers.js';
 import testContext from './test-context.js';
@@ -69,7 +70,7 @@ export class RunContextBase extends EventEmitter {
             this.cd(this.settings.cwd);
         }
         this.helpers = helpers;
-        this.memFs = settings?.memFs ?? MemFs.create();
+        this.memFs = settings?.memFs ?? createMemFs();
         this.mockedGeneratorFactory = this.helpers.createMockedGenerator;
     }
     /**
@@ -451,11 +452,10 @@ export class RunContextBase extends EventEmitter {
         }
         if (!this.keepFsState) {
             this.memFs.each(file => {
-                // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-                delete file[MemFsEditorState.STATE_CLEARED];
+                resetFileCommitStates(file);
             });
         }
-        this.editor = MemFsEditor.create(this.memFs);
+        this.editor = createMemFsEditor(this.memFs);
         for (const onTargetDirectory of this.onTargetDirectoryCallbacks) {
             // eslint-disable-next-line no-await-in-loop
             await onTargetDirectory.call(this, this.targetDirectory);

package/dist/run-result.d.ts

@@ -1,4 +1,4 @@
-import MemFsEditor, { type Editor } from 'mem-fs-editor';
+import { type MemFsEditor } from 'mem-fs-editor';
 import type { Store } from 'mem-fs';
 import type Environment from 'yeoman-environment';
 import type Generator from 'yeoman-generator';
@@ -26,7 +26,7 @@ export type RunResultOptions<GeneratorType extends Generator> = {
      * The file-system of the generator.
      */
     memFs: Store;
-    fs?: MemFsEditor.Editor;
+    fs?: MemFsEditor;
     /**
      * The mocked generators of the context.
      */
@@ -43,7 +43,7 @@ export default class RunResult<GeneratorType extends Generator = Generator> {
     cwd: string;
     oldCwd: string;
     memFs: Store;
-    fs: Editor;
+    fs: MemFsEditor;
     mockedGenerators: any;
     options: RunResultOptions<GeneratorType>;
     constructor(options: RunResultOptions<GeneratorType>);

package/dist/run-result.js

@@ -2,7 +2,7 @@ import assert from 'node:assert';
 import { existsSync, readFileSync, rmSync } from 'node:fs';
 import path from 'node:path';
 import process from 'node:process';
-import MemFsEditor from 'mem-fs-editor';
+import { create as createMemFsEditor } from 'mem-fs-editor';
 const isObject = object => typeof object === 'object' && object !== null && object !== undefined;
 function convertArgs(args) {
     if (args.length > 1) {
@@ -32,7 +32,7 @@ export default class RunResult {
         this.cwd = options.cwd ?? process.cwd();
         this.oldCwd = options.oldCwd;
         this.memFs = options.memFs;
-        this.fs = this.memFs && MemFsEditor.create(this.memFs);
+        this.fs = this.memFs && createMemFsEditor(this.memFs);
         this.mockedGenerators = options.mockedGenerators || {};
         this.options = options;
     }
@@ -121,7 +121,7 @@ export default class RunResult {
     }
     _readFile(filename, json) {
         filename = this._fileName(filename);
-        const file = this.fs ? this.fs.read(filename) : readFileSync(filename, 'utf8');
+        const file = (this.fs ? this.fs.read(filename) : undefined) ?? readFileSync(filename, 'utf8');
         return json ? JSON.parse(file) : file;
     }
     _exists(filename) {

package/dist/test-context.d.ts

@@ -3,7 +3,7 @@ import type RunResult from './run-result.js';
 declare class TestContext {
     runResult?: RunResult;
     private runContext?;
-    startNewContext(runContext: RunContext<any>): void;
+    startNewContext(runContext?: RunContext<any>): void;
 }
 declare const testContext: TestContext;
 export default testContext;

package/dist/test-context.js

@@ -1,3 +1,4 @@
+import process from 'node:process';
 class TestContext {
     runResult;
     runContext;
@@ -8,6 +9,12 @@ class TestContext {
     }
 }
 const testContext = new TestContext();
+const cleanupTemporaryDir = () => {
+    testContext.startNewContext();
+};
+process.on('exit', cleanupTemporaryDir);
+process.on('SIGINT', cleanupTemporaryDir);
+process.on('SIGTERM', cleanupTemporaryDir);
 export default testContext;
 const handler2 = {
     get(_target, prop, receiver) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-test",
-  "version": "7.4.0",
+  "version": "8.0.0-alpha.1",
   "description": "Test utilities for Yeoman generators",
   "homepage": "http://yeoman.io/authoring/testing.html",
   "author": "The Yeoman Team",
@@ -20,48 +20,44 @@
   "repository": "yeoman/yeoman-test",
   "license": "MIT",
   "engines": {
-    "node": "^14.15.0 || ^16.13.0 || >=18.12.0"
+    "node": "^16.17.0 || >=18.12.0"
   },
   "config": {
     "doc_path": "../yeoman-test-doc"
   },
   "devDependencies": {
-    "@node-loaders/esbuild": "^0.6.0",
-    "@types/mocha": "^10.0.0",
+    "@types/node": "^16.18.19",
     "@types/sinon": "^10.0.13",
+    "c8": "^7.13.0",
     "coveralls": "^3.1.1",
+    "esmocha": "^0.1.4",
     "husky": "^8.0.2",
     "jsdoc": "^3.6.10",
     "lint-staged": "^13.0.3",
-    "mem-fs": "^2.2.1",
-    "mocha": "^10.1.0",
-    "mocha-expect-snapshot": "^7.0.0",
     "prettier": "^2.2.1",
     "prettier-plugin-packagejson": "^2.3.0",
     "tui-jsdoc-template": "^1.2.2",
     "typescript": "^4.9.3",
     "xo": "^0.53.1",
-    "yeoman-environment": "^3.13.0",
-    "yeoman-generator": "^5.7.0"
+    "yeoman-environment": "^4.0.0-alpha.1"
   },
   "dependencies": {
     "@types/inquirer": "^8.2.5",
-    "@types/mem-fs-editor": "^7.0.2",
     "@types/yeoman-environment": "^2.10.8",
     "@types/yeoman-generator": "^5.2.11",
     "inquirer": "^8.2.5",
     "lodash": "^4.17.21",
-    "mem-fs-editor": "^9.7.0",
+    "mem-fs": "^3.0.0",
+    "mem-fs-editor": "^10.0.1",
     "sinon": "^14.0.2",
-    "temp-dir": "^3.0.0"
+    "temp-dir": "^3.0.0",
+    "yeoman-generator": "^5.7.0"
   },
   "peerDependencies": {
-    "mem-fs": "^2.2.1",
-    "yeoman-environment": "^3.13.0",
-    "yeoman-generator": "*"
+    "yeoman-environment": "^3.13.0 || ^4.0.0-alpha.0"
   },
   "scripts": {
-    "test": "mocha",
+    "test": "c8 esmocha",
     "build": "tsc",
     "prepare": "npm run build",
     "pretest": "xo",
@@ -86,5 +82,10 @@
       "prettier --write",
       "git add"
     ]
+  },
+  "overrides": {
+    "yeoman-generator": {
+      "yeoman-environment": "^4.0.0-alpha.0"
+    }
   }
 }