migrate to vitest

package.json

@@ -78,13 +78,12 @@
     "@types/semver": "^7.5.3",
     "@types/sinon": "^17.0.1",
     "@types/text-table": "^0.2.3",
+    "@vitest/coverage-v8": "^2.0.5",
     "@yeoman/adapter": "^1.4.0",
     "@yeoman/eslint": "^0.2.0",
     "@yeoman/transform": "^1.2.0",
-    "c8": "^8.0.1",
     "cpy-cli": "^5.0.0",
     "ejs": "^3.1.9",
-    "esmocha": "^1.0.1",
     "inquirer": "^9.2.11",
     "jsdoc": "^4.0.2",
     "nock": "^13.3.4",
@@ -93,8 +92,9 @@
     "sinon": "^18.0.0",
     "tui-jsdoc-template": "^1.2.2",
     "typescript": "^5.2.2",
+    "vitest": "^2.0.5",
     "yeoman-assert": "^3.1.1",
-    "yeoman-environment": "^4.0.0",
+    "yeoman-environment": "^4.4.1",
     "yeoman-test": "^9.0.0"
   },
   "peerDependencies": {

src/actions/lifecycle.ts

@@ -605,6 +605,9 @@ export abstract class TasksMixin {
     { Generator, resolved = Generator.resolved }: { Generator?: any; resolved: string },
     options: EnvironmentComposeOptions<G> = {},
   ) {
+    if (!resolved) {
+      throw new Error('Generator path property is not a string');
+    }
     const generatorNamespace = this.env.namespace(resolved);
     const findGenerator = async () => {
       const generatorImport = await import(resolved);
@@ -618,7 +621,12 @@ export abstract class TasksMixin {
       return typeof generatorImport.default === 'function' ? generatorImport.default : generatorImport;
     };
 
-    Generator = Generator ?? (await findGenerator());
+    try {
+      Generator = Generator ?? (await findGenerator());
+    } catch {
+      throw new Error('Missing Generator property');
+    }
+
     Generator.namespace = generatorNamespace;
     Generator.resolved = resolved;
     return this.env.composeWith<G>(Generator, options);

test/base.test.ts

@@ -6,7 +6,7 @@ import { fileURLToPath, pathToFileURL } from 'node:url';
 import { createRequire } from 'node:module';
 import process from 'node:process';
 import { Buffer } from 'node:buffer';
-import { afterEach, beforeEach, describe, esmocha, expect, it } from 'esmocha';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import { extend } from 'lodash-es';
 import { assert as sinonAssert, fake as sinonFake, spy as sinonSpy } from 'sinon';
 import { passthrough } from '@yeoman/transform';
@@ -31,7 +31,7 @@ describe('Base', () => {
   let dummy;
 
   beforeEach(async () => {
-    await helpers.prepareTemporaryDir();
+    await helpers.prepareTemporaryDir({ cwd: tmpdir, tmpdir: true }).run();
 
     env = createEnv();
     // Ignore error forwarded to environment
@@ -900,26 +900,18 @@ describe('Base', () => {
     });
 
     describe('object as first argument', () => {
-      it('fails for missing Generator property', () => {
+      it('fails for missing Generator property', async () => {
         const gen = dummy;
-        assert.rejects(
-          () =>
-            gen.composeWith({
-              path: 'foo-path',
-            }),
-          error => error.message.includes('Missing Generator property'),
-        );
+        await expect(gen.composeWith({
+          path: 'foo-path',
+        })).rejects.toThrow('Missing Generator property');
       });
 
-      it('fails for missing path property', () => {
+      it('fails for missing path property', async () => {
         const gen = dummy;
-        assert.rejects(
-          () =>
-            gen.composeWith({
-              Generator: GenCompose,
-            }),
-          error => error.message.includes('path property is not a string'),
-        );
+        await expect(gen.composeWith({
+          Generator: GenCompose,
+        })).rejects.toThrow('path property is not a string');
       });
     });
 
@@ -1217,7 +1209,7 @@ describe('Base', () => {
           .on('method:createSomething', assertEvent('method:createSomething'))
           .on('method:createSomethingElse', assertEvent('method:createSomethingElse'));
 
-        angular.run();
+        angular.run().catch(() => {});
       }));
 
     it('only call the end event once (bug #402)', () =>
@@ -1252,7 +1244,7 @@ describe('Base', () => {
           isFirstEndEvent = false;
         });
 
-        generatorOnce.run();
+        generatorOnce.run().catch(() => {});
       }));
 
     it('triggers end event after all generators methods are ran (#709)', () =>
@@ -1278,7 +1270,7 @@ describe('Base', () => {
           'skip-install': true,
         });
 
-        generatorEnd.run();
+        generatorEnd.run().catch(() => {});
       }));
   });
 
@@ -1526,7 +1518,7 @@ describe('Base', () => {
         run: false,
       });
 
-      const secondTask = esmocha.fn();
+      const secondTask = vi.fn();
       gen.queueTask({
         method: secondTask,
         queueName,

test/deprecate.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unused-expressions */
 import assert from 'node:assert';
-import { afterEach, beforeEach, describe, it } from 'esmocha';
+import { afterEach, beforeEach, describe, it } from 'vitest';
 import chalk from 'chalk';
 import sinon, { type SinonSpy } from 'sinon';
 import deprecate from '../src/util/deprecate.js';

test/environment.test.ts

@@ -2,8 +2,8 @@ import os from 'node:os';
 import path from 'node:path';
 import assert from 'node:assert';
 import { TestAdapter } from '@yeoman/adapter/testing';
-import { after, before, describe, it } from 'esmocha';
-import type { SinonStub} from 'sinon';
+import { afterAll, beforeAll, describe, it } from 'vitest';
+import type { SinonStub } from 'sinon';
 import { stub as sinonStub } from 'sinon';
 import Environment from 'yeoman-environment';
 import helpers from 'yeoman-test';
@@ -17,11 +17,12 @@ describe('Generator with environment version', () => {
   let dummy: Base;
   let getVersionStub: SinonStub;
 
-  before(helpers.setUpTestDirectory(tmpdir));
+  beforeAll(async () => {
+    await helpers.prepareTemporaryDir().run();
+  });
 
   describe('mocked 3.0.0', () => {
-    before(function () {
-      this.timeout(100_000);
+    beforeAll(() => {
       env = new Environment({ skipInstall: true, adapter: new TestAdapter() });
       env.getVersion = env.getVersion || (() => {});
       getVersionStub = sinonStub(env, 'getVersion');
@@ -35,9 +36,9 @@ describe('Generator with environment version', () => {
         'skip-install': true,
         skipCheckEnv: true,
       });
-    });
+    }, 100_000);
 
-    after(() => {
+    afterAll(() => {
       getVersionStub.restore();
     });
 
@@ -50,7 +51,7 @@ describe('Generator with environment version', () => {
       });
 
       describe('with required environment', () => {
-        before(() => {
+        beforeAll(() => {
           getVersionStub.returns('3.0.1');
         });
 
@@ -59,11 +60,11 @@ describe('Generator with environment version', () => {
         });
 
         describe('with ignoreVersionCheck', () => {
-          before(() => {
+          beforeAll(() => {
             dummy.options.ignoreVersionCheck = true;
           });
 
-          after(() => {
+          afterAll(() => {
             dummy.options.ignoreVersionCheck = false;
           });
 
@@ -82,7 +83,7 @@ describe('Generator with environment version', () => {
       });
 
       describe('with less than required environment', () => {
-        before(() => {
+        beforeAll(() => {
           getVersionStub.returns('3.0.0');
         });
 
@@ -100,11 +101,11 @@ describe('Generator with environment version', () => {
         });
 
         describe('with ignoreVersionCheck', () => {
-          before(() => {
+          beforeAll(() => {
             dummy.options.ignoreVersionCheck = true;
           });
 
-          after(() => {
+          afterAll(() => {
             dummy.options.ignoreVersionCheck = false;
           });
 
@@ -129,7 +130,7 @@ describe('Generator with environment version', () => {
       });
 
       describe('with less than required inquirer', () => {
-        before(() => {
+        beforeAll(() => {
           getVersionStub.withArgs('inquirer').returns('7.1.0');
         });
 
@@ -147,11 +148,11 @@ describe('Generator with environment version', () => {
         });
 
         describe('with ignoreVersionCheck', () => {
-          before(() => {
+          beforeAll(() => {
             dummy.options.ignoreVersionCheck = true;
           });
 
-          after(() => {
+          afterAll(() => {
             dummy.options.ignoreVersionCheck = false;
           });
 
@@ -172,8 +173,7 @@ describe('Generator with environment version', () => {
   });
 
   describe('mocked 2.8.1', () => {
-    before(function () {
-      this.timeout(100_000);
+    beforeAll(() => {
       env = new Environment({ skipInstall: true, adapter: new TestAdapter() });
       env.getVersion = undefined;
 
@@ -186,7 +186,7 @@ describe('Generator with environment version', () => {
         skipCheckEnv: true,
         'skip-install': true,
       });
-    });
+    }, 100_000);
 
     describe('#checkEnvironmentVersion', () => {
       describe('without args', () => {
@@ -199,11 +199,11 @@ describe('Generator with environment version', () => {
       });
 
       describe('with ignoreVersionCheck', () => {
-        before(() => {
+        beforeAll(() => {
           dummy.options.ignoreVersionCheck = true;
         });
 
-        after(() => {
+        afterAll(() => {
           dummy.options.ignoreVersionCheck = false;
         });
 

test/fixtures/generator-defaults/app/index.js

@@ -7,7 +7,7 @@
 // object, which means that you can use the API as if you were extending
 // `Base`.
 
-import Base from '../../../../src/index.js';
+import Base from '../../../../dist/index.js';
 import options from './options.js';
 import prompts from './prompts.js';
 

test/fixtures/generator-mocha/main.js

@@ -12,7 +12,7 @@
 // It works with simple generator, if you need to do a bit more complex
 // stuff, extends from Generator.Base and defines your generator steps
 // in several methods.
-import Base from '../../../src/index.js';
+import Base from '../../../dist/index.js';
 
 class Generator extends Base {
   notEmpty() {}

test/fixtures/options-generator/main.js

@@ -7,7 +7,7 @@
 // object, which means that you can use the API as if you were extending
 // `Base`.
 
-import Base from '../../../src/index.js';
+import Base from '../../../dist/index.js';
 
 export default class Generator extends Base {
   constructor(args, opts) {

test/fs.test.ts

@@ -1,6 +1,6 @@
 import assert from 'node:assert';
 import path from 'node:path';
-import { afterEach, before, beforeEach, describe, esmocha, it } from 'esmocha';
+import { afterEach, beforeAll, beforeEach, describe, it, vi } from 'vitest';
 import { TestAdapter } from '@yeoman/adapter/testing';
 import { type SinonStub, stub as sinonStub } from 'sinon';
 import type { Data as TemplateData } from 'ejs';
@@ -91,10 +91,9 @@ describe('generators.Base (actions/fs)', () => {
   let gen: Base;
   let base: BaseGenerator;
 
-  before(function () {
-    this.timeout(10_000);
+  beforeAll(() => {
     gen = new Base({ env: createEnv(), resolved: 'unknown', help: true });
-  });
+  }, 10_000);
 
   beforeEach(() => {
     returns = {};
@@ -103,7 +102,7 @@ describe('generators.Base (actions/fs)', () => {
     // Why not use a sinonStub for base.config as is done in #renderTemplate and #renderTemplateAsync below?
     //  base get config is not being tested in any way below.
     // @ts-expect-error Config is a string (not a symbol) and we know it exists on base  https://github.com/DefinitelyTyped/DefinitelyTyped/issues/33173
-    esmocha.spyOn(base, 'config', 'get').mockReturnValue({
+    vi.spyOn(base, 'config', 'get').mockReturnValue({
       getAll() {
         return configGetAll;
       },

test/generators-compose-workflow.test.ts

@@ -1,6 +1,6 @@
 import os from 'node:os';
 import path from 'node:path';
-import { beforeEach, describe, it } from 'esmocha';
+import { beforeEach, describe, it } from 'vitest';
 import { mkdirSync } from 'node:fs';
 import { TestAdapter } from '@yeoman/adapter/testing';
 import type { SinonSpy } from 'sinon';
@@ -32,9 +32,9 @@ describe('Multiples generators', () => {
   let spyEnd2: SinonSpy;
   let spyExec3: SinonSpy;
 
-  beforeEach(helpers.setUpTestDirectory(tmpdir));
+  beforeEach(async () => {
+    await helpers.prepareTemporaryDir().run();
 
-  beforeEach(() => {
     env = createEnv();
     mkdirSync(resolveddir, { recursive: true });
     Dummy = class extends Base {};

test/generators.test.ts

@@ -1,7 +1,7 @@
 import EventEmitter from 'node:events';
 import path from 'node:path';
 import os from 'node:os';
-import { beforeEach, describe, it } from 'esmocha';
+import { beforeEach, describe, it } from 'vitest';
 import { TestAdapter } from '@yeoman/adapter/testing';
 import Environment from 'yeoman-environment';
 import assert from 'yeoman-assert';