Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(@angular/cli): remove npm 7 incompatibility notification #20132

Merged
merged 1 commit into from Feb 24, 2021
Merged

fix(@angular/cli): remove npm 7 incompatibility notification #20132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/packages.ts
View file
Open in desktop
Expand Up @@ -88,7 +88,7 @@ function loadPackageJson(p: string) {
case 'engines':
pkg['engines'] = {
'node': '>= 12.13.0',
'npm': '^6.11.0',
'npm': '^6.11.0 || ^7.5.6',
'yarn': '>= 1.13.0',
};
break;
Expand Down
25 changes: 12 additions & 13 deletions packages/angular/cli/utilities/package-manager.ts
View file
Open in desktop
Expand Up @@ -8,6 +8,7 @@
import { execSync } from 'child_process';
import { existsSync } from 'fs';
import { join } from 'path';
import { satisfies, valid } from 'semver';
import { PackageManager } from '../lib/config/schema';
import { getConfiguredPackageManager } from './config';

Expand Down Expand Up @@ -56,29 +57,27 @@ export async function getPackageManager(root: string): Promise<PackageManager> {
}

/**
* Checks if the npm version is version 6.x. If not, display a message and exit.
* Checks if the npm version is a supported 7.x version. If not, display a warning.
*/
export async function ensureCompatibleNpm(root: string): Promise<void> {
if ((await getPackageManager(root)) !== PackageManager.Npm) {
return;
}

try {
const version = execSync('npm --version', {encoding: 'utf8', stdio: 'pipe'}).trim();
const major = Number(version.match(/^(\d+)\./)?.[1]);
if (major <= 6) {
const versionText = execSync('npm --version', {encoding: 'utf8', stdio: 'pipe'}).trim();
const version = valid(versionText);
if (!version) {
return;
}

// tslint:disable-next-line: no-console
console.error(
`npm version ${version} detected. The Angular CLI temporarily requires npm version 6 while upstream issues are addressed.\n\n` +
'Please install a compatible version to proceed (`npm install --global npm@6`).\n' +
'For additional information and alternative workarounds, please see ' +
'https://github.com/angular/angular-cli/issues/19957#issuecomment-775407654',
);

process.exit(3);
if (satisfies(version, '>=7 <7.5.6')) {
// tslint:disable-next-line: no-console
console.warn(
`npm version ${version} detected.` +
' When using npm 7 with the Angular CLI, npm version 7.5.6 or higher is recommended.',
);
}
} catch {
// npm is not installed
}
Expand Down
53 changes: 31 additions & 22 deletions tests/legacy-cli/e2e/tests/misc/npm-7.ts
View file
Open in desktop
Expand Up @@ -3,7 +3,7 @@ import { getActivePackageManager } from '../../utils/packages';
import { ng, npm } from '../../utils/process';
import { expectToFail } from '../../utils/utils';

const errorText = 'The Angular CLI temporarily requires npm version 6';
const warningText = 'npm version 7.5.6 or higher is recommended';

export default async function() {
// Only relevant with npm as a package manager
Expand All @@ -18,53 +18,62 @@ export default async function() {

const currentDirectory = process.cwd();
try {
// Install version 7.x
await npm('install', '--global', 'npm@7');
// Install version >=7.5.6
await npm('install', '--global', 'npm@>=7.5.6');

// Ensure `ng add` exits and shows npm error
// Ensure `ng update` does not show npm warning
const { stderr: stderrUpdate1 } = await ng('update');
if (stderrUpdate1.includes(warningText)) {
throw new Error('ng update expected to not show npm version warning.');
}

// Install version <7.5.6
await npm('install', '--global', 'npm@7.4.0');

// Ensure `ng add` shows npm warning
const { message: stderrAdd } = await expectToFail(() => ng('add'));
if (!stderrAdd.includes(errorText)) {
throw new Error('ng add expected to show npm version error.');
if (!stderrAdd.includes(warningText)) {
throw new Error('ng add expected to show npm version warning.');
}

// Ensure `ng update` exits and shows npm error
const { message: stderrUpdate } = await expectToFail(() => ng('update'));
if (!stderrUpdate.includes(errorText)) {
throw new Error('ng update expected to show npm version error.');
// Ensure `ng update` shows npm warning
const { stderr: stderrUpdate2 } = await ng('update');
if (!stderrUpdate2.includes(warningText)) {
throw new Error('ng update expected to show npm version warning.');
}

// Ensure `ng build` executes successfully
const { stderr: stderrBuild } = await ng('build');
if (stderrBuild.includes(errorText)) {
throw new Error('ng build expected to not show npm version error.');
if (stderrBuild.includes(warningText)) {
throw new Error('ng build expected to not show npm version warning.');
}

// Ensure `ng new` exits and shows npm error
// Ensure `ng new` shows npm warning
// Must be outside the project for `ng new`
process.chdir('..');
const { message: stderrNew } = await expectToFail(() => ng('new'));
if (!stderrNew.includes(errorText)) {
throw new Error('ng new expected to show npm version error.');
if (!stderrNew.includes(warningText)) {
throw new Error('ng new expected to show npm version warning.');
}

// Ensure `ng new --package-manager=npm` exits and shows npm error
// Ensure `ng new --package-manager=npm` shows npm warning
const { message: stderrNewNpm } = await expectToFail(() => ng('new', '--package-manager=npm'));
if (!stderrNewNpm.includes(errorText)) {
throw new Error('ng new expected to show npm version error.');
if (!stderrNewNpm.includes(warningText)) {
throw new Error('ng new expected to show npm version warning.');
}

// Ensure `ng new --skip-install` executes successfully
const { stderr: stderrNewSkipInstall } = await ng('new', 'npm-seven-skip', '--skip-install');
if (stderrNewSkipInstall.includes(errorText)) {
throw new Error('ng new --skip-install expected to not show npm version error.');
if (stderrNewSkipInstall.includes(warningText)) {
throw new Error('ng new --skip-install expected to not show npm version warning.');
}

// Ensure `ng new --package-manager=yarn` executes successfully
// Need an additional npmrc file since yarn does not use the NPM registry environment variable
await writeFile('.npmrc', 'registry=http://localhost:4873')
const { stderr: stderrNewYarn } = await ng('new', 'npm-seven-yarn', '--package-manager=yarn');
if (stderrNewYarn.includes(errorText)) {
throw new Error('ng new --package-manager=yarn expected to not show npm version error.');
if (stderrNewYarn.includes(warningText)) {
throw new Error('ng new --package-manager=yarn expected to not show npm version warning.');
}
} finally {
// Cleanup extra test projects
Expand Down