yeoman-generator 8.0.2 → 8.1.0

package/dist/generator.js

@@ -97,6 +97,7 @@ export class BaseGenerator extends EventEmitter {
         else if (typeof args === 'object' && !Array.isArray(args)) {
             actualArgs = [];
             actualOptions = args;
+            actualFeatures = options;
         }
         else {
             actualArgs = args ?? [];
@@ -611,7 +612,11 @@ export class BaseGenerator extends EventEmitter {
             options = rootName;
             rootName = this.rootGeneratorName();
         }
-        return this.createStorage('.yo-rc.json', { ...options, name: rootName });
+        return this.createStorage('.yo-rc.json', {
+            transform: this.#features.configTransform,
+            ...options,
+            name: rootName,
+        });
     }
     /**
      * Setup a globalConfig storage instance.
@@ -622,7 +627,7 @@ export class BaseGenerator extends EventEmitter {
         const globalStorageDir = this.options.localConfigOnly ? this.destinationRoot() : os.homedir();
         const storePath = path.join(globalStorageDir, '.yo-rc-global.json');
         const storeName = `${this.rootGeneratorName()}:${this.rootGeneratorVersion()}`;
-        return this.createStorage(storePath, { name: storeName });
+        return this.createStorage(storePath, { transform: this.#features.configTransform, name: storeName });
     }
     /**
      * Change the generator destination root directory.

package/dist/types.d.ts

@@ -105,6 +105,9 @@ export type BaseFeatures = FeaturesApi & {
 
   /** Inherit tasks from parent prototypes, implies tasksMatchingPriority */
   inheritTasks?: boolean;
+
+  /** Transform the configuration before reading. */
+  configTransform?: (config: any) => any;
 };
 
 export type BaseOptions = OptionsApi & {
@@ -167,7 +170,7 @@ export type CliOptionSpec = {
   hide?: boolean;
 
   /** The storage to persist the option */
-  storage?: string | Storage;
+  storage?: string | Storage<any>;
 };
 
 export type ComposeOptions<G extends BaseGenerator = BaseGenerator> = EnvironmentComposeOptions<G> & {

package/dist/util/prompt-suggestion.d.ts

@@ -7,7 +7,7 @@ import type Storage from './storage.js';
  * @param questions Original prompt questions
  * @return Prompt questions array with prefilled values.
  */
-export declare const prefillQuestions: <A extends PromptAnswers = PromptAnswers>(store: Storage, questions: Array<PromptQuestion<A>> | PromptQuestion<A>) => PromptQuestion<A>[];
+export declare const prefillQuestions: <A extends PromptAnswers = PromptAnswers>(store: Storage<any>, questions: Array<PromptQuestion<A>> | PromptQuestion<A>) => PromptQuestion<A>[];
 /**
  * Store the answers in the global store
  *
@@ -16,4 +16,4 @@ export declare const prefillQuestions: <A extends PromptAnswers = PromptAnswers>
  * @param answers   The inquirer answers
  * @param storeAll  Should store default values
  */
-export declare const storeAnswers: (store: Storage, questions: any, answers: PromptAnswers, storeAll: boolean) => void;
+export declare const storeAnswers: (store: Storage<any>, questions: any, answers: PromptAnswers, storeAll: boolean) => void;

package/dist/util/storage.d.ts

@@ -1,7 +1,7 @@
 import type { Get } from 'type-fest';
 import type { MemFsEditor } from 'mem-fs-editor';
 import type { StorageValue } from '../types.js';
-export type StorageOptions = {
+export type StorageOptions<StorageRecord extends Record<string, any> = Record<string, any>> = {
     name?: string;
     /**
      * Set true to treat name as a lodash path.
@@ -19,6 +19,10 @@ export type StorageOptions = {
      * Set true to write sorted json.
      */
     sorted?: boolean;
+    /**
+     * Transform the content of the storage when reading it. This can be used to sanitize or modify the data before it is returned.
+     */
+    transform?: (content: StorageRecord) => StorageRecord;
 };
 /**
  * Storage instances handle a json file where Generator authors can store data.
@@ -46,10 +50,11 @@ declare class Storage<StorageRecord extends Record<string, any> = Record<string,
     disableCache: boolean;
     disableCacheByFile: boolean;
     sorted: boolean;
+    transform?: (content: StorageRecord) => StorageRecord;
     existed: boolean;
     _cachedStore?: StorageRecord;
-    constructor(name: string | undefined, fs: MemFsEditor, configPath: string, options?: StorageOptions);
-    constructor(fs: MemFsEditor, configPath: string, options?: StorageOptions);
+    constructor(name: string | undefined, fs: MemFsEditor, configPath: string, options?: StorageOptions<StorageRecord>);
+    constructor(fs: MemFsEditor, configPath: string, options?: StorageOptions<StorageRecord>);
     /**
      * @protected
      * @return the store content
@@ -138,5 +143,6 @@ declare class Storage<StorageRecord extends Record<string, any> = Record<string,
      * @return proxy.
      */
     createProxy(): StorageRecord;
+    private transformedStore;
 }
 export default Storage;

package/dist/util/storage.js

@@ -55,6 +55,7 @@ class Storage {
     disableCache;
     disableCacheByFile;
     sorted;
+    transform;
     existed;
     _cachedStore;
     constructor(name, fs, configPath, options = {}) {
@@ -92,6 +93,7 @@ class Storage {
         this.disableCache = actualOptions.disableCache ?? false;
         this.disableCacheByFile = actualOptions.disableCacheByFile ?? false;
         this.sorted = actualOptions.sorted ?? false;
+        this.transform = actualOptions.transform;
         this.existed = Object.keys(this._store).length > 0;
         this.fs.store.on('change', filename => {
             // At mem-fs 1.1.3 filename is not passed to the event.
@@ -170,7 +172,7 @@ class Storage {
      * @return The stored value. Any JSON valid type could be returned
      */
     get(key) {
-        return this._store[key];
+        return this.transformedStore()[key];
     }
     /**
      * Get a stored value from a lodash path
@@ -178,14 +180,14 @@ class Storage {
      * @return The stored value. Any JSON valid type could be returned
      */
     getPath(path) {
-        return get(this._store, path);
+        return get(this.transformedStore(), path);
     }
     /**
      * Get all the stored values
      * @return key-value object
      */
     getAll() {
-        return cloneDeep(this._store);
+        return this.transformedStore({ forceClone: true });
     }
     set(key, value) {
         const store = this._store;
@@ -249,7 +251,7 @@ class Storage {
     }
     createStorage(path) {
         const childName = this.name ? `${this.name}.${path}` : path;
-        return new Storage(childName, this.fs, this.path, { lodashPath: true });
+        return new Storage(childName, this.fs, this.path, { lodashPath: true, transform: this.transform });
     }
     /**
      * Creates a proxy object.
@@ -258,5 +260,14 @@ class Storage {
     createProxy() {
         return new Proxy(this, proxyHandler);
     }
+    transformedStore({ forceClone = false } = {}) {
+        if (this.transform) {
+            return this.transform(cloneDeep(this._store));
+        }
+        if (forceClone) {
+            return cloneDeep(this._store);
+        }
+        return this._store;
+    }
 }
 export default Storage;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-generator",
-  "version": "8.0.2",
+  "version": "8.1.0",
   "description": "Rails-inspired generator system that provides scaffolding for your apps",
   "keywords": [
     "development",
@@ -82,7 +82,7 @@
     "@yeoman/transform": "^2.1.0",
     "@yeoman/types": "^1.10.3",
     "cpy-cli": "^7.0.0",
-    "ejs": "^4.0.1",
+    "ejs": "^5.0.1",
     "eslint": "9.39.3",
     "jsdoc": "^4.0.5",
     "prettier": "3.8.1",