yeoman-environment 4.0.0-beta.3 → 4.0.0-beta.5

package/dist/environment-base.d.ts

@@ -227,6 +227,14 @@ export default class EnvironmentBase extends EventEmitter implements BaseEnviron
      */
     alias(match: string | RegExp, value: string): this;
     alias(value: string): string;
+    /**
+     * Watch for package.json and queue package manager install task.
+     */
+    watchForPackageManagerInstall({ cwd, queueTask, installTask, }?: {
+        cwd?: string;
+        queueTask?: boolean;
+        installTask?: (nodePackageManager: string | undefined, defaultTask: () => Promise<boolean>) => void | Promise<void>;
+    }): void;
     /**
      * Start Environment queue
      * @param {Object} options - Conflicter options.
@@ -236,10 +244,6 @@ export default class EnvironmentBase extends EventEmitter implements BaseEnviron
      * Queue environment's commit task.
      */
     protected queueCommit(): void;
-    /**
-     * Queue environment's package manager install task.
-     */
-    protected queuePackageManagerInstall(): void;
     /**
      * Registers a specific `generator` to this environment. This generator is stored under
      * provided namespace, or a default namespace format if none if available.

package/dist/environment-base.js

@@ -85,6 +85,7 @@ const getComposeOptions = (...varargs) => {
 export function removePropertiesWithNullishValues(object) {
     return Object.fromEntries(Object.entries(object).filter(([_key, value]) => value !== undefined && value !== null));
 }
+// eslint-disable-next-line unicorn/prefer-event-target
 export default class EnvironmentBase extends EventEmitter {
     cwd;
     adapter;
@@ -508,6 +509,41 @@ export default class EnvironmentBase extends EventEmitter {
             return resolved.replace(alias.match, alias.value);
         }, match);
     }
+    /**
+     * Watch for package.json and queue package manager install task.
+     */
+    watchForPackageManagerInstall({ cwd, queueTask, installTask, } = {}) {
+        if (cwd && !installTask) {
+            throw new Error(`installTask is required when using a custom cwd`);
+        }
+        const npmCwd = cwd ?? this.cwd;
+        const queueInstallTask = () => {
+            this.queueTask('install', async () => {
+                if (this.compatibilityMode === 'v4') {
+                    debug('Running in generator < 5 compatibility. Package manager install is done by the generator.');
+                    return;
+                }
+                const { adapter, sharedFs: memFs } = this;
+                const { skipInstall, nodePackageManager } = this.options;
+                await packageManagerInstallTask({
+                    adapter,
+                    memFs,
+                    packageJsonLocation: npmCwd,
+                    skipInstall,
+                    nodePackageManager,
+                    customInstallTask: installTask ?? this.composedStore.customInstallTask,
+                });
+            }, { once: `package manager install ${npmCwd}` });
+        };
+        this.sharedFs.on('change', file => {
+            if (file === join(npmCwd, 'package.json')) {
+                queueInstallTask();
+            }
+        });
+        if (queueTask) {
+            queueInstallTask();
+        }
+    }
     /**
      * Start Environment queue
      * @param {Object} options - Conflicter options.
@@ -519,7 +555,10 @@ export default class EnvironmentBase extends EventEmitter {
             this.conflicterOptions = pick(defaults({}, this.options, options), ['force', 'bail', 'ignoreWhitespace', 'dryRun', 'skipYoResolve']);
             this.conflicterOptions.cwd = this.logCwd;
             this.queueCommit();
-            this.queuePackageManagerInstall();
+            this.queueTask('install', () => {
+                // Postpone watchForPackageManagerInstall to install priority since env's cwd can be changed by generators
+                this.watchForPackageManagerInstall({ queueTask: true });
+            });
             /*
              * Listen to errors and reject if emmited.
              * Some cases the generator relied at the behavior that the running process
@@ -570,6 +609,9 @@ export default class EnvironmentBase extends EventEmitter {
         const queueCommit = () => {
             debug('Queueing conflicts task');
             this.queueTask('environment:conflicts', async () => {
+                debug('Adding queueCommit listener');
+                // Conflicter can change files add listener before commit task.
+                this.sharedFs.once('change', queueCommit);
                 debug('Running conflicts');
                 const { customCommitTask = () => commitSharedFsTask(this) } = this.composedStore;
                 if (typeof customCommitTask === 'function') {
@@ -578,40 +620,12 @@ export default class EnvironmentBase extends EventEmitter {
                 else {
                     debug('Ignoring commit, custom commit was provided');
                 }
-                debug('Adding queueCommit listener');
-                this.sharedFs.once('change', queueCommit);
             }, {
                 once: 'write memory fs to disk',
             });
         };
         queueCommit();
     }
-    /**
-     * Queue environment's package manager install task.
-     */
-    queuePackageManagerInstall() {
-        this.queueTask('install', async () => {
-            if (this.compatibilityMode === 'v4') {
-                debug('Running in generator < 5 compatibility. Package manager install is done by the generator.');
-                return;
-            }
-            const { adapter, sharedFs: memFs } = this;
-            const { skipInstall, nodePackageManager } = this.options;
-            const { customInstallTask } = this.composedStore;
-            await packageManagerInstallTask({
-                adapter,
-                memFs,
-                packageJsonLocation: this.cwd,
-                skipInstall,
-                nodePackageManager,
-                customInstallTask,
-            });
-            memFs.once('change', file => {
-                if (file === join(this.cwd, 'package.json'))
-                    this.queuePackageManagerInstall();
-            });
-        }, { once: 'package manager install' });
-    }
     /**
      * Registers a specific `generator` to this environment. This generator is stored under
      * provided namespace, or a default namespace format if none if available.

package/dist/environment-full.js

@@ -82,7 +82,7 @@ class FullEnvironment extends EnvironmentBase {
                 out.push(`  ${ns}`);
             }
         }
-        return out.join('\n').replace(/:binary:/g, name);
+        return out.join('\n').replaceAll(':binary:', name);
     }
     /**
      * @protected

package/dist/util/namespace.js

@@ -44,17 +44,17 @@ 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(`(?:/|^)${escapeRegExp(lookup)}(?=/)`, 'g'), '');
+        ns = ns.replaceAll(new RegExp(`(?:/|^)${escapeRegExp(lookup)}(?=/)`, 'g'), '');
     }
     const folders = ns.split('/');
     const scope = findLast(folders, folder => folder.startsWith('@'));
     // Cleanup `ns` from unwanted parts and then normalize slashes to `:`
     ns = ns
-        .replace(/\/\//g, '') // Remove double `/`
+        .replaceAll('//', '') // Remove double `/`
         .replace(/(.*generator-)/, '') // Remove before `generator-`
         .replace(/\/(index|main)$/, '') // Remove `/index` or `/main`
         .replace(/^\//, '') // Remove leading `/`
-        .replace(/\/+/g, ':'); // Replace slashes by `:`
+        .replaceAll(/\/+/g, ':'); // Replace slashes by `:`
     if (scope) {
         ns = `${scope}/${ns}`;
     }

package/dist/util/util.js

@@ -24,7 +24,7 @@ export function splitArgsFromString(argsString) {
     const quoteSeparatedArgs = argsString.split(/("[^"]*")/).filter(Boolean);
     for (const arg of quoteSeparatedArgs) {
         if (arg.includes('"')) {
-            result.push(arg.replace(/"/g, ''));
+            result.push(arg.replaceAll('"', ''));
         }
         else {
             result = result.concat(arg.trim().split(' '));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-environment",
-  "version": "4.0.0-beta.3",
+  "version": "4.0.0-beta.5",
   "description": "Handles the lifecyle and bootstrapping of generators in a specific environment",
   "keywords": [
     "development",
@@ -58,14 +58,14 @@
   },
   "dependencies": {
     "@yeoman/adapter": "^1.1.0",
-    "@yeoman/conflicter": "^1.0.7",
+    "@yeoman/conflicter": "^1.0.10",
     "@yeoman/namespace": "^1.0.0",
     "@yeoman/transform": "^1.2.0",
     "arrify": "^3.0.0",
     "chalk": "^5.2.0",
-    "commander": "^10.0.1",
+    "commander": "^11.0.0",
     "debug": "^4.3.4",
-    "execa": "^7.1.1",
+    "execa": "^8.0.1",
     "fly-import": "^0.3.0",
     "globby": "^13.1.4",
     "grouped-queue": "^2.0.0",
@@ -82,21 +82,20 @@
     "@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",
+    "c8": "^8.0.0",
+    "cpy-cli": "^5.0.0",
     "esmocha": "^1.0.1",
     "fs-extra": "^11.1.1",
     "inquirer": "^9.2.6",
     "jsdoc": "^4.0.2",
-    "prettier": "^2.8.8",
+    "prettier": "3.0.3",
     "prettier-plugin-packagejson": "^2.4.3",
     "rimraf": "^5.0.0",
     "sinon": "^15.0.4",
     "sinon-test": "^3.1.5",
     "strip-ansi": "^7.0.1",
-    "tui-jsdoc-template": "^1.2.2",
-    "typescript": "^5.0.4",
-    "xo": "0.54.2",
+    "typescript": "5.2.2",
+    "xo": "0.56.0",
     "yeoman-assert": "^3.1.1",
     "yeoman-generator": "^5.9.0",
     "yeoman-test": "^8.0.0-rc.1"
@@ -106,6 +105,6 @@
     "mem-fs": "^3.0.0"
   },
   "engines": {
-    "node": "^16.13.0 || >=18.12.0"
+    "node": "^18.17.0 || >=20.5.0"
   }
 }