yeoman-generator 8.1.1 → 8.2.0

package/dist/actions/help.d.ts

@@ -22,7 +22,20 @@ export declare class HelpMixin {
      *
      * @param description
      */
-    desc(this: BaseGenerator, description: string): BaseGenerator<Record<any, any>, import("../types.js").BaseOptions, import("../types.js").BaseFeatures, Record<any, any>, Record<any, any>, Record<any, any>>;
+    desc(this: BaseGenerator, description: string): BaseGenerator<Record<any, any>, import("../types.js").BaseOptions, {
+        unique?: true | "argument" | "namespace" | undefined;
+        tasksMatchingPriority?: boolean | undefined;
+        taskPrefix?: string | undefined;
+        skipParseOptions?: boolean | undefined;
+        disableInGeneratorOptionsSupport?: boolean | undefined;
+        customPriorities?: import("../types.js").Priority[] | undefined;
+        inheritTasks?: boolean | undefined;
+        configTransform?: import("../types.js").StorageTransform<Record<string, any>> | undefined;
+        uniqueBy?: string | undefined;
+        uniqueGlobally?: boolean | undefined;
+        customCommitTask?: (() => Promise<void> | void) | undefined;
+        customInstallTask?: (boolean | import("@yeoman/types").InstallTask | "ask") | undefined;
+    }, Record<any, any>, Record<any, any>, Record<any, any>>;
     /**
      * Get help text for arguments
      * @returns Text of options in formatted table

package/dist/actions/lifecycle.d.ts

@@ -145,6 +145,19 @@ export declare abstract class TasksMixin {
      */
     queueTransformStream(this: BaseGeneratorImpl, options?: GeneratorPipelineOptions & {
         priorityToQueue?: string;
-    }, ...transforms: Array<FileTransform<MemFsEditorFile>>): BaseGeneratorImpl<Record<any, any>, BaseOptions, import("../types.js").BaseFeatures, Record<any, any>, Record<any, any>, Record<any, any>>;
+    }, ...transforms: Array<FileTransform<MemFsEditorFile>>): BaseGeneratorImpl<Record<any, any>, BaseOptions, {
+        unique?: true | "argument" | "namespace" | undefined;
+        tasksMatchingPriority?: boolean | undefined;
+        taskPrefix?: string | undefined;
+        skipParseOptions?: boolean | undefined;
+        disableInGeneratorOptionsSupport?: boolean | undefined;
+        customPriorities?: Priority[] | undefined;
+        inheritTasks?: boolean | undefined;
+        configTransform?: import("../types.js").StorageTransform<Record<string, any>> | undefined;
+        uniqueBy?: string | undefined;
+        uniqueGlobally?: boolean | undefined;
+        customCommitTask?: (() => Promise<void> | void) | undefined;
+        customInstallTask?: (boolean | import("@yeoman/types").InstallTask | "ask") | undefined;
+    }, Record<any, any>, Record<any, any>, Record<any, any>>;
 }
 export {};

package/dist/index.d.ts

@@ -1,12 +1,16 @@
-import { type SimpleGit } from 'simple-git';
+import { CheckRepoActions, CleanOptions, type SimpleGit, type SimpleGitOptions } from 'simple-git';
 import { BaseGenerator } from './generator.js';
 import type { BaseFeatures, BaseOptions } from './types.js';
 export type * from './types.js';
 export type * from './questions.js';
 export type * from './util/storage.js';
 export { default as Storage } from './util/storage.js';
+type SimpleGitWithConstants = SimpleGit & {
+    CheckRepoActions: typeof CheckRepoActions;
+    CleanOptions: typeof CleanOptions;
+};
 export default class Generator<C extends Record<any, any> = Record<any, any>, O extends BaseOptions = BaseOptions, F extends BaseFeatures = BaseFeatures> extends BaseGenerator<C, O, F> {
-    _simpleGit?: SimpleGit;
-    constructor(...args: any[]);
-    get simpleGit(): SimpleGit;
+    constructor(arguments_?: string[], options?: O, features?: F);
+    get simpleGit(): SimpleGitWithConstants;
+    createSimpleGit(options?: Partial<SimpleGitOptions>): SimpleGitWithConstants;
 }

package/dist/index.js

@@ -1,12 +1,10 @@
 import process from 'node:process';
-import { simpleGit } from 'simple-git';
+import { CheckRepoActions, CleanOptions, simpleGit } from 'simple-git';
 import { BaseGenerator } from './generator.js';
