feat: allow loading using require() (#258)

* fix: test if yeoman-test can be loaded using require().

* fix: drop temp-dir dependency due to top level await

* feat: rework top level await to allow loading using require()

Author: mshima

eslint.config.js

@@ -8,5 +8,6 @@ export default config(...configs, {
     'unicorn/no-thenable': 'off',
     'unicorn/prefer-event-target': 'off',
     'unicorn/no-object-as-default-parameter': 'off',
+    'unicorn/prefer-top-level-await': 'off',
   },
 });

package-lock.json

@@ -17,7 +17,8 @@
     },
     ".": {
       "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
+      "require": "./dist/index.js",
+      "default": "./dist/import.js"
     }
   },
   "main": "./dist/index.js",
@@ -46,14 +47,13 @@
     "lodash-es": "^4.17.21",
     "mem-fs-editor": "^11.1.1",
     "signal-exit": "^4.1.0",
-    "temp-dir": "^3.0.0",
     "type-fest": "^4.25.0"
   },
   "devDependencies": {
-    "@yeoman/adapter": "^2.0.0",
     "@types/lodash-es": "^4.17.12",
     "@types/node": ">=18.19.46",
     "@vitest/coverage-v8": "^3.0.2",
+    "@yeoman/adapter": "^2.0.0",
     "@yeoman/eslint": "0.2.0",
     "coveralls": "^3.1.1",
     "husky": "^9.1.5",

package.json

@@ -1,4 +1,5 @@
 import { existsSync, mkdirSync, rmSync } from 'node:fs';
+import { createRequire } from 'node:module';
 import { resolve } from 'node:path';
 import process from 'node:process';
 import { mock } from 'node:test';
@@ -18,13 +19,15 @@ import RunContext, { BasicRunContext, type RunContextSettings } from './run-cont
 import testContext from './test-context.js';
 import { createEnv as createEnvironment } from './default-environment.js';
 
-let GeneratorImplementation;
-try {
-  const GeneratorImport = await import('yeoman-generator');
-  GeneratorImplementation = GeneratorImport.default ?? GeneratorImport;
-} catch {
-  // Ignore error
-}
+let dummyParentClass;
+export const setDefaultDummyParentClass = parentClass => {
+  dummyParentClass = parentClass;
+};
+
+const getDummyParentClass = () => {
+  dummyParentClass ??= createRequire(import.meta.url)('yeoman-generator').default;
+  return dummyParentClass;
+};
 
 export type CreateEnv = (options: BaseEnvironmentOptions) => Promise<BaseEnvironment>;
 
@@ -145,7 +148,7 @@ export class YeomanTest {
   /**
    * Create a mocked generator
    */
-  createMockedGenerator(GeneratorClass = GeneratorImplementation): ReturnType<typeof mock.fn> {
+  createMockedGenerator(GeneratorClass = getDummyParentClass()): ReturnType<typeof mock.fn> {
     class MockedGenerator extends GeneratorClass {}
     const generator = mock.fn(MockedGenerator);
     for (const methodName of ['run', 'queueTasks', 'runWithOptions', 'queueOwnTasks']) {
@@ -161,7 +164,7 @@ export class YeomanTest {
    * Create a simple, dummy generator
    */
   createDummyGenerator<GenParameter extends BaseGenerator = DefaultGeneratorApi>(
-    Generator: GetGeneratorConstructor<GenParameter> = GeneratorImplementation,
+    Generator: GetGeneratorConstructor<GenParameter> = getDummyParentClass(),
     contents: Record<string, (...arguments_: any[]) => void> = {
       test(this: any) {
         this.shouldRun = true;

src/helpers.ts

@@ -0,0 +1,13 @@
+import { setDefaultDummyParentClass } from './helpers.js';
+
+let GeneratorImplementation;
+try {
+  const GeneratorImport = await import('yeoman-generator');
+  GeneratorImplementation = GeneratorImport.default ?? GeneratorImport;
+  setDefaultDummyParentClass(GeneratorImplementation);
+} catch {
+  // ignore
+}
+
+export * from './index.js';
+export { default } from './index.js';

src/import.ts

@@ -1,14 +1,14 @@
 import crypto from 'node:crypto';
-import { existsSync, rmSync } from 'node:fs';
+import { existsSync, realpathSync, rmSync } from 'node:fs';
 import path, { isAbsolute, join as pathJoin, resolve } from 'node:path';
 import assert from 'node:assert';
 import { EventEmitter } from 'node:events';
+import { tmpdir } from 'node:os';
 import process from 'node:process';
 import { mock } from 'node:test';
 import { camelCase, kebabCase, merge as lodashMerge, set as lodashSet } from 'lodash-es';
 import { resetFileCommitStates } from 'mem-fs-editor/state';
 import { type Store, create as createMemFs } from 'mem-fs';
-import tempDirectory from 'temp-dir';
 import type {
   BaseEnvironmentOptions,
   BaseGenerator,
@@ -24,6 +24,8 @@ import defaultHelpers, { type CreateEnv as CreateEnvironment, type Dependency, t
 import { type AskedQuestions, type DummyPromptCallback, type DummyPromptOptions, type TestAdapterOptions } from './adapter.js';
 import testContext from './test-context.js';
 
+const tempDirectory = realpathSync(tmpdir());
+
 /**
  * Provides settings for creating a `RunContext`.
  */

src/run-context.ts

@@ -10,10 +10,12 @@ import Generator from 'yeoman-generator';
 import { afterEach, beforeEach, describe, expect, it } from 'vitest';
 import type Environment from 'yeoman-environment';
 import { createEnv as createEnvironment } from '../src/default-environment.js';
-import helpers from '../src/helpers.js';
+import helpers from '../src/import.js';
 import { TestAdapter } from '../src/adapter.js';
 import RunContext from '../src/run-context.js';
 
+const [major, minor] = process.versions.node.split('.').map(Number);
+
 /* Remove argument from promisify return */
 const promisify = function_ => () => promisify_(function_)();
 const require = createRequire(import.meta.url);
@@ -31,6 +33,10 @@ describe('yeoman-test', () => {
     StubGenerator = class extends Generator {};
   });
 
+  it.skipIf(major < 22 || (major == 22 && minor < 12))('yeoman-test should allow to be required', () => {
+    require('../').default.createMockedGenerator();
+  });
+
   describe('.createGenerator()', () => {
     it('create a new generator', async () => {
       const generator = await helpers.createGenerator('unicorn:app', {

test/helpers.spec.ts

@@ -6,7 +6,7 @@ import { createRequire } from 'node:module';
 import { mock } from 'node:test';
 import { type LookupOptions } from '@yeoman/types';
 import { afterAll, afterEach, beforeAll, beforeEach, describe, it } from 'vitest';
-import helpers from '../src/helpers.js';
+import helpers from '../src/import.js';
 import RunContext from '../src/run-context.js';
 import RunResult from '../src/run-result.js';
 import SimpleApp from './fixtures/generator-simple/app/index.js';

test/run-context-environment.spec.ts

@@ -1,18 +1,20 @@
-import fs from 'node:fs';
+import fs, { realpathSync } from 'node:fs';
 import path, { dirname } from 'node:path';
 import assert from 'node:assert';
 import { fileURLToPath } from 'node:url';
 import process from 'node:process';
 import { createRequire } from 'node:module';
+import os from 'node:os';
 import { mock } from 'node:test';
 import { promisify as promisify_ } from 'node:util';
 import { afterEach, beforeAll, beforeEach, describe, expect, it } from 'vitest';
 import Generator from 'yeoman-generator';
-import tempDirectory from 'temp-dir';
 import { RunContextBase as RunContext } from '../src/run-context.js';
-import helpers from '../src/helpers.js';
+import helpers from '../src/import.js';
 import { BaseEnvironmentOptions } from '@yeoman/types';
 
+const tempDirectory = realpathSync(os.tmpdir());
+
 /* Remove argument from promisify return */
 const promisify = function_ => () => promisify_(function_)();
 const require = createRequire(import.meta.url);

test/run-context.spec.ts

@@ -8,7 +8,7 @@ import { create as createMemFsEditor } from 'mem-fs-editor';
 import { afterEach, beforeAll, beforeEach, describe, it } from 'vitest';
 import RunContext from '../src/run-context.js';
 import RunResult from '../src/run-result.js';
-import helpers from '../src/helpers.js';
+import helpers from '../src/import.js';
 import testContext, { result } from '../src/test-context.js';
 
 describe('run-result', () => {