yeoman-environment 4.0.0-alpha.7 → 4.0.0-beta.0

package/dist/cli/index.js

@@ -22,8 +22,7 @@ program
     .description('Find installed generators')
     .action(async () => {
     const env = createEnv();
-    const generators = await env.lookup();
-    printGroupedGenerator(generators);
+    printGroupedGenerator(await env.lookup());
 });
 program
     .command('list')

package/dist/cli/utils.d.ts

@@ -1,8 +1,10 @@
-export declare const printGroupedGenerator: (generators: any) => void;
+import type { BaseGeneratorMeta } from '@yeoman/types';
+import type YeomanCommand from '../util/command.js';
+export declare const printGroupedGenerator: (generators: BaseGeneratorMeta[]) => void;
 /**
  * @param {string} generatorNamespace
  * @param {*} options
  * @param {*} command
  * @returns
  */
-export declare const environmentAction: (this: any, generatorNamespace: string, options: any, command: any) => Promise<any>;
+export declare const environmentAction: (this: YeomanCommand, generatorNamespace: string, options: any, command: any) => Promise<void>;

package/dist/cli/utils.js

@@ -27,7 +27,8 @@ export const environmentAction = async function (generatorNamespace, options, co
     if (!generatorNamespace) {
         return;
     }
-    this.env = createEnv({ ...options, command: this });
-    await this.env.lookupLocalPackages();
-    return this.env.execute(generatorNamespace, command.args.splice(1));
+    const env = createEnv({ ...options, command: this });
+    this.env = env;
+    await env.lookupLocalPackages();
+    return env.execute(generatorNamespace, command.args.splice(1));
 };

package/dist/commit.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" resolution-mode="require"/>
-import type { PassThrough } from 'node:stream';
+import type { PipelineSource } from 'node:stream';
 import type { InputOutputAdapter } from '@yeoman/types';
 import { type ConflicterOptions } from '@yeoman/conflicter';
 import type { Store } from 'mem-fs';
@@ -13,5 +13,5 @@ export declare const commitSharedFsTask: ({ adapter, conflicterOptions, sharedFs
     adapter: InputOutputAdapter;
     conflicterOptions?: ConflicterOptions | undefined;
     sharedFs: Store<MemFsEditorFile>;
-    stream?: PassThrough | undefined;
+    stream?: PipelineSource<any> | undefined;
 }) => any;

package/dist/environment-base.d.ts

@@ -1,13 +1,12 @@
 /// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
 import EventEmitter from 'node:events';
-import { type Transform } from 'node:stream';
 import { QueuedAdapter, type TerminalAdapterOptions } from '@yeoman/adapter';
 import type { ApplyTransformsOptions, BaseEnvironment, BaseEnvironmentOptions, BaseGenerator, BaseGeneratorConstructor, BaseGeneratorMeta, ComposeOptions, GeneratorMeta, GetGeneratorConstructor, InputOutputAdapter, InstantiateOptions, LookupGeneratorMeta } from '@yeoman/types';
 import { type Store as MemFs } from 'mem-fs';
 import { type MemFsEditor, type MemFsEditorFile } from 'mem-fs-editor';
 import { FlyRepository } from 'fly-import';
 import GroupedQueue from 'grouped-queue';
+import { type FilePipelineTransform } from '@yeoman/transform';
 import { type YeomanNamespace } from '@yeoman/namespace';
 import { type ConflicterOptions } from '@yeoman/conflicter';
 import { ComposedStore } from './composed-store.js';
@@ -22,6 +21,12 @@ export type EnvironmentOptions = BaseEnvironmentOptions & Omit<TerminalAdapterOp
     arboristRegistry?: string;
     nodePackageManager?: string;
 };
