feat: rework top level await to allow 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.json

@@ -17,6 +17,7 @@
     },
     ".": {
       "types": "./dist/index.d.ts",
+      "import": "./dist/import.js",
       "default": "./dist/index.js"
     }
   },

src/helpers.ts

@@ -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/import.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';

test/helpers.spec.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,8 +33,8 @@ describe('yeoman-test', () => {
     StubGenerator = class extends Generator {};
   });
 
-  it('yeoman-test should allow to be required', () => {
-    createRequire(import.meta.url)('../');
+  it.skipIf(major < 20 || major === 21 || (major == 20 && minor < 12))('yeoman-test should allow to be required', () => {
+    require('../');
   });
 
   describe('.createGenerator()', () => {

test/run-context-environment.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.spec.ts

@@ -10,7 +10,7 @@ import { promisify as promisify_ } from 'node:util';
 import { afterEach, beforeAll, beforeEach, describe, expect, it } from 'vitest';
 import Generator from 'yeoman-generator';
 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());

test/run-result.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', () => {