fix(core): default to NPM package manager

* Simplify the determination & detection of the desired package manager. * Add the `package-manager` option on plugin creation. * Nx Cloud installation uses the appropriate package manager.
nrwl · Nov 11, 2020 · 8676c1a · 8676c1a
1 parent 3753cf3
commit 8676c1a
Show file tree

Hide file tree

Showing 11 changed files with 51 additions and 259 deletions.
diff --git a/e2e/workspace/src/create-nx-workspace.test.ts b/e2e/workspace/src/create-nx-workspace.test.ts
@@ -1,12 +1,4 @@
-import {
-  cli,
-  forEachCli,
-  readJson,
-  runCreateWorkspace,
-  setCurrentProjName,
-  uniq,
-  workspaceConfigName,
-} from '@nrwl/e2e/utils';
+import { cli, forEachCli, runCreateWorkspace, uniq } from '@nrwl/e2e/utils';
 import { existsSync, mkdirSync } from 'fs-extra';
 import { execSync } from 'child_process';
 
@@ -119,18 +111,5 @@ forEachCli(() => {
 
       expect(existsSync(`${tmpDir}/${wsName}/package.json`)).toBeTruthy();
     });
-
-    it('should store `packageManager` preference', () => {
-      const wsName = uniq('empty');
-      setCurrentProjName(wsName);
-
-      runCreateWorkspace(wsName, {
-        preset: 'empty',
-        packageManager: 'yarn',
-      });
-
-      const workspaceJson = readJson(`${workspaceConfigName()}`);
-      expect(workspaceJson.cli.packageManager).toEqual('yarn');
-    });
   });
 });
diff --git a/packages/create-nx-plugin/bin/create-nx-plugin.ts b/packages/create-nx-plugin/bin/create-nx-plugin.ts
@@ -10,15 +10,15 @@ import * as path from 'path';
 import { execSync } from 'child_process';
 import * as inquirer from 'inquirer';
 import yargsParser = require('yargs-parser');