-import { DESTINATION_ROOT_CHANGE_EVENT } from './constants.js';
 export { default as Storage } from './util/storage.js';
 export default class Generator extends BaseGenerator {
-    _simpleGit;
-    constructor(...args) {
-        super(...args);
+    constructor(arguments_, options, features) {
+        super(arguments_, options, features);
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-expect-error
         this._queues = {};
@@ -20,15 +18,17 @@ export default class Generator extends BaseGenerator {
         }
     }
     get simpleGit() {
-        if (!this._simpleGit) {
-            this._simpleGit = simpleGit({ baseDir: this.destinationPath() }).env({
-                ...process.env,
-                LANG: 'en',
-            });
-            this.on(DESTINATION_ROOT_CHANGE_EVENT, () => {
-                this._simpleGit = undefined;
-            });
-        }
-        return this._simpleGit;
+        return this.createSimpleGit();
+    }
+    createSimpleGit(options) {
+        const git = simpleGit({ baseDir: this.destinationPath(), ...options }).env({
+            HOME: process.env.HOME,
+            PATH: process.env.PATH,
+            LANG: 'C',
+            LC_ALL: 'C',
+        });
+        git.CheckRepoActions = CheckRepoActions;
+        git.CleanOptions = CleanOptions;
+        return git;
     }
 }

package/dist/types.d.ts

@@ -7,13 +7,15 @@ import type {
 } from '@yeoman/types';
 import type { PipelineOptions } from 'mem-fs';
 import type { MemFsEditorFile } from 'mem-fs-editor';
-import type { JsonValue } from 'type-fest';
+import type { JsonValue, Merge } from 'type-fest';
 import type Storage from './util/storage.js';
 import type Generator from './index.js';
 
 export type StorageValue = JsonValue;
 export type GeneratorPipelineOptions = PipelineOptions<MemFsEditorFile> & ProgressOptions & { pendingFiles?: boolean };
 
+export type StorageTransform<A extends Record<string, any>> = (content: A, name?: string) => A;
+
 /**
  * Queue options.
  */
@@ -75,40 +77,43 @@ export type Task<TaskContext = any> = TaskOptions & {
   taskName: string;
 };
 
-export type BaseFeatures = FeaturesApi & {
-  /** The Generator instance unique identifier. The Environment will ignore duplicated identifiers. */
-  uniqueBy?: string;
-
-  /** UniqueBy calculation method */
-  unique?: true | 'argument' | 'namespace';
+// Use Merge to override local features by official features from @yeoman/types when they are available.
+export type BaseFeatures = Merge<
+  {
+    /** UniqueBy calculation method */
+    unique?: true | 'argument' | 'namespace';
 
-  /** Only queue methods that matches a priority. */
-  tasksMatchingPriority?: boolean;
+    /** Only queue methods that matches a priority. */
+    tasksMatchingPriority?: boolean;
 
-  /** Tasks methods starts with prefix. Allows api methods (non tasks) without prefix. */
-  taskPrefix?: string;
+    /** Tasks methods starts with prefix. Allows api methods (non tasks) without prefix. */
+    taskPrefix?: string;
 
-  /** Provides a custom install task. Environment built-in task will not be executed */
-  customInstallTask?: boolean | ((...args: any[]) => void | Promise<void>);
+    // Provided by @yeoman/types since v1.11.0
+    /** Provides a custom install task. Environment built-in task will not be executed */
+    customInstallTask?: boolean | ((...args: any[]) => void | Promise<void>);
 
-  /** Provides a custom commit task. */
-  customCommitTask?: boolean | ((...args: any[]) => void | Promise<void>);
+    // Provided by @yeoman/types since v1.11.0
+    /** Provides a custom commit task. */
+    customCommitTask?: boolean | ((...args: any[]) => void | Promise<void>);
 
-  /** Disable args/options parsing. Whenever options/arguments are provided parsed like using commander based parsing. */
-  skipParseOptions?: boolean;
+    /** Disable args/options parsing. Whenever options/arguments are provided parsed like using commander based parsing. */
+    skipParseOptions?: boolean;
 
-  /** Disable args/options support. Whenever options/arguments are provided parsed like using commander based parsing. */
-  disableInGeneratorOptionsSupport?: boolean;
+    /** Disable args/options support. Whenever options/arguments are provided parsed like using commander based parsing. */
+    disableInGeneratorOptionsSupport?: boolean;
 
-  /** Custom priorities for more fine tuned workflows. */
-  customPriorities?: Priority[];
+    /** Custom priorities for more fine tuned workflows. */
+    customPriorities?: Priority[];
 
-  /** Inherit tasks from parent prototypes, implies tasksMatchingPriority */
-  inheritTasks?: boolean;
+    /** Inherit tasks from parent prototypes, implies tasksMatchingPriority */
+    inheritTasks?: boolean;
 
-  /** Transform the configuration before reading. */
-  configTransform?: (config: any) => any;
-};
+    /** Transform the configuration before reading. */
+    configTransform?: StorageTransform<Record<string, any>>;
+  },
+  FeaturesApi
+>;
 
 export type BaseOptions = OptionsApi & {
   destinationRoot?: string;

package/dist/util/storage.d.ts

@@ -1,7 +1,6 @@
 import type { Get } from 'type-fest';
 import type { MemFsEditor } from 'mem-fs-editor';
-import type { StorageValue } from '../types.js';
-type TransformConfig<A extends Record<string, any>> = (content: A, name?: string) => A;
+import type { StorageTransform, StorageValue } from '../types.js';
 export type StorageOptions = {
     name?: string;
     /**
@@ -23,7 +22,7 @@ export type StorageOptions = {
     /**
      * Transform the content of the storage when reading it. This can be used to sanitize or modify the data before it is returned.
      */
-    transform?: TransformConfig<Record<string, any>>;
+    transform?: StorageTransform<Record<string, any>>;
 };
 /**
  * Storage instances handle a json file where Generator authors can store data.
@@ -87,7 +86,9 @@ declare class Storage<StorageRecord extends Record<string, any> = Record<string,
      * @param key  The key under which the value is stored.
      * @return The stored value. Any JSON valid type could be returned
      */
-    get<const Key extends keyof StorageRecord>(key: Key): StorageRecord[Key];
+    get<const Key extends keyof StorageRecord>(key: Key, { raw }?: {
+        raw?: boolean;
+    }): StorageRecord[Key];
     /**
      * Get a stored value from a lodash path
      * @param path  The path under which the value is stored.

package/dist/util/storage.js

@@ -6,7 +6,7 @@ import sortKeys from 'sort-keys';
  */
 const proxyHandler = {
     get(storage, property, _receiver) {
-        return storage.get(property);
+        return storage.get(property, { raw: true });
     },
     set(storage, property, value, _receiver) {
         if (typeof property === 'string') {
@@ -19,7 +19,7 @@ const proxyHandler = {
         return Reflect.ownKeys(storage._store);
     },
     has(storage, prop) {
-        return storage.get(prop) !== undefined;
+        return storage.get(prop, { raw: true }) !== undefined;
     },
     getOwnPropertyDescriptor(storage, key) {
         return {
@@ -171,7 +171,10 @@ class Storage {
      * @param key  The key under which the value is stored.
      * @return The stored value. Any JSON valid type could be returned
      */
-    get(key) {
+    get(key, { raw } = {}) {
+        if (raw) {
+            return this._store[key];
+        }
         return this.transformedStore()[key];
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-generator",
-  "version": "8.1.1",
+  "version": "8.2.0",
   "description": "Rails-inspired generator system that provides scaffolding for your apps",
   "keywords": [
     "development",
@@ -45,53 +45,52 @@
     "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",
+    "pretest": "eslint . && prettier . --check && npm run build && tsc -p tsconfig.spec.json",
     "test": "vitest run --coverage"
   },
   "config": {
     "doc_path": "../yeoman-generator-doc/"
   },
   "dependencies": {
-    "@types/debug": "^4.1.12",
+    "@types/debug": "^4.1.13",
     "@types/lodash-es": "^4.17.12",
-    "@yeoman/namespace": "^1.0.1",
+    "@yeoman/namespace": "^2.1.0",
     "chalk": "^5.6.2",
     "debug": "^4.4.3",
     "execa": "^9.6.1",
     "latest-version": "^9.0.0",
-    "lodash-es": "^4.17.23",
-    "mem-fs-editor": "^12.0.2",
+    "lodash-es": "^4.18.1",
+    "mem-fs-editor": "^12.0.4",
     "minimist": "^1.2.8",
     "read-package-up": "^12.0.0",
     "semver": "^7.7.4",
-    "simple-git": "^3.32.3",
+    "simple-git": "^3.36.0",
     "sort-keys": "^6.0.0",
     "text-table": "^0.2.0",
-    "type-fest": "^5.4.4"
+    "type-fest": "^5.6.0"
   },
   "devDependencies": {
     "@types/ejs": "^3.1.5",
     "@types/minimist": "^1.2.5",
-    "@types/picomatch": "^4.0.2",
+    "@types/node": "^24.12.2",
+    "@types/picomatch": "^4.0.3",
     "@types/semver": "^7.7.1",
-    "@types/sinon": "^21.0.0",
     "@types/text-table": "^0.2.5",
-    "@vitest/coverage-v8": "^4.0.18",
+    "@typescript-eslint/parser": "^8.59.1",
+    "@vitest/coverage-v8": "^4.1.5",
     "@yeoman/adapter": "^4.0.2",
-    "@yeoman/eslint": "1.0.0",
-    "@yeoman/transform": "^2.1.0",
-    "@yeoman/types": "^1.10.3",
+    "@yeoman/eslint": "1.1.0",
+    "@yeoman/transform": "^2.1.1",
+    "@yeoman/types": "^1.11.0",
     "cpy-cli": "^7.0.0",
-    "ejs": "^5.0.1",
-    "eslint": "9.39.3",
+    "ejs": "^5.0.2",
+    "eslint": "10.2.1",
     "jsdoc": "^4.0.5",
-    "prettier": "3.8.1",
-    "prettier-plugin-packagejson": "3.0.0",
-    "sinon": "^21.0.1",
-    "typescript": "5.9.3",
-    "vitest": "^4.0.18",
-    "yeoman-assert": "^3.1.1",
-    "yeoman-environment": "^6.0.0",
+    "prettier": "3.8.3",
+    "prettier-plugin-packagejson": "3.0.2",
+    "typescript": "6.0.3",
+    "vitest": "^4.1.5",
+    "yeoman-environment": "^6.0.1",
     "yeoman-test": "^11.3.1"
   },
   "peerDependencies": {