feat: replace setContextData with improved getContextData api (#1643)

Author: mshima

src/generator.ts

@@ -824,7 +824,10 @@ export class BaseGenerator<O extends BaseOptions = BaseOptions, F extends BaseFe
    * Get a value from the context map.
    * Fallback to factory function if the value is not set.
    */
-  getContextData<const T = any>(context: string | { context: string; key: string }, factory?: () => T): T {
+  getContextData<const T = any>(
+    context: string | { context: string; key: string },
+    opts: { override?: T } | { factory?: () => T } = {},
+  ): T {
     if (!('getContextMap' in this.env)) {
       throw new Error('getContextMap is not implemented in the environment');
     }
@@ -833,40 +836,24 @@ export class BaseGenerator<O extends BaseOptions = BaseOptions, F extends BaseFe
     const map: Map<string, any> =
       typeof context === 'object' ? (this.env as any).getContextMap(context.context) : this._contextMap;
 
+    const value = map.get(key);
+    if ('override' in opts) {
+      map.set(key, opts.override);
+      return value;
+    }
+
     if (map.has(key)) {
-      return map.get(key);
+      return value;
     }
 
-    if (factory) {
-      const value = factory();
+    if ('factory' in opts && opts.factory) {
+      const value = opts.factory();
       map.set(key, value);
       return value;
     }
 
     throw new Error(`Context data ${key} not found and no factory provided`);
   }
-
-  /**
-   * @experimental
-   * Set a value to the context map.
-   * Returns the old value.
-   *
-   * @example
-   * const oldValue = this.setContextData('runOnce', true); // returns undefined
-   */
-  setContextData<const T = any>(context: string | { context: string; key: string }, value: T): T | undefined {
-    if (!('getContextMap' in this.env)) {
-      throw new Error('getContextMap is not implemented in the environment');
-    }
-
-    const key = typeof context === 'string' ? context : context.key;
-    const map: Map<string, any> =
-      typeof context === 'object' ? (this.env as any).getContextMap(context.context) : this._contextMap;
-
-    const oldValue = map.get(key);
-    map.set(key, value);
-    return oldValue;
-  }
 }
 
 // eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging

test/generators.test.ts

@@ -136,7 +136,7 @@ describe('Generators module', () => {
     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(generator.getContextData('foo', { factory })).toBe(data);
       expect(factory).toHaveBeenCalled();
     });
 
@@ -151,34 +151,24 @@ describe('Generators module', () => {
       const key = 'foo';
       const data = 'bar';
       const factory: () => string = vitest.fn().mockReturnValue(data);
-      expect(generator.getContextData({ context, key }, factory)).toBe(data);
+      expect(generator.getContextData({ context, key }, { factory })).toBe(data);
       expect(factory).toHaveBeenCalled();
       expect(env.getContextMap(context).get(key)).toBe(data);
     });
-  });
-
-  describe('#setContextData', () => {
-    beforeEach(() => {
-      generator = new Base({
-        env: env,
-        resolved: 'test',
-        localConfigOnly: true,
-      });
-    });
 
-    it('sets new data and retrieves old data', () => {
+    it('using overrides option sets new data and retrieves old data', () => {
       const key = 'foo';
       const data = 'bar';
-      expect(generator.setContextData(key, data)).toBe(undefined);
-      expect(generator.setContextData(key, 'new')).toBe(data);
+      expect(generator.getContextData(key, { override: data })).toBe(undefined);
+      expect(generator.getContextData(key, { override: 'new' })).toBe(data);
     });
 
-    it('supports custon context', () => {
+    it('supports overrides option with custon context', () => {
       const context = 'ctx';
       const key = 'foo';
       const data = 'bar';
-      expect(generator.setContextData({ context, key }, data)).toBe(undefined);
-      expect(generator.setContextData({ context, key }, 'new')).toBe(data);
+      expect(generator.getContextData({ context, key }, { override: data })).toBe(undefined);
+      expect(generator.getContextData({ context, key }, { override: 'new' })).toBe(data);
       expect(env.getContextMap(context).get(key)).toBe('new');
     });
   });