-import { determinePackageManager, showNxWarning } from './shared';
+import { showNxWarning } from './shared';
 
 const tsVersion = 'TYPESCRIPT_VERSION';
 const cliVersion = 'NX_VERSION';
 const nxVersion = 'NX_VERSION';
 const prettierVersion = 'PRETTIER_VERSION';
 
 const parsedArgs = yargsParser(process.argv, {
-  string: ['pluginName'],
+  string: ['pluginName', 'packageManager'],
   alias: {
     pluginName: 'plugin-name',
   },
@@ -199,7 +199,7 @@ if (parsedArgs.help) {
   process.exit(0);
 }
 
-const packageManager = determinePackageManager();
+const packageManager = parsedArgs.packageManager || 'npm';
 determineWorkspaceName(parsedArgs).then((workspaceName) => {
   return determinePluginName(parsedArgs).then((pluginName) => {
     const tmpDir = createSandbox(packageManager);

diff --git a/packages/create-nx-plugin/bin/shared.ts b/packages/create-nx-plugin/bin/shared.ts
@@ -21,48 +21,3 @@ export function showNxWarning(workspaceName: string) {
     });
   }
 }
-
-export function determinePackageManager() {
-  let packageManager = getPackageManagerFromAngularCLI();
-  if (packageManager === 'npm' || isPackageManagerInstalled(packageManager)) {
-    return packageManager;
-  }
-
-  if (isPackageManagerInstalled('yarn')) {
-    return 'yarn';
-  }
-
-  if (isPackageManagerInstalled('pnpm')) {
-    return 'pnpm';
-  }
-
-  return 'npm';
-}
-
-function getPackageManagerFromAngularCLI(): string {
-  // If you have Angular CLI installed, read Angular CLI config.
-  // If it isn't installed, default to 'yarn'.
-  try {
-    return execSync('ng config -g cli.packageManager', {
-      stdio: ['ignore', 'pipe', 'ignore'],
-      timeout: 500,
-    })
-      .toString()
-      .trim();
-  } catch (e) {
-    return 'yarn';
-  }
-}
-
-function isPackageManagerInstalled(packageManager: string) {
-  let isInstalled = false;
-  try {
-    execSync(`${packageManager} --version`, {
-      stdio: ['ignore', 'ignore', 'ignore'],
-    });
-    isInstalled = true;
-  } catch (e) {
-    /* do nothing */
-  }
-  return isInstalled;
-}
diff --git a/packages/create-nx-workspace/bin/create-nx-workspace.ts b/packages/create-nx-workspace/bin/create-nx-workspace.ts
@@ -9,7 +9,7 @@ import * as inquirer from 'inquirer';
 import * as path from 'path';
 import { dirSync } from 'tmp';
 import * as yargsParser from 'yargs-parser';
-import { determinePackageManager, showNxWarning } from './shared';
+import { showNxWarning } from './shared';
 
 enum Preset {
   Empty = 'empty',
@@ -95,7 +95,7 @@ if (parsedArgs.help) {
   showHelp();
   process.exit(0);
 }
-const packageManager = determinePackageManager(parsedArgs.packageManager);
+const packageManager = parsedArgs.packageManager || 'npm';
 determineWorkspaceName(parsedArgs).then((name) => {
   determinePreset(parsedArgs).then((preset) => {
     return determineAppName(preset, parsedArgs).then((appName) => {

diff --git a/packages/create-nx-workspace/bin/shared.spec.ts b/packages/create-nx-workspace/bin/shared.spec.ts
diff --git a/packages/create-nx-workspace/bin/shared.ts b/packages/create-nx-workspace/bin/shared.ts
@@ -21,41 +21,3 @@ export function showNxWarning(workspaceName: string) {
     });
   }
 }
-
-export function determinePackageManager(preferredPackageManager?: string) {
-  return (
-    [
-      preferredPackageManager,
-      getPackageManagerFromAngularCLI(),
-      'yarn',
-      'pnpm',
-    ].find((pm) => pm && isPackageManagerInstalled(pm)) || 'npm'
-  );
-}
-
-function getPackageManagerFromAngularCLI(): string {
-  // If you have Angular CLI installed, read Angular CLI config.
-  try {
-    return execSync('ng config -g cli.packageManager', {
-      stdio: ['ignore', 'pipe', 'ignore'],
-      timeout: 500,
-    })
-      .toString()
-      .trim();
-  } catch (e) {
-    return;
-  }
-}
-
-function isPackageManagerInstalled(packageManager: string) {
-  let isInstalled = false;
-  try {
-    execSync(`${packageManager} --version`, {
-      stdio: ['ignore', 'ignore', 'ignore'],
-    });
-    isInstalled = true;
-  } catch (e) {
-    /* do nothing */
-  }
-  return isInstalled;
-}
diff --git a/packages/tao/src/shared/detect-package-manager.ts b/packages/tao/src/shared/detect-package-manager.ts
@@ -1,55 +1,11 @@
-import { execSync } from 'child_process';
-import { readFileSync, existsSync } from 'fs';
-import * as stripJsonComments from 'strip-json-comments';
-
-function isPackageManagerInstalled(packageManager: string) {
-  try {
-    execSync(`${packageManager} --version`, {
-      stdio: ['ignore', 'ignore', 'ignore'],
-    });
-    return true;
-  } catch (e) {
-    return false;
-  }
-}
+import { existsSync } from 'fs';
 
 export function detectPackageManager() {
-  const workspaceJsonPath = [`workspace.json`, `angular.json`].find((p) =>
-    existsSync(p)
-  );
-
-  if (workspaceJsonPath) {
-    const workspaceJson = JSON.parse(
-      stripJsonComments(readFileSync(workspaceJsonPath).toString())
-    );
-    if (workspaceJson.cli && workspaceJson.cli.packageManager) {
-      return workspaceJson.cli.packageManager;
-    }
-  }
-
-  if (existsSync('yarn.lock')) {
-    return 'yarn';
-  }
-
-  if (existsSync('pnpm-lock.yaml')) {
-    return 'pnpm';
-  }
-
-  if (existsSync('package-lock.json')) {
-    return 'npm';
-  }
-
-  // If we get here, there are no lock files,
-  // so lets check for package managers in our preferred order
-  if (isPackageManagerInstalled('yarn')) {
-    return 'yarn';
-  }
-
-  if (isPackageManagerInstalled('pnpm')) {
-    return 'pnpm';
-  }
-
-  return 'npm';
+  return existsSync('yarn.lock')
+    ? 'yarn'
+    : existsSync('pnpm-lock.yaml')
+    ? 'pnpm'
+    : 'npm';
 }
 
 export function getPackageManagerInstallCommand(

diff --git a/packages/workspace/src/command-line/prompt-for-nx-cloud.ts b/packages/workspace/src/command-line/prompt-for-nx-cloud.ts
@@ -1,7 +1,11 @@
 import * as inquirer from 'inquirer';
 import { readNxJson } from '../core/file-utils';
 import { output } from '../utils/output';
-import { detectPackageManager } from '../utils/detect-package-manager';
+import {
+  detectPackageManager,
+  getPackageManagerExecuteCommand,
+  getPackageManagerInstallCommand,
+} from '../utils/detect-package-manager';
 import { execSync } from 'child_process';
 
 export async function promptForNxCloud(scan: boolean) {
@@ -16,14 +20,15 @@ export async function promptForNxCloud(scan: boolean) {
   const res = await askAboutNxCloud();
   if (res) {
     const pm = detectPackageManager();
-    if (pm === 'yarn') {
-      execSync('yarn add -D @nrwl/nx-cloud@latest');
-    } else {
-      execSync('npm install --save-dev @nrwl/nx-cloud@latest');
-    }
-    execSync(`npx nx g @nrwl/nx-cloud:init`, {
-      stdio: [0, 1, 2],
-    });
+    execSync(
+      `${getPackageManagerInstallCommand(pm, true)} @nrwl/nx-cloud@latest`
+    );
+    execSync(
+      `${getPackageManagerExecuteCommand(pm)} nx g @nrwl/nx-cloud:init`,
+      {
+        stdio: [0, 1, 2],
+      }
+    );
   } else {
     output.log({ title: 'Executing the command without --scan' });
   }

diff --git a/packages/workspace/src/schematics/shared-new/shared-new.ts b/packages/workspace/src/schematics/shared-new/shared-new.ts
@@ -134,7 +134,6 @@ export function sharedNew(cli: string, options: Schema): Rule {
 
     return chain([
       schematic('workspace', { ...workspaceOpts, cli }),
-      setDefaultPackageManager(options),
       setDefaultLinter(options),
       addPresetDependencies(options),
       addCloudDependencies(options),
@@ -328,17 +327,3 @@ function setTSLintDefault() {
     return json;
   });
 }
-
-function setDefaultPackageManager({ packageManager }: Schema) {
-  if (!packageManager) {
-    return noop();
-  }
-
-  return updateWorkspaceInTree((json) => {
-    if (!json.cli) {
-      json.cli = {};
-    }
-    json.cli['packageManager'] = packageManager;
-    return json;
-  });
-}
diff --git a/packages/workspace/src/utils/detect-package-manager.ts b/packages/workspace/src/utils/detect-package-manager.ts
@@ -1,22 +1,11 @@
-import { execSync } from 'child_process';
 import { fileExists } from './fileutils';
 
 export function detectPackageManager(): string {
-  try {
-    const output = execSync(`nx config cli.packageManager`, {
-      stdio: ['ignore', 'pipe', 'ignore'],
-    })
-      .toString()
-      .trim()
-      .split('\n');
-    return output[output.length - 1].trim();
-  } catch (e) {
-    return fileExists('yarn.lock')
-      ? 'yarn'
-      : fileExists('pnpm-lock.yaml')
-      ? 'pnpm'
-      : 'npm';
-  }
+  return fileExists('yarn.lock')
+    ? 'yarn'
+    : fileExists('pnpm-lock.yaml')
+    ? 'pnpm'
+    : 'npm';
 }
 
 export function getPackageManagerExecuteCommand(
@@ -32,3 +21,14 @@ export function getPackageManagerExecuteCommand(
 
   return `npx`;
 }
+
+export function getPackageManagerInstallCommand(
+  packageManager = detectPackageManager(),
+  isDevDependency = false
+) {
+  if (packageManager === 'yarn') {
+    return `yarn add${isDevDependency ? ' --dev' : ''}`;
+  }
+
+  return `${packageManager} install${isDevDependency ? ' --save-dev' : ''}`;
+}