miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

fix(core): print installation logs when installing latest version during nx migrate and using --verbose (#31432)

Browse Source 
## Current Behavior

By default, `nx migrate` installs the latest version of `nx` in a
temporary directory to run the migration process. When this installation
fails, no helpful information is printed even when running with
`--verbose`; it only prints a generic message that the package manager
install process failed. This doesn't help when debugging/troubleshooting
issues with the installation.

## Expected Behavior

When installing the latest version of `nx` during `nx migrate` fails,
the installation logs should be printed when running with `--verbose`.

## Related Issue(s)

Fixes #
This commit is contained in:
Leosvel Pérez Espinosa 2025-06-03 14:15:15 +02:00 committed by GitHub
parent cb930d006a
commit d3faf53c56
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
packages/nx/src/command-line/migrate/migrate.ts
View File

@ -1,5 +1,5 @@
import * as chalk from 'chalk'; import * as chalk from 'chalk';
import { exec, execSync } from 'child_process'; import { exec, execSync, type StdioOptions } from 'child_process';
import { prompt } from 'enquirer'; import { prompt } from 'enquirer';
import { dirname, join } from 'path'; import { dirname, join } from 'path';
import { import {
@ -1835,6 +1835,8 @@ export function getImplementationPath(
export function nxCliPath(nxWorkspaceRoot?: string) { export function nxCliPath(nxWorkspaceRoot?: string) {
const version = process.env.NX_MIGRATE_CLI_VERSION || 'latest'; const version = process.env.NX_MIGRATE_CLI_VERSION || 'latest';
const isVerbose = process.env.NX_VERBOSE_LOGGING === 'true';
try { try {
const packageManager = detectPackageManager(); const packageManager = detectPackageManager();
const pmc = getPackageManagerCommand(packageManager); const pmc = getPackageManagerCommand(packageManager);
@ -1851,18 +1853,25 @@ export function nxCliPath(nxWorkspaceRoot?: string) {
nxWorkspaceRoot ?? workspaceRoot, nxWorkspaceRoot ?? workspaceRoot,
tmpDir tmpDir
); );
// Let's print the output of the install process to the console when verbose
// is enabled, so it's easier to debug issues with the installation process
const stdio: StdioOptions = isVerbose
? ['ignore', 'inherit', 'inherit']
: 'ignore';
if (pmc.preInstall) { if (pmc.preInstall) {
// ensure package.json and repo in tmp folder is set to a proper package manager state // ensure package.json and repo in tmp folder is set to a proper package manager state
execSync(pmc.preInstall, { execSync(pmc.preInstall, {
cwd: tmpDir, cwd: tmpDir,
stdio: ['ignore', 'ignore', 'ignore'], stdio,
windowsHide: false, windowsHide: false,
}); });
// if it's berry ensure we set the node_linker to node-modules // if it's berry ensure we set the node_linker to node-modules
if (packageManager === 'yarn' && pmc.ciInstall.includes('immutable')) { if (packageManager === 'yarn' && pmc.ciInstall.includes('immutable')) {
execSync('yarn config set nodeLinker node-modules', { execSync('yarn config set nodeLinker node-modules', {
cwd: tmpDir, cwd: tmpDir,
stdio: ['ignore', 'ignore', 'ignore'], stdio,
windowsHide: false, windowsHide: false,
}); });
} }
@ -1870,7 +1879,7 @@ export function nxCliPath(nxWorkspaceRoot?: string) {
execSync(pmc.install, { execSync(pmc.install, {
cwd: tmpDir, cwd: tmpDir,
stdio: ['ignore', 'ignore', 'ignore'], stdio,
windowsHide: false, windowsHide: false,
}); });
@ -1883,7 +1892,7 @@ export function nxCliPath(nxWorkspaceRoot?: string) {
console.error( console.error(
`Failed to install the ${version} version of the migration script. Using the current version.` `Failed to install the ${version} version of the migration script. Using the current version.`
); );
if (process.env.NX_VERBOSE_LOGGING === 'true') { if (isVerbose) {
console.error(e); console.error(e);
} }
return null; return null;