yeoman-environment 6.1.0 → 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/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/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

@@ -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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-environment",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "Handles the lifecyle and bootstrapping of generators in a specific environment",
   "keywords": [
     "development",
@@ -48,12 +48,8 @@
     "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"
@@ -63,7 +59,7 @@
     "@yeoman/conflicter": "^4.1.0",
     "@yeoman/namespace": "^2.1.0",
     "@yeoman/transform": "^2.1.1",
-    "@yeoman/types": "^1.11.0",
+    "@yeoman/types": "^1.11.1",
     "arrify": "^3.0.0",
     "chalk": "^5.6.2",
     "commander": "^14.0.3",
@@ -91,23 +87,13 @@
     "c8": "^11.0.0",
     "eslint": "10.2.1",
     "esmocha": "^5.0.0",
-    "fs-extra": "^11.3.4",
     "jsdoc": "^4.0.5",
     "prettier": "3.8.3",
     "prettier-plugin-packagejson": "^3.0.2",
     "rimraf": "^6.1.3",
-    "sinon": "^21.1.2",
-    "sinon-test": "^3.1.6",
     "strip-ansi": "^7.2.0",
     "typescript": "6.0.3",
-    "yeoman-assert": "^3.1.1",
     "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": {
@@ -115,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"
+  ]
 }