+/**
+ * Copy and remove null and undefined values
+ * @param object
+ * @returns
+ */
+export declare function removePropertiesWithNullishValues(object: Record<string, any>): Record<string, any>;
 export default class EnvironmentBase extends EventEmitter implements BaseEnvironment {
     cwd: string;
     adapter: QueuedAdapter;
@@ -45,7 +50,7 @@ export default class EnvironmentBase extends EventEmitter implements BaseEnviron
     protected _rootGenerator?: BaseGenerator;
     protected compatibilityMode?: false | 'v4';
     constructor(options?: EnvironmentOptions);
-    applyTransforms(transformStreams: Transform[], options?: ApplyTransformsOptions): Promise<void>;
+    applyTransforms(transformStreams: FilePipelineTransform[], options?: ApplyTransformsOptions): Promise<void>;
     /**
      * Get a single generator from the registered list of generators. The lookup is
      * based on generator's namespace, "walking up" the namespaces until a matching
@@ -130,11 +135,6 @@ export default class EnvironmentBase extends EventEmitter implements BaseEnviron
      */
     rootGenerator<G extends BaseGenerator = BaseGenerator>(): G;
     runGenerator(generator: BaseGenerator): Promise<void>;
-    /**
-     * Start Environment queue
-     * @param {Object} options - Conflicter options.
-     */
-    start(options: any): Promise<void>;
     /**
      * Registers a specific `generator` to this environment. This generator is stored under
      * provided namespace, or a default namespace format if none if available.
@@ -227,6 +227,11 @@ export default class EnvironmentBase extends EventEmitter implements BaseEnviron
      */
     alias(match: string | RegExp, value: string): this;
     alias(value: string): string;
+    /**
+     * Start Environment queue
+     * @param {Object} options - Conflicter options.
+     */
+    protected start(options: any): Promise<void>;
     /**
      * Queue environment's commit task.
      */

package/dist/environment-base.js

@@ -12,7 +12,7 @@ import createdLogger from 'debug';
 import GroupedQueue from 'grouped-queue';
 // eslint-disable-next-line n/file-extension-in-import
 import { isFilePending } from 'mem-fs-editor/state';
-import { passthrough, pipeline } from '@yeoman/transform';
+import { transform, filePipeline } from '@yeoman/transform';
 import { toNamespace } from '@yeoman/namespace';
 import chalk from 'chalk';
 import { defaults, pick } from 'lodash-es';
@@ -75,8 +75,16 @@ const getComposeOptions = (...varargs) => {
     if (typeof composeOptions === 'boolean') {
         return { generatorArgs, generatorOptions, schedule: composeOptions };
     }
-    return composeOptions;
+    return {};
 };
+/**
+ * Copy and remove null and undefined values
+ * @param object
+ * @returns
+ */
+export function removePropertiesWithNullishValues(object) {
+    return Object.fromEntries(Object.entries(object).filter(([_key, value]) => value !== undefined && value !== null));
+}
 export default class EnvironmentBase extends EventEmitter {
     cwd;
     adapter;
@@ -99,7 +107,7 @@ export default class EnvironmentBase extends EventEmitter {
     constructor(options = {}) {
         super();
         this.setMaxListeners(100);
-        const { cwd = process.cwd(), logCwd = cwd, sharedFs = createMemFs(), command, yeomanRepository, arboristRegistry, sharedOptions = {}, experimental, console, stdin, stderr, stdout, adapter = new QueuedAdapter({ console, stdin, stdout, stderr }), ...remainingOptions } = options;
+        const { cwd = process.cwd(), logCwd = cwd, sharedFs = createMemFs(), command, yeomanRepository, arboristRegistry, sharedOptions = {}, experimental, console: adapterConsole, stdin, stderr, stdout, adapter = new QueuedAdapter({ console: adapterConsole, stdin, stdout, stderr }), ...remainingOptions } = options;
         this.options = remainingOptions;
         this.adapter = adapter;
         this.cwd = resolve(cwd);
@@ -136,9 +144,13 @@ export default class EnvironmentBase extends EventEmitter {
             transformStreams = [transformStreams];
         }
         await this.adapter.progress(async ({ step }) => {
-            await pipeline(stream, ...transformStreams, passthrough(file => {
-                step('Completed', relative(this.logCwd, file.path));
-            }));
+            await filePipeline(stream, [
+                ...transformStreams,
+                transform(file => {
+                    step('Completed', relative(this.logCwd, file.path));
+                    return undefined;
+                }),
+            ]);
         }, { name, disabled: !(options?.log ?? true) });
     }
     /**
@@ -180,16 +192,6 @@ export default class EnvironmentBase extends EventEmitter {
     async create(namespaceOrPath, ...args) {
         let constructor;
         const namespace = typeof namespaceOrPath === 'string' ? toNamespace(namespaceOrPath) : undefined;
-        if (typeof namespaceOrPath === 'string') {
-            constructor = await this.get(namespaceOrPath);
-            if (namespace && !constructor) {
-                // Await this.lookupLocalNamespaces(namespace);
-                // constructor = await this.get(namespace);
-            }
-        }
-        else {
-            constructor = namespaceOrPath;
-        }
         const checkGenerator = (Generator) => {
             const generatorNamespace = Generator?.namespace;
             if (namespace && generatorNamespace !== namespace.namespace && generatorNamespace !== UNKNOWN_NAMESPACE) {
@@ -227,6 +229,19 @@ export default class EnvironmentBase extends EventEmitter {
             }
             return Generator;
         };
+        if (typeof namespaceOrPath !== 'string') {
+            return this.instantiate(checkGenerator(namespaceOrPath), ...args);
+        }
+        if (typeof namespaceOrPath === 'string') {
+            constructor = await this.get(namespaceOrPath);
+            if (namespace && !constructor) {
+                // Await this.lookupLocalNamespaces(namespace);
+                // constructor = await this.get(namespace);
+            }
+        }
+        else {
+            constructor = namespaceOrPath;
+        }
         return this.instantiate(checkGenerator(constructor), ...args);
     }
     async instantiate(constructor, ...args) {
@@ -339,56 +354,6 @@ export default class EnvironmentBase extends EventEmitter {
         this._rootGenerator = this._rootGenerator ?? generator;
         return this.start(generator.options);
     }
-    /**
-     * Start Environment queue
-     * @param {Object} options - Conflicter options.
-     */
-    async start(options) {
-        return new Promise((resolve, reject) => {
-            this.conflicterOptions = pick(defaults({}, this.options, options), ['force', 'bail', 'ignoreWhitespace', 'dryRun', 'skipYoResolve']);
-            this.conflicterOptions.cwd = this.logCwd;
-            this.queueCommit();
-            this.queuePackageManagerInstall();
-            /*
-             * Listen to errors and reject if emmited.
-             * Some cases the generator relied at the behavior that the running process
-             * would be killed if an error is thrown to environment.
-             * Make sure to not rely on that behavior.
-             */
-            this.on('error', error => {
-                reject(error);
-                this.adapter.close();
-            });
-            this.once('end', () => {
-                resolve();
-                this.adapter.close();
-            });
-            /*
-             * For backward compatibility
-             */
-            this.on('generator:reject', error => {
-                this.emit('error', error);
-            });
-            /*
-             * For backward compatibility
-             */
-            this.on('generator:resolve', () => {
-                this.emit('end');
-            });
-            this.runLoop.on('error', (error) => {
-                this.emit('error', error);
-            });
-            this.runLoop.on('paused', () => {
-                this.emit('paused');
-            });
-            /* If runLoop has ended, the environment has ended too. */
-            this.runLoop.once('end', () => {
-                this.emit('end');
-            });
-            this.emit('run');
-            this.runLoop.start();
-        });
-    }
     register(pathOrStub, meta, ...args) {
         if (typeof pathOrStub === 'string') {
             if (typeof meta === 'object') {
@@ -458,13 +423,13 @@ export default class EnvironmentBase extends EventEmitter {
         };
         const generators = [];
         await lookupGenerators(options, ({ packagePath, filePath, lookups }) => {
+            let repositoryPath = join(packagePath, '..');
+            if (basename(repositoryPath).startsWith('@')) {
+                // Scoped package
+                repositoryPath = join(repositoryPath, '..');
+            }
+            let namespace = asNamespace(relative(repositoryPath, filePath), { lookups });
             try {
-                let repositoryPath = join(packagePath, '..');
-                if (basename(repositoryPath).startsWith('@')) {
-                    // Scoped package
-                    repositoryPath = join(repositoryPath, '..');
-                }
-                let namespace = asNamespace(relative(repositoryPath, filePath), { lookups });
                 const resolved = realpathSync(filePath);
                 if (!namespace) {
                     namespace = asNamespace(resolved, { lookups });
@@ -472,12 +437,10 @@ export default class EnvironmentBase extends EventEmitter {
                 if (registerToScope && !namespace.startsWith('@')) {
                     namespace = `@${registerToScope}/${namespace}`;
                 }
-                this.store.add({ namespace, packagePath, resolved });
-                const meta = this.getGeneratorMeta(namespace);
+                const meta = this.store.add({ namespace, packagePath, resolved });
                 if (meta) {
                     generators.push({
                         ...meta,
-                        generatorPath: meta.resolved,
                         registered: true,
                     });
                     return Boolean(options?.singleResult);
@@ -487,8 +450,8 @@ export default class EnvironmentBase extends EventEmitter {
                 console.error('Unable to register %s (Error: %s)', filePath, error);
             }
             generators.push({
-                generatorPath: filePath,
                 resolved: filePath,
+                namespace,
                 packagePath,
                 registered: false,
             });
@@ -545,6 +508,59 @@ export default class EnvironmentBase extends EventEmitter {
             return resolved.replace(alias.match, alias.value);
         }, match);
     }
+    /**
+     * Start Environment queue
+     * @param {Object} options - Conflicter options.
+     */
+    async start(options) {
+        return new Promise((resolve, reject) => {
+            Object.assign(this.options, removePropertiesWithNullishValues(pick(options, ['skipInstall', 'nodePackageManager'])));
+            this.logCwd = options.logCwd ?? this.logCwd;
+            this.conflicterOptions = pick(defaults({}, this.options, options), ['force', 'bail', 'ignoreWhitespace', 'dryRun', 'skipYoResolve']);
+            this.conflicterOptions.cwd = this.logCwd;
+            this.queueCommit();
+            this.queuePackageManagerInstall();
+            /*
+             * Listen to errors and reject if emmited.
+             * Some cases the generator relied at the behavior that the running process
+             * would be killed if an error is thrown to environment.
+             * Make sure to not rely on that behavior.
+             */
+            this.on('error', error => {
+                reject(error);
+                this.runLoop.pause();
+                this.adapter.close();
+            });
+            this.once('end', () => {
+                resolve();
+                this.adapter.close();
+            });
+            /*
+             * For backward compatibility
+             */
+            this.on('generator:reject', error => {
+                this.emit('error', error);
+            });
+            /*
+             * For backward compatibility
+             */
+            this.on('generator:resolve', () => {
+                this.emit('end');
+            });
+            this.runLoop.on('error', (error) => {
+                this.emit('error', error);
+            });
+            this.runLoop.on('paused', () => {
+                this.emit('paused');
+            });
+            /* If runLoop has ended, the environment has ended too. */
+            this.runLoop.once('end', () => {
+                this.emit('end');
+            });
+            this.emit('run');
+            this.runLoop.start();
+        });
+    }
     /**
      * Queue environment's commit task.
      */

package/dist/store.d.ts

@@ -17,7 +17,7 @@ export default class Store {
      * @param meta
      * @param generator - A generator module or a module path
      */
-    add(meta: BaseGeneratorMeta, Generator?: unknown): GeneratorMeta;
+    add<M extends BaseGeneratorMeta>(meta: M, Generator?: unknown): GeneratorMeta & M;
     /**
      * Get the module registered under the given namespace
      * @param  {String} namespace

package/dist/store.js

@@ -1,8 +1,10 @@
 import { pathToFileURL } from 'node:url';
 import { extname, join } from 'node:path';
+import { createRequire } from 'node:module';
 import { toNamespace } from '@yeoman/namespace';
 import createDebug from 'debug';
 const debug = createDebug('yeoman:environment:store');
+const require = createRequire(import.meta.url);
 /**
  * The Generator store
  * This is used to store generator (npm packages) reference and instantiate them when
@@ -28,7 +30,19 @@ export default class Store {
      */
     add(meta, Generator) {
         if (typeof meta.resolved === 'string') {
-            meta.resolved = extname(meta.resolved) ? join(meta.resolved) : join(meta.resolved, 'index.js');
+            if (extname(meta.resolved)) {
+                meta.resolved = join(meta.resolved);
+            }
+            else {
+                try {
+                    // Resolve if meta.resolved is a package path.
+                    meta.resolved = require.resolve(meta.resolved);
+                }
+                catch {
+                    // Import must be a file, append index.js to directories
+                    meta.resolved = join(meta.resolved, 'index.js');
+                }
+            }
         }
         if (meta.packagePath) {
             meta.packagePath = join(meta.packagePath);

package/dist/util/namespace.js

@@ -1,7 +1,6 @@
 import { parse } from 'node:path';
 import slash from 'slash';
-import { findLast } from 'lodash-es';
-import escapeStringRegexp from 'escape-string-regexp';
+import { findLast, escapeRegExp } from 'lodash-es';
 export const defaultLookups = ['.', 'generators', 'lib/generators', 'dist/generators'];
 /**
  * Given a String `filepath`, tries to figure out the relative namespace.
@@ -45,7 +44,7 @@ export const asNamespace = (filepath, { lookups = defaultLookups }) => {
     // If `ns` contains a lookup dir in its path, remove it.
     for (const lookup of nsLookups) {
         // Only match full directory (begin with leading slash or start of input, end with trailing slash)
-        ns = ns.replace(new RegExp(`(?:/|^)${escapeStringRegexp(lookup)}(?=/)`, 'g'), '');
+        ns = ns.replace(new RegExp(`(?:/|^)${escapeRegExp(lookup)}(?=/)`, 'g'), '');
     }
     const folders = ns.split('/');
     const scope = findLast(folders, folder => folder.startsWith('@'));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-environment",
-  "version": "4.0.0-alpha.7",
+  "version": "4.0.0-beta.0",
   "description": "Handles the lifecyle and bootstrapping of generators in a specific environment",
   "keywords": [
     "development",
@@ -57,41 +57,36 @@
     "doc_path": "./yeoman-environment-doc"
   },
   "dependencies": {
-    "@npmcli/arborist": "^6.2.9",
-    "@yeoman/adapter": "^0.3.0",
-    "@yeoman/conflicter": "^0.6.0",
+    "@yeoman/adapter": "^1.1.0",
+    "@yeoman/conflicter": "^1.0.7",
     "@yeoman/namespace": "^1.0.0",
-    "@yeoman/transform": "^1.0.0",
-    "@yeoman/types": "^0.5.0",
+    "@yeoman/transform": "^1.2.0",
     "arrify": "^3.0.0",
     "chalk": "^5.2.0",
     "commander": "^10.0.1",
     "debug": "^4.3.4",
-    "escape-string-regexp": "^5.0.0",
     "execa": "^7.1.1",
-    "fly-import": "^0.2.0",
+    "fly-import": "^0.3.0",
     "globby": "^13.1.4",
     "grouped-queue": "^2.0.0",
     "locate-path": "^7.2.0",
     "lodash-es": "^4.17.21",
-    "log-symbols": "^5.1.0",
     "mem-fs": "^3.0.0",
     "mem-fs-editor": "^10.0.1",
-    "npmlog": "^7.0.1",
     "preferred-pm": "^3.0.3",
     "semver": "^7.5.0",
     "slash": "^5.0.1",
-    "untildify": "^4.0.0",
-    "yeoman-generator": "^5.8.0"
+    "untildify": "^5.0.0"
   },
   "devDependencies": {
+    "@types/debug": "^4.1.8",
     "@types/lodash-es": "^4.17.7",
     "@types/semver": "^7.5.0",
     "c8": "^7.13.0",
     "cpy-cli": "^4.2.0",
     "esmocha": "^1.0.1",
     "fs-extra": "^11.1.1",
-    "inquirer": "^9.2.1",
+    "inquirer": "^9.2.6",
     "jsdoc": "^4.0.2",
     "prettier": "^2.8.8",
     "prettier-plugin-packagejson": "^2.4.3",
@@ -103,10 +98,11 @@
     "typescript": "^5.0.4",
     "xo": "0.54.2",
     "yeoman-assert": "^3.1.1",
-    "yeoman-generator": "^5.8.0",
-    "yeoman-test": "^8.0.0-beta.5"
+    "yeoman-generator": "^5.9.0",
+    "yeoman-test": "^8.0.0-rc.1"
   },
   "peerDependencies": {
+    "@yeoman/types": "^1.0.1",
     "mem-fs": "^3.0.0"
   },
   "engines": {