feat: add getContextData (#1630)

Author: mshima

package.json

@@ -43,6 +43,7 @@
     "doc:fix": "sed -i -e 's:^[[:space:]]*<!--[[:space:]]*$::g' -e 's:^[[:space:]]*-->[[:space:]]*$::g' $npm_package_config_doc_path$DOC_FOLDER/global.html || true",
     "doc:generate": "jsdoc -c jsdoc.json -d $npm_package_config_doc_path$DOC_FOLDER",
     "doc:prettier": "prettier $npm_package_config_doc_path$DOC_FOLDER --write --ignore-path .prettierignore-doc",
+    "fix": "eslint . --fix && prettier . --write",
     "prepare": "npm run build",
     "pretest": "eslint . && prettier . --check && npm run build",
     "test": "vitest run --coverage"

src/generator.ts

@@ -65,6 +65,7 @@ export class BaseGenerator<O extends BaseOptions = BaseOptions, F extends BaseFe
   /** @deprecated */
   arguments!: string[];
   _destinationRoot!: string;
+  _contextMap?: Map<string, any>;
   _sourceRoot!: string;
 
   generatorConfig?: Storage;
@@ -744,6 +745,9 @@ export class BaseGenerator<O extends BaseOptions = BaseOptions, F extends BaseFe
   destinationRoot(rootPath?: string) {
     if (typeof rootPath === 'string') {
       this._destinationRoot = pathResolve(rootPath);
+      if ('getContextMap' in this.env) {
+        this._contextMap = (this.env as any).getContextMap(this._destinationRoot);
+      }
 
       if (!fs.existsSync(this._destinationRoot)) {
         fs.mkdirSync(this._destinationRoot, { recursive: true });
@@ -814,6 +818,24 @@ export class BaseGenerator<O extends BaseOptions = BaseOptions, F extends BaseFe
     const appName: string = this.packageJson.get('name') ?? path.basename(this.destinationRoot());
     return appName.replaceAll(/[^\s\w]+?/g, ' ');
   }
+
+  getContextData<const T = any>(key: string, factory?: () => T): T {
+    if (!this._contextMap) {
+      throw new Error('getContextMap is not implemented in the environment');
+    }
+
+    if (this._contextMap.has(key)) {
+      return this._contextMap.get(key);
+    }
+
+    if (factory) {
+      const value = factory();
+      this._contextMap.set(key, value);
+      return value;
+    }
+
+    throw new Error(`Context data ${key} not found and no factory provided`);
+  }
 }
 
 // eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging

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 'vitest';
+import { beforeEach, describe, expect, it, vitest } from 'vitest';
 import { TestAdapter } from '@yeoman/adapter/testing';
 import Environment from 'yeoman-environment';
 import assert from 'yeoman-assert';
@@ -120,6 +120,33 @@ describe('Generators module', () => {
     });
   });
 
+  describe('#getContextData', () => {
+    beforeEach(() => {
+      generator = new Base({
+        env: env,
+        resolved: 'test',
+        localConfigOnly: true,
+      });
+    });
+
+    it('non existing key should throw', () => {
+      expect(() => generator.getContextData('foo')).toThrow('Context data foo not found and no factory provided');
+    });
+
+    it('non existing key should use factory if provided', () => {
+      const data = 'bar';
+      const factory: () => string = vitest.fn().mockReturnValue(data);
+      expect(generator.getContextData('foo', factory)).toBe(data);
+      expect(factory).toHaveBeenCalled();
+    });
+
+    it('retrieves the data', () => {
+      const data = 'bar';
+      generator._contextMap.set('foo', data);
+      expect(generator.getContextData('foo')).toBe(data);
+    });
+  });
+
   it('running standalone', () =>
     new Promise(done => {
       const Generator = class extends Base {};