@rnm/pm
Version:
Unified Package Manager for Node.js
69 lines • 11.3 kB
JavaScript
import fs from "node:fs/promises";
import path from "node:path";
import process from "node:process";
import { findUp } from "find-up-simple";
const importPkgJson = async (p) => await fs
.readFile(p, "utf8")
.then(JSON.parse)
.catch(() => undefined);
async function detectByPackageJson(directory = process.cwd()) {
const pkgJsonContent = await importPkgJson(path.join(directory, "package.json"));
// 1. detect pm by `packageManager` field
const [packageManager, rest] = pkgJsonContent?.packageManager?.split("@") ?? [];
if (packageManager === "npm" ||
packageManager === "yarn" ||
packageManager === "pnpm") {
const version = rest?.split("+")[0];
return { name: packageManager, ...(version && { version }) };
}
// 2. detect pm by `devEngines` filed
const { name, version: devEnginesVer } = pkgJsonContent?.devEngines?.packageManager ?? {};
if (name === "npm" || name === "yarn" || name === "pnpm") {
const version = devEnginesVer?.split("+")[0];
return { name, ...(version && { version }) };
}
// 3. detect pm by `engines` filed
// Note: Corepack does not support `engines` field. So the result doesn't include the version. See https://github.com/nodejs/corepack/issues/694.
if (pkgJsonContent?.engines?.["npm"])
return { name: "npm" };
if (pkgJsonContent?.engines?.["yarn"])
return { name: "yarn" };
if (pkgJsonContent?.engines?.["pnpm"])
return { name: "pnpm" };
const parent = path.dirname(directory);
if (directory === parent)
return undefined;
return await detectByPackageJson(parent);
}
async function detectByLockFile(directory = process.cwd()) {
const locks = (await Promise.all([
findUp("package-lock.json", { cwd: directory }),
findUp("yarn.lock", { cwd: directory }),
findUp("pnpm-lock.yaml", { cwd: directory }),
])).filter((p) => p !== undefined);
if (locks.length > 1) {
throw new Error("Multiple lock files found. Please remove one of them.");
}
if (locks[0]?.endsWith("package-lock.json"))
return { name: "npm" };
if (locks[0]?.endsWith("yarn.lock"))
return { name: "yarn" };
if (locks[0]?.endsWith("pnpm-lock.yaml"))
return { name: "pnpm" };
return undefined;
}
/**
* Detects the package manager used in the specified directory.
* @param directory - The absolute path to the directory to check.
*/
export async function detect(directory = process.cwd()) {
const pkgJsonPath = await findUp("package.json", { cwd: directory });
if (!pkgJsonPath) {
// throw new Error("No package.json found.");
return undefined;
}
// detect pm by package.json or lock files
return ((await detectByPackageJson(path.dirname(pkgJsonPath))) ??
(await detectByLockFile(directory)));
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"detector.js","sourceRoot":"","sources":["../../src/utils/detector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAQxC,MAAM,aAAa,GAAG,KAAK,EAAE,CAAS,EAAE,EAAE,CACxC,MAAM,EAAE;KACL,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;KACnB,IAAI,CAIF,IAAI,CAAC,KAAK,CAAC;KACb,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;AAE5B,KAAK,UAAU,mBAAmB,CAChC,SAAS,GAAG,OAAO,CAAC,GAAG,EAAE;IAEzB,MAAM,cAAc,GAAG,MAAM,aAAa,CACxC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CACrC,CAAC;IAEF,yCAAyC;IACzC,MAAM,CAAC,cAAc,EAAE,IAAI,CAAC,GAC1B,cAAc,EAAE,cAAc,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IACnD,IACE,cAAc,KAAK,KAAK;QACxB,cAAc,KAAK,MAAM;QACzB,cAAc,KAAK,MAAM,EACzB,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IAC/D,CAAC;IAED,qCAAqC;IACrC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,GACpC,cAAc,EAAE,UAAU,EAAE,cAAc,IAAI,EAAE,CAAC;IACnD,IAAI,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;QACzD,MAAM,OAAO,GAAG,aAAa,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7C,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IAC/C,CAAC;IAED,kCAAkC;IAClC,iJAAiJ;IACjJ,IAAI,cAAc,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAC7D,IAAI,cAAc,EAAE,OAAO,EAAE,CAAC,MAAM,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC/D,IAAI,cAAc,EAAE,OAAO,EAAE,CAAC,MAAM,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAE/D,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACvC,IAAI,SAAS,KAAK,MAAM;QAAE,OAAO,SAAS,CAAC;IAC3C,OAAO,MAAM,mBAAmB,CAAC,MAAM,CAAC,CAAC;AAC3C,CAAC;AAED,KAAK,UAAU,gBAAgB,CAC7B,SAAS,GAAG,OAAO,CAAC,GAAG,EAAE;IAEzB,MAAM,KAAK,GAAG,CACZ,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,MAAM,CAAC,mBAAmB,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;QAC/C,MAAM,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;QACvC,MAAM,CAAC,gBAAgB,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;KAC7C,CAAC,CACH,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;IAEjC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC3E,CAAC;IAED,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,mBAAmB,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IACpE,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,WAAW,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC7D,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,gBAAgB,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAElE,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,SAAS,GAAG,OAAO,CAAC,GAAG,EAAE;IAEzB,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,cAAc,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC;IACrE,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,6CAA6C;QAC7C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,0CAA0C;IAC1C,OAAO,CACL,CAAC,MAAM,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;QACtD,CAAC,MAAM,gBAAgB,CAAC,SAAS,CAAC,CAAC,CACpC,CAAC;AACJ,CAAC","sourcesContent":["import fs from \"node:fs/promises\";\nimport path from \"node:path\";\nimport process from \"node:process\";\nimport { findUp } from \"find-up-simple\";\nimport type { SupportedPm } from \"../constants.ts\";\n\nexport interface DetectResult {\n  name: SupportedPm;\n  version?: string;\n}\n\nconst importPkgJson = async (p: string) =>\n  await fs\n    .readFile(p, \"utf8\")\n    .then<{\n      packageManager?: string;\n      engines?: Record<string, string>;\n      devEngines?: { packageManager?: { name?: string; version?: string } };\n    }>(JSON.parse)\n    .catch(() => undefined);\n\nasync function detectByPackageJson(\n  directory = process.cwd(),\n): Promise<DetectResult | undefined> {\n  const pkgJsonContent = await importPkgJson(\n    path.join(directory, \"package.json\"),\n  );\n\n  // 1. detect pm by `packageManager` field\n  const [packageManager, rest] =\n    pkgJsonContent?.packageManager?.split(\"@\") ?? [];\n  if (\n    packageManager === \"npm\" ||\n    packageManager === \"yarn\" ||\n    packageManager === \"pnpm\"\n  ) {\n    const version = rest?.split(\"+\")[0];\n    return { name: packageManager, ...(version && { version }) };\n  }\n\n  // 2. detect pm by `devEngines` filed\n  const { name, version: devEnginesVer } =\n    pkgJsonContent?.devEngines?.packageManager ?? {};\n  if (name === \"npm\" || name === \"yarn\" || name === \"pnpm\") {\n    const version = devEnginesVer?.split(\"+\")[0];\n    return { name, ...(version && { version }) };\n  }\n\n  // 3. detect pm by `engines` filed\n  // Note: Corepack does not support `engines` field. So the result doesn't include the version. See https://github.com/nodejs/corepack/issues/694.\n  if (pkgJsonContent?.engines?.[\"npm\"]) return { name: \"npm\" };\n  if (pkgJsonContent?.engines?.[\"yarn\"]) return { name: \"yarn\" };\n  if (pkgJsonContent?.engines?.[\"pnpm\"]) return { name: \"pnpm\" };\n\n  const parent = path.dirname(directory);\n  if (directory === parent) return undefined;\n  return await detectByPackageJson(parent);\n}\n\nasync function detectByLockFile(\n  directory = process.cwd(),\n): Promise<DetectResult | undefined> {\n  const locks = (\n    await Promise.all([\n      findUp(\"package-lock.json\", { cwd: directory }),\n      findUp(\"yarn.lock\", { cwd: directory }),\n      findUp(\"pnpm-lock.yaml\", { cwd: directory }),\n    ])\n  ).filter((p) => p !== undefined);\n\n  if (locks.length > 1) {\n    throw new Error(\"Multiple lock files found. Please remove one of them.\");\n  }\n\n  if (locks[0]?.endsWith(\"package-lock.json\")) return { name: \"npm\" };\n  if (locks[0]?.endsWith(\"yarn.lock\")) return { name: \"yarn\" };\n  if (locks[0]?.endsWith(\"pnpm-lock.yaml\")) return { name: \"pnpm\" };\n\n  return undefined;\n}\n\n/**\n * Detects the package manager used in the specified directory.\n * @param directory - The absolute path to the directory to check.\n */\nexport async function detect(\n  directory = process.cwd(),\n): Promise<DetectResult | undefined> {\n  const pkgJsonPath = await findUp(\"package.json\", { cwd: directory });\n  if (!pkgJsonPath) {\n    // throw new Error(\"No package.json found.\");\n    return undefined;\n  }\n\n  // detect pm by package.json or lock files\n  return (\n    (await detectByPackageJson(path.dirname(pkgJsonPath))) ??\n    (await detectByLockFile(directory))\n  );\n}\n"]}