Skip to content

Commit

Permalink
fix(@angular/cli): remove npm 7 incompatibility notification
Browse files Browse the repository at this point in the history
npm 7.5.6 contains several fixes that allow it to work successfully with the Angular CLI.
The minimum npm engine value is now set to support npm versions greater than 7.5.6 (npm 6 support remains unchanged).
A warning will be shown to users with npm 7 versions less than 7.5.6 when used with the new, add, or update commands.
  • Loading branch information
clydin authored and alan-agius4 committed Feb 24, 2021
1 parent a4d091c commit f75bd57
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 28 deletions.
2 changes: 1 addition & 1 deletion lib/packages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ function loadPackageJson(p: string) {
case 'engines':
pkg['engines'] = {
'node': '>= 10.13.0',
'npm': '^6.11.0',
'npm': '^6.11.0 || ^7.5.6',
'yarn': '>= 1.13.0',
};
break;
Expand Down
2 changes: 0 additions & 2 deletions packages/angular/cli/commands/new-impl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ export class NewCommand extends SchematicCommand<NewCommandSchema> {
}

public async run(options: NewCommandSchema & Arguments) {
await ensureCompatibleNpm(this.workspace.root);

// Register the version of the CLI in the registry.
const packageJson = require('../package.json');
const version = packageJson.version;
Expand Down
12 changes: 11 additions & 1 deletion packages/angular/cli/models/schematic-command.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ import {
getWorkspaceRaw,
} from '../utilities/config';
import { parseJsonSchemaToOptions } from '../utilities/json-schema';
import { getPackageManager } from '../utilities/package-manager';
import { ensureCompatibleNpm, getPackageManager } from '../utilities/package-manager';
import { isTTY } from '../utilities/tty';
import { isPackageNameSafeForAnalytics } from './analytics';
import { BaseCommandOptions, Command } from './command';
Expand Down Expand Up @@ -534,6 +534,16 @@ export abstract class SchematicCommand<
}
});

// Temporary compatibility check for NPM 7
if (collectionName === '@schematics/angular' && schematicName === 'ng-new') {
if (
!input.skipInstall &&
(input.packageManager === undefined || input.packageManager === 'npm')
) {
await ensureCompatibleNpm(this.workspace.root);
}
}

return new Promise<number | void>(resolve => {
workflow
.execute({
Expand Down
23 changes: 12 additions & 11 deletions packages/angular/cli/utilities/package-manager.ts
Original file line number Diff line number Diff line change
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,27 +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.\n` +
'The Angular CLI currently requires npm version 6.\n\n' +
'Please install a compatible version to proceed (`npm install --global npm@6`).\n',
);
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
64 changes: 51 additions & 13 deletions tests/legacy-cli/e2e/tests/misc/npm-7.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import { rimraf } from '../../utils/fs';
import { ng, npm } from '../../utils/process';
import { expectToFail } from '../../utils/utils';

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

export default async function() {
// Windows CI fails with permission errors when trying to replace npm
Expand All @@ -11,29 +12,66 @@ 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 new` exits and shows npm error
// Ensure `ng build` executes successfully
const { stderr: stderrBuild } = await ng('build');
if (stderrBuild.includes(warningText)) {
throw new Error('ng build expected to not show npm version warning.');
}

// 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` shows npm warning
const { message: stderrNewNpm } = await expectToFail(() => ng('new', '--package-manager=npm'));
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(warningText)) {
throw new Error('ng new --skip-install expected to not show npm version warning.');
}

// Ensure `ng new --package-manager=yarn` executes successfully
const { stderr: stderrNewYarn } = await ng('new', 'npm-seven-yarn', '--package-manager=yarn');
if (stderrNewYarn.includes(warningText)) {
throw new Error('ng new --package-manager=yarn expected to not show npm version warning.');
}
} finally {
// Cleanup extra test projects
await rimraf('npm-seven-skip');
await rimraf('npm-seven-yarn');

// Change directory back
process.chdir(currentDirectory);

Expand Down

0 comments on commit f75bd57

Please sign in to comment.