yeoman-environment 6.0.1 → 6.2.0

package/bin/bin.cjs

@@ -1,5 +1,4 @@
 #!/usr/bin/env node
 (async function () {
-  // eslint-disable-next-line import-x/extensions
   await import('../dist/cli/index.js');
 })();

package/dist/composed-store.d.ts

@@ -1,5 +1,5 @@
 import type { BaseGenerator, Logger } from '@yeoman/types';
-import type { InstallTask } from './package-manager.ts';
+import type { PackageManagerInstallTaskOptions } from './package-manager.ts';
 export declare class ComposedStore {
     private readonly log?;
     private readonly generators;
@@ -9,15 +9,15 @@ export declare class ComposedStore {
         log?: Logger;
     });
     get customCommitTask(): (() => Promise<void> | void) | undefined;
-    get customInstallTask(): InstallTask | undefined;
+    get customInstallTask(): PackageManagerInstallTaskOptions['customInstallTask'] | undefined;
     getGenerators(): Record<string, BaseGenerator>;
     addGenerator(generator: BaseGenerator): {
-        uniqueBy: any;
-        identifier: any;
+        uniqueBy: string;
+        identifier: string | undefined;
         added: boolean;
         generator: BaseGenerator | undefined;
     } | {
-        identifier: any;
+        identifier: string | undefined;
         added: boolean;
         generator: BaseGenerator;
         uniqueBy?: undefined;

package/dist/composed-store.js

@@ -2,6 +2,9 @@ import crypto from 'node:crypto';
 import { toNamespace } from '@yeoman/namespace';
 import createdLogger from 'debug';
 const debug = createdLogger('yeoman:environment:composed-store');
+const getFeaturesFromGenerator = (generator) => {
+    return generator.features ?? generator.getFeatures?.() ?? {};
+};
 export class ComposedStore {
     log;
     generators = {};
@@ -20,7 +23,7 @@ export class ComposedStore {
         return { ...this.generators };
     }
     addGenerator(generator) {
-        const { features = generator.getFeatures?.() ?? {} } = generator;
+        const features = getFeaturesFromGenerator(generator);
         let { uniqueBy } = features;
         const { uniqueGlobally } = features;
         let identifier = uniqueBy;
@@ -56,8 +59,8 @@ export class ComposedStore {
     findFeature(featureName) {
         return Object.entries(this.generators)
             .map(([generatorId, generator]) => {
-            const { features = generator.getFeatures?.() } = generator;
-            const feature = features?.[featureName];
+            const features = getFeaturesFromGenerator(generator);
+            const feature = features[featureName];
             return feature ? { generatorId, feature: feature } : undefined;
         })
             .filter(Boolean);

package/dist/environment-base.js

@@ -242,13 +242,13 @@ export default class EnvironmentBase extends EventEmitter {
     instantiate(constructor, ...arguments_) {
         const composeOptions = arguments_.length > 0 ? getInstantiateOptions(...arguments_) : {};
         const { namespace = UNKNOWN_NAMESPACE, resolved = UNKNOWN_RESOLVED, _meta } = constructor;
-        const environmentOptions = { env: this, resolved, namespace };
+        const environmentOptions = { env: this, resolved, namespace, _meta };
         const generator = new constructor(composeOptions.generatorArgs ?? [], {
             ...this.sharedOptions,
             ...composeOptions.generatorOptions,
             ...environmentOptions,
         });
-        generator._meta = _meta;
+        generator._meta ??= _meta;
         generator._environmentOptions = {
             ...this.options,
             ...this.sharedOptions,

package/dist/environment-full.d.ts

@@ -62,7 +62,7 @@ declare class FullEnvironment extends EnvironmentBase {
      * @param {string} generatorNamespace
      * @param {string[]} args
      */
-    execute(generatorNamespace: string, arguments_?: never[]): Promise<void>;
+    execute(generatorNamespace: string, arguments_?: string[]): Promise<void>;
     requireGenerator(namespace: string): Promise<BaseGeneratorConstructor | undefined>;
     /**
      * Install generators at the custom local repository and register.

package/dist/environment-full.js

@@ -74,7 +74,7 @@ class FullEnvironment extends EnvironmentBase {
             }
             groups[base].push(namespace);
         }
-        for (const key of Object.keys(groups).sort()) {
+        for (const key of Object.keys(groups).toSorted()) {
             const group = groups[key];
             if (group.length > 0) {
                 out.push('', key.charAt(0).toUpperCase() + key.slice(1));

package/dist/generator-lookup.d.ts

@@ -52,5 +52,13 @@ export declare function lookupGenerators(options?: LookupOptions, register?: (me
 export declare function lookupGenerator(namespace: string, options?: ModuleLookupOptions & {
     packagePath?: boolean;
     generatorPath?: boolean;
-}): string | string[];
+} & {
+    singleResult?: true;
+}): string;
+export declare function lookupGenerator(namespace: string, options?: ModuleLookupOptions & {
+    packagePath?: boolean;
+    generatorPath?: boolean;
+} & {
+    singleResult: false;
+}): string[];
 export {};

package/dist/generator-lookup.js

@@ -39,7 +39,7 @@ export async function lookupGenerators(options = {}, register) {
         ...options,
     };
     return moduleLookupSync(options, ({ packagePath, files }) => {
-        files = [...files].sort((a, b) => {
+        files = [...files].toSorted((a, b) => {
             return defaultExtensions.indexOf(extname(a)) - defaultExtensions.indexOf(extname(b));
         });
         for (const filePath of files) {
@@ -51,18 +51,6 @@ export async function lookupGenerators(options = {}, register) {
         return;
     });
 }
-/**
- * Lookup for a specific generator.
- *
- * @param  {String} namespace
- * @param  {Object} [options]
- * @param {Boolean} [options.localOnly=false] - Set true to skip lookups of
- *                                                     globally-installed generators.
- * @param {Boolean} [options.packagePath=false] - Set true to return the package
- *                                                       path instead of generators file.
- * @param {Boolean} [options.singleResult=true] - Set false to return multiple values.
- * @return {String} generator
- */
 export function lookupGenerator(namespace, options) {
     options = typeof options === 'boolean' ? { localOnly: options } : (options ?? {});
     options.singleResult = options.singleResult ?? true;

package/dist/package-manager.d.ts

@@ -7,7 +7,7 @@ export type PackageManagerInstallTaskOptions = {
     packageJsonLocation: string;
     adapter: InputOutputAdapter;
     nodePackageManager?: string;
-    customInstallTask?: boolean | InstallTask;
+    customInstallTask?: boolean | InstallTask | 'ask';
     skipInstall?: boolean;
 };
 /**

package/dist/package-manager.js

@@ -23,7 +23,10 @@ export async function packageManagerInstallTask({ memFs, packageJsonLocation, cu
      * @return {Vinyl | undefined} a Vinyl file.
      */
     function getDestinationPackageJson() {
-        return memFs.get(join(packageJsonLocation, 'package.json'));
+        const packageJsonFile = join(packageJsonLocation, 'package.json');
+        if (memFs.existsInMemory(packageJsonFile)) {
+            return memFs.get(packageJsonFile);
+        }
     }
     /**
      * @private
@@ -32,12 +35,12 @@ export async function packageManagerInstallTask({ memFs, packageJsonLocation, cu
      */
     function isDestinationPackageJsonCommitted() {
         const file = getDestinationPackageJson();
-        return file.committed;
+        return file?.committed;
     }
     if (!getDestinationPackageJson()) {
         return false;
     }
-    if (customInstallTask && typeof customInstallTask !== 'function') {
+    if (customInstallTask && typeof customInstallTask !== 'function' && customInstallTask !== 'ask') {
         debug('Install disabled by customInstallTask');
         return false;
     }
@@ -68,8 +71,18 @@ Running ${packageManagerName} install for you to install the required dependenci
         await execa(packageManagerName, ['install'], { stdio: 'inherit', cwd: packageJsonLocation });
         return true;
     };
-    if (customInstallTask) {
+    if (typeof customInstallTask === 'function') {
         return customInstallTask(packageManagerName, execPackageManager);
     }
+    if (customInstallTask === 'ask') {
+        const { runInstall } = await adapter.prompt({
+            type: 'confirm',
+            name: 'runInstall',
+            message: `Do you want to run ${packageManagerName} install now?`,
+        });
+        if (!runInstall) {
+            return false;
+        }
+    }
     return execPackageManager();
 }

package/dist/store.d.ts

@@ -8,6 +8,7 @@ import type { BaseEnvironment, BaseGeneratorMeta, GeneratorMeta, GetGeneratorCon
  */
 export default class Store {
     private readonly _meta;
+    private readonly _packagesJson;
     private readonly _packagesPaths;
     private readonly _packagesNS;
     private readonly environment;
@@ -61,6 +62,10 @@ export default class Store {
      * @return {Array} Stored packages namespaces.
      */
     getPackagesNS(): string[];
+    /**
+     * Read a package.json from packagePath. Parsed results are cached by packagePath.
+     */
+    private getPackageJson;
     private getFactory;
     private _getGenerator;
 }

package/dist/store.js

@@ -9,6 +9,7 @@ var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExte
 import { pathToFileURL } from 'node:url';
 import { extname, join } from 'node:path';
 import { createRequire } from 'node:module';
+import { readFileSync } from 'node:fs';
 import { toNamespace } from '@yeoman/namespace';
 import createDebug from 'debug';
 const debug = createDebug('yeoman:environment:store');
@@ -22,6 +23,8 @@ const require = createRequire(import.meta.url);
  */
 export default class Store {
     _meta = {};
+    // Cache parsed package.json by packagePath
+    _packagesJson = new Map();
     // Store packages paths by ns
     _packagesPaths = {};
     // Store packages ns
@@ -117,6 +120,7 @@ export default class Store {
         };
         const instantiate = async (arguments_ = [], options = {}) => this.environment.instantiate(await importGenerator(), { generatorArgs: arguments_, generatorOptions: options });
         const instantiateHelp = async () => instantiate([], { help: true });
+        const getPackageJson = () => this.getPackageJson(meta.packagePath);
         const { packageNamespace } = toNamespace(meta.namespace) ?? {};
         generatorMeta = {
             ...meta,
@@ -124,6 +128,7 @@ export default class Store {
             importModule,
             instantiate,
             instantiateHelp,
+            getPackageJson,
             packageNamespace,
         };
         this._meta[meta.namespace] = generatorMeta;
@@ -211,6 +216,25 @@ export default class Store {
     getPackagesNS() {
         return this._packagesNS;
     }
+    /**
+     * Read a package.json from packagePath. Parsed results are cached by packagePath.
+     */
+    getPackageJson(packagePath) {
+        if (!packagePath) {
+            return undefined;
+        }
+        if (!this._packagesJson.has(packagePath)) {
+            let packageJson;
+            try {
+                packageJson = JSON.parse(readFileSync(join(packagePath, 'package.json'), 'utf8'));
+            }
+            catch {
+                packageJson = undefined;
+            }
+            this._packagesJson.set(packagePath, packageJson);
+        }
+        return this._packagesJson.get(packagePath);
+    }
     getFactory(module) {
         // CJS is imported in default, for backward compatibility we support a Generator exported as `module.exports = { default }`
         return module.createGenerator ?? module.default?.createGenerator ?? module.default?.default?.createGenerator;

package/dist/util/namespace.js

@@ -39,7 +39,7 @@ export const asNamespace = (filepath, { lookups = defaultLookups }) => {
     // Sort lookups by length so biggest are removed first
     const nsLookups = [...lookups, '..']
         .map(found => slash(found))
-        .sort((a, b) => a.split('/').length - b.split('/').length)
+        .toSorted((a, b) => a.split('/').length - b.split('/').length)
         .toReversed();
     // If `ns` contains a lookup dir in its path, remove it.
     for (const lookup of nsLookups) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-environment",
-  "version": "6.0.1",
+  "version": "6.2.0",
   "description": "Handles the lifecyle and bootstrapping of generators in a specific environment",
   "keywords": [
     "development",
@@ -16,7 +16,10 @@
     "app"
   ],
   "homepage": "http://yeoman.io",
-  "repository": "yeoman/environment",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yeoman/environment.git"
+  },
   "license": "BSD-2-Clause",
   "author": "Yeoman",
   "type": "module",
@@ -45,22 +48,18 @@
     "doc:prettier": "prettier $npm_package_config_doc_path --write --ignore-path .prettierignore-doc",
     "fix": "eslint --fix && prettier . --write",
     "prepare": "npm run build",
-    "pretest": "eslint && prettier . --check",
-    "test": "c8 esmocha --forbid-only",
-    "test-base": "c8 esmocha test/environment*.js test/store.js test/util.js test/adapter.js",
-    "test-environment": "c8 esmocha test/environment.js",
-    "test-generators": "c8 esmocha test/generators.js",
-    "test-resolver": "c8 esmocha test/resolver.js"
+    "pretest": "eslint && prettier . --check && tsc -p tsconfig.test.json",
+    "test": "c8 --include 'src/**' esmocha --forbid-only"
   },
   "config": {
     "doc_path": "./yeoman-environment-doc"
   },
   "dependencies": {
     "@yeoman/adapter": "^4.0.2",
-    "@yeoman/conflicter": "^4.0.1",
-    "@yeoman/namespace": "^1.0.1",
-    "@yeoman/transform": "^2.1.0",
-    "@yeoman/types": "^1.10.3",
+    "@yeoman/conflicter": "^4.1.0",
+    "@yeoman/namespace": "^2.1.0",
+    "@yeoman/transform": "^2.1.1",
+    "@yeoman/types": "^1.11.1",
     "arrify": "^3.0.0",
     "chalk": "^5.6.2",
     "commander": "^14.0.3",
@@ -72,7 +71,7 @@
     "locate-path": "^8.0.0",
     "lodash-es": "^4.18.1",
     "mem-fs": "^4.1.4",
-    "mem-fs-editor": "^12.0.3",
+    "mem-fs-editor": "^12.0.4",
     "semver": "^7.7.4",
     "slash": "^5.1.0",
     "untildify": "^6.0.0",
@@ -84,27 +83,17 @@
     "@types/lodash-es": "^4.17.12",
     "@types/node": "^20.19.35",
     "@types/semver": "^7.7.1",
-    "@yeoman/eslint": "1.0.0",
+    "@yeoman/eslint": "1.1.0",
     "c8": "^11.0.0",
-    "eslint": "9.39.3",
+    "eslint": "10.2.1",
     "esmocha": "^5.0.0",
-    "fs-extra": "^11.3.4",
     "jsdoc": "^4.0.5",
-    "prettier": "3.8.1",
+    "prettier": "3.8.3",
     "prettier-plugin-packagejson": "^3.0.2",
     "rimraf": "^6.1.3",
-    "sinon": "^21.1.0",
-    "sinon-test": "^3.1.6",
     "strip-ansi": "^7.2.0",
-    "typescript": "5.9.3",
-    "yeoman-assert": "^3.1.1",
+    "typescript": "6.0.3",
     "yeoman-environment": "file:./",
-    "yeoman-generator-2": "npm:yeoman-generator@^2.0.5",
-    "yeoman-generator-4": "npm:yeoman-generator@^4.13.0",
-    "yeoman-generator-5": "npm:yeoman-generator@^5.10.0",
-    "yeoman-generator-6": "npm:yeoman-generator@^6.0.1",
-    "yeoman-generator-7": "npm:yeoman-generator@^7.5.1",
-    "yeoman-generator-8": "npm:yeoman-generator@^8.0.0-beta.8",
     "yeoman-test": "^11.3.1"
   },
   "peerDependencies": {
@@ -112,75 +101,18 @@
     "@yeoman/types": "^1.10.3",
     "mem-fs": "^4.1.4"
   },
-  "acceptDependencies": {
-    "@yeoman/adapter": ">=4.0.2"
-  },
   "engines": {
     "node": "^20.17.0 || >=22.9.0"
   },
+  "acceptDependencies": {
+    "@yeoman/adapter": ">=4.0.2"
+  },
   "overrides": {
-    "yeoman-generator-2": {
-      "chalk": "^4.1.0",
-      "dargs": "^7.0.0",
-      "debug": "^4.1.1",
-      "execa": "^5.1.1",
-      "github-username": "^6.0.0",
-      "lodash": "^4.17.11",
-      "mem-fs-editor": "^9.0.0",
-      "minimist": "^1.2.5",
-      "pacote": "^15.2.0",
-      "read-pkg-up": "^7.0.1",
-      "run-async": "^2.0.0",
-      "semver": "^7.2.1",
-      "shelljs": "^0.8.5",
-      "sort-keys": "^4.2.0",
-      "text-table": "^0.2.0",
-      "yeoman-environment": "file:./"
-    },
-    "yeoman-generator-4": {
-      "chalk": "^4.1.0",
-      "dargs": "^7.0.0",
-      "debug": "^4.1.1",
-      "execa": "^5.1.1",
-      "github-username": "^6.0.0",
-      "lodash": "^4.17.11",
-      "mem-fs-editor": "^9.0.0",
-      "minimist": "^1.2.5",
-      "pacote": "^15.2.0",
-      "read-pkg-up": "^7.0.1",
-      "run-async": "^2.0.0",
-      "semver": "^7.2.1",
-      "shelljs": "^0.8.5",
-      "sort-keys": "^4.2.0",
-      "text-table": "^0.2.0",
-      "yeoman-environment": "file:./"
-    },
-    "yeoman-generator-5": {
-      "chalk": "^4.1.0",
-      "dargs": "^7.0.0",
-      "debug": "^4.1.1",
-      "execa": "^5.1.1",
-      "github-username": "^6.0.0",
-      "lodash": "^4.17.11",
-      "mem-fs-editor": "^9.0.0",
-      "minimist": "^1.2.5",
-      "pacote": "^15.2.0",
-      "read-pkg-up": "^7.0.1",
-      "run-async": "^2.0.0",
-      "semver": "^7.2.1",
-      "shelljs": "^0.8.5",
-      "sort-keys": "^4.2.0",
-      "text-table": "^0.2.0",
-      "yeoman-environment": "file:./"
-    },
-    "yeoman-generator-6": {
-      "yeoman-environment": "file:./"
-    },
-    "yeoman-generator-7": {
-      "yeoman-environment": "file:./"
-    },
-    "yeoman-generator-8": {
+    "@yeoman-environment/generator-tests": {
       "yeoman-environment": "file:./"
     }
-  }
+  },
+  "workspaces": [
+    "test/generators"
+  ]
 }