3bcfaf018d
* feat(core): detect package manager used to invoke create-nx-(plugin|workspace) When consumers create a new Workspace (or Plugin) using the create-nx-workspace (or create-nx-plugin) generator, the package manager used to invoke the generator will be detected and used as packageManager. For example: pnpx create-nx-workspace will use pnpm, yarn create nx-workspace will use yarn. Explicit `--packageManager` flag will be priority over the detection. * cleanup(core): reassign SELECTED_PM after each test run * fix(core): augment args instead of hardcode --packageManager flag * cleanup(core): use packageManagerLockFile instead of magic strings * cleanup(core): fix typo in create-nx-workspace * cleanup(core): ensure new workspace name for every test * feat(core): detect package manager used to invoke create-nx-(plugin|workspace) When consumers create a new Workspace (or Plugin) using the create-nx-workspace (or create-nx-plugin) generator, the package manager used to invoke the generator will be detected and used as packageManager. For example: pnpx create-nx-workspace will use pnpm, yarn create nx-workspace will use yarn. Explicit `--packageManager` flag will be priority over the detection. * cleanup(core): reassign SELECTED_PM after each test run * fix(core): augment args instead of hardcode --packageManager flag * cleanup(core): use packageManagerLockFile instead of magic strings * cleanup(core): fix typo in create-nx-workspace * cleanup(core): ensure new workspace name for every test * fix(core): move detectInvokedPackageManager off of tao Co-authored-by: Chau Tran <ctran@Chaus-MacBook-Pro.local>
115 lines
3.0 KiB
TypeScript
115 lines
3.0 KiB
TypeScript
import { execSync } from 'child_process';
|
|
import { existsSync } from 'fs';
|
|
import { join } from 'path';
|
|
|
|
/*
|
|
* Because we don't want to depend on @nrwl/workspace (to speed up the workspace creation)
|
|
* we duplicate the helper functions from @nrwl/workspace in this file.
|
|
*/
|
|
|
|
export type PackageManager = 'yarn' | 'pnpm' | 'npm';
|
|
|
|
export function detectPackageManager(dir: string = ''): PackageManager {
|
|
return existsSync(join(dir, 'yarn.lock'))
|
|
? 'yarn'
|
|
: existsSync(join(dir, 'pnpm-lock.yaml'))
|
|
? 'pnpm'
|
|
: 'npm';
|
|
}
|
|
|
|
/**
|
|
* Returns commands for the package manager used in the workspace.
|
|
* By default, the package manager is derived based on the lock file,
|
|
* but it can also be passed in explicitly.
|
|
*
|
|
* Example:
|
|
*
|
|
* ```javascript
|
|
* execSync(`${getPackageManagerCommand().addDev} my-dev-package`);
|
|
* ```
|
|
*
|
|
*/
|
|
export function getPackageManagerCommand(
|
|
packageManager: PackageManager = detectPackageManager()
|
|
): {
|
|
install: string;
|
|
add: string;
|
|
addDev: string;
|
|
rm: string;
|
|
exec: string;
|
|
list: string;
|
|
run: (script: string, args: string) => string;
|
|
} {
|
|
switch (packageManager) {
|
|
case 'yarn':
|
|
return {
|
|
install: 'yarn',
|
|
add: 'yarn add',
|
|
addDev: 'yarn add -D',
|
|
rm: 'yarn remove',
|
|
exec: 'yarn',
|
|
run: (script: string, args: string) => `yarn ${script} ${args}`,
|
|
list: 'yarn list',
|
|
};
|
|
|
|
case 'pnpm':
|
|
return {
|
|
install: 'pnpm install --no-frozen-lockfile', // explicitly disable in case of CI
|
|
add: 'pnpm add',
|
|
addDev: 'pnpm add -D',
|
|
rm: 'pnpm rm',
|
|
exec: 'pnpx',
|
|
run: (script: string, args: string) => `pnpm run ${script} -- ${args}`,
|
|
list: 'pnpm ls --depth 100',
|
|
};
|
|
|
|
case 'npm':
|
|
process.env.npm_config_legacy_peer_deps =
|
|
process.env.npm_config_legacy_peer_deps ?? 'true';
|
|
return {
|
|
install: 'npm install',
|
|
add: 'npm install',
|
|
addDev: 'npm install -D',
|
|
rm: 'npm rm',
|
|
exec: 'npx',
|
|
run: (script: string, args: string) => `npm run ${script} -- ${args}`,
|
|
list: 'npm ls',
|
|
};
|
|
}
|
|
}
|
|
|
|
export function getPackageManagerVersion(
|
|
packageManager: PackageManager
|
|
): string {
|
|
return execSync(`${packageManager} --version`).toString('utf-8').trim();
|
|
}
|
|
|
|
/**
|
|
* Detects which package manager was used to invoke create-nx-{plugin|workspace} command
|
|
* based on the main Module process that invokes the command
|
|
* - npx returns 'npm'
|
|
* - pnpx returns 'pnpm'
|
|
* - yarn create returns 'yarn'
|
|
*
|
|
* Default to 'npm'
|
|
*/
|
|
export function detectInvokedPackageManager(): PackageManager {
|
|
let detectedPackageManager: PackageManager = 'npm';
|
|
// mainModule is deprecated since Node 14, fallback for older versions
|
|
const invoker = require.main || process['mainModule'];
|
|
|
|
// default to `npm`
|
|
if (!invoker) {
|
|
return detectedPackageManager;
|
|
}
|
|
|
|
for (const pkgManager of ['pnpm', 'yarn', 'npm'] as const) {
|
|
if (invoker.path.includes(pkgManager)) {
|
|
detectedPackageManager = pkgManager;
|
|
break;
|
|
}
|
|
}
|
|
|
|
return detectedPackageManager;
|
|
}
|