@js-utils-kit/pm 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Sriman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});let e=require(`node:fs/promises`),t=require(`node:path`),n=require(`@js-utils-kit/fs`);const r=[`npm`,`pnpm`,`yarn`,`bun`];async function i({cwd:i=process.cwd(),lockfile:a=!0,packageJson:o=!0}={}){let s,c=process.env.npm_config_user_agent;if(c?.startsWith(`pnpm`)?s=`pnpm`:c?.startsWith(`yarn`)?s=`yarn`:c?.startsWith(`bun`)?s=`bun`:c?.startsWith(`npm`)&&(s=`npm`),a){let[e,r,a,o,c]=await Promise.all([(0,n.exists)((0,t.resolve)(i,`package-lock.json`)),(0,n.exists)((0,t.resolve)(i,`pnpm-lock.yaml`)),(0,n.exists)((0,t.resolve)(i,`yarn.lock`)),(0,n.exists)((0,t.resolve)(i,`bun.lock`)),(0,n.exists)((0,t.resolve)(i,`bun.lockb`))]);e?s=`npm`:a?s=`yarn`:r?s=`pnpm`:(o||c)&&(s=`bun`)}if(o)try{let n=JSON.parse(await(0,e.readFile)((0,t.resolve)(i,`package.json`),`utf-8`));if(n.packageManager){let e=n.packageManager.split(`@`)[0];r.includes(e)&&(s=e)}}catch{}return{name:s,isPackageManager:s!=null,isNpm:s===`npm`,isPnpm:s===`pnpm`,isYarn:s===`yarn`,isBun:s===`bun`}}exports.PACKAGE_MANAGERS=r,exports.detectPM=i;

package/dist/index.d.cts

@@ -0,0 +1,110 @@
+//#region src/types.d.ts
+type PackageManager = (typeof PACKAGE_MANAGERS)[number];
+/**
+ * Options for {@link detectPM}
+ */
+interface DetectPMOptions {
+  /**
+   * Working directory where package manager detection should occur.
+   *
+   * @default `process.cwd()`.
+   */
+  cwd?: string;
+  /**
+   * Whether to detect the package manager using lockfiles.
+   *
+   * Supported lockfiles:
+   * - `package-lock.json` → npm
+   * - `pnpm-lock.yaml` → pnpm
+   * - `yarn.lock` → yarn
+   * - `bun.lock` or `bun.lockb` → bun
+   *
+   * @default true
+   */
+  lockfile?: boolean;
+  /**
+   * Whether to inspect `package.json` for the `packageManager` field.
+   *
+   * Example:
+   * ```json
+   * {
+   *   "packageManager": "pnpm@10.30.3"
+   * }
+   * ```
+   *
+   * @default true
+   */
+  packageJson?: boolean;
+}
+/**
+ * Result returned by {@link detectPM}
+ */
+interface DetectPMResult {
+  /**
+   * Detected package manager name.
+   *
+   * `undefined` if no package manager could be determined.
+   */
+  name?: PackageManager;
+  /**
+   * Indicates whether any package manager was detected.
+   */
+  isPackageManager: boolean;
+  /** True if npm is detected */
+  isNpm: boolean;
+  /** True if pnpm is detected */
+  isPnpm: boolean;
+  /** True if yarn is detected */
+  isYarn: boolean;
+  /** True if bun is detected */
+  isBun: boolean;
+}
+//#endregion
+//#region src/pm.d.ts
+/** List of JavaScript package managers */
+declare const PACKAGE_MANAGERS: readonly ["npm", "pnpm", "yarn", "bun"];
+/**
+ * Detect the package manager used in a project directory.
+ *
+ * @remarks
+ *
+ * Detection strategy:
+ *
+ * 1. `npm_config_user_agent` environment variable
+ * 2. Lockfiles (`package-lock.json`, `pnpm-lock.yaml`, etc.)
+ * 3. `package.json` → `packageManager` field
+ *
+ * Each later step can override earlier detection.
+ *
+ *
+ * @example
+ * ```ts
+ * const pm = await detectPM();
+ *
+ * console.log(pm.name);
+ * // "pnpm"
+ *
+ * if (pm.isPnpm) {
+ *   console.log('Using pnpm');
+ * }
+ * ```
+ *
+ * @example Disable lockfile detection
+ *
+ * ```ts
+ * await detectPM({ lockfile: false });
+ * ```
+ *
+ * @example Disable packageJson detection
+ *
+ * ```ts
+ * await detectPM({ packageJson: false });
+ * ```
+ */
+declare function detectPM({
+  cwd,
+  lockfile,
+  packageJson
+}?: DetectPMOptions): Promise<DetectPMResult>;
+//#endregion
+export { DetectPMOptions, DetectPMResult, PACKAGE_MANAGERS, PackageManager, detectPM };

package/dist/index.d.mts

@@ -0,0 +1,110 @@
+//#region src/types.d.ts
+type PackageManager = (typeof PACKAGE_MANAGERS)[number];
+/**
+ * Options for {@link detectPM}
+ */
+interface DetectPMOptions {
+  /**
+   * Working directory where package manager detection should occur.
+   *
+   * @default `process.cwd()`.
+   */
+  cwd?: string;
+  /**
+   * Whether to detect the package manager using lockfiles.
+   *
+   * Supported lockfiles:
+   * - `package-lock.json` → npm
+   * - `pnpm-lock.yaml` → pnpm
+   * - `yarn.lock` → yarn
+   * - `bun.lock` or `bun.lockb` → bun
+   *
+   * @default true
+   */
+  lockfile?: boolean;
+  /**
+   * Whether to inspect `package.json` for the `packageManager` field.
+   *
+   * Example:
+   * ```json
+   * {
+   *   "packageManager": "pnpm@10.30.3"
+   * }
+   * ```
+   *
+   * @default true
+   */
+  packageJson?: boolean;
+}
+/**
+ * Result returned by {@link detectPM}
+ */
+interface DetectPMResult {
+  /**
+   * Detected package manager name.
+   *
+   * `undefined` if no package manager could be determined.
+   */
+  name?: PackageManager;
+  /**
+   * Indicates whether any package manager was detected.
+   */
+  isPackageManager: boolean;
+  /** True if npm is detected */
+  isNpm: boolean;
+  /** True if pnpm is detected */
+  isPnpm: boolean;
+  /** True if yarn is detected */
+  isYarn: boolean;
+  /** True if bun is detected */
+  isBun: boolean;
+}
+//#endregion
+//#region src/pm.d.ts
+/** List of JavaScript package managers */
+declare const PACKAGE_MANAGERS: readonly ["npm", "pnpm", "yarn", "bun"];
+/**
+ * Detect the package manager used in a project directory.
+ *
+ * @remarks
+ *
+ * Detection strategy:
+ *
+ * 1. `npm_config_user_agent` environment variable
+ * 2. Lockfiles (`package-lock.json`, `pnpm-lock.yaml`, etc.)
+ * 3. `package.json` → `packageManager` field
+ *
+ * Each later step can override earlier detection.
+ *
+ *
+ * @example
+ * ```ts
+ * const pm = await detectPM();
+ *
+ * console.log(pm.name);
+ * // "pnpm"
+ *
+ * if (pm.isPnpm) {
+ *   console.log('Using pnpm');
+ * }
+ * ```
+ *
+ * @example Disable lockfile detection
+ *
+ * ```ts
+ * await detectPM({ lockfile: false });
+ * ```
+ *
+ * @example Disable packageJson detection
+ *
+ * ```ts
+ * await detectPM({ packageJson: false });
+ * ```
+ */
+declare function detectPM({
+  cwd,
+  lockfile,
+  packageJson
+}?: DetectPMOptions): Promise<DetectPMResult>;
+//#endregion
+export { DetectPMOptions, DetectPMResult, PACKAGE_MANAGERS, PackageManager, detectPM };

package/dist/index.mjs

@@ -0,0 +1 @@
+import{readFile as e}from"node:fs/promises";import{resolve as t}from"node:path";import{exists as n}from"@js-utils-kit/fs";const r=[`npm`,`pnpm`,`yarn`,`bun`];async function i({cwd:i=process.cwd(),lockfile:a=!0,packageJson:o=!0}={}){let s,c=process.env.npm_config_user_agent;if(c?.startsWith(`pnpm`)?s=`pnpm`:c?.startsWith(`yarn`)?s=`yarn`:c?.startsWith(`bun`)?s=`bun`:c?.startsWith(`npm`)&&(s=`npm`),a){let[e,r,a,o,c]=await Promise.all([n(t(i,`package-lock.json`)),n(t(i,`pnpm-lock.yaml`)),n(t(i,`yarn.lock`)),n(t(i,`bun.lock`)),n(t(i,`bun.lockb`))]);e?s=`npm`:a?s=`yarn`:r?s=`pnpm`:(o||c)&&(s=`bun`)}if(o)try{let n=JSON.parse(await e(t(i,`package.json`),`utf-8`));if(n.packageManager){let e=n.packageManager.split(`@`)[0];r.includes(e)&&(s=e)}}catch{}return{name:s,isPackageManager:s!=null,isNpm:s===`npm`,isPnpm:s===`pnpm`,isYarn:s===`yarn`,isBun:s===`bun`}}export{r as PACKAGE_MANAGERS,i as detectPM};

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@js-utils-kit/pm",
+  "version": "0.1.0",
+  "description": "Utilities for detecting and interacting with JavaScript package managers",
+  "homepage": "https://js-utils.js.org",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/teneplaysofficial/js-utils-kit",
+    "directory": "packages/@js-utils-kit/pm"
+  },
+  "bugs": {
+    "url": "https://github.com/teneplaysofficial/js-utils-kit/issues"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Sriman",
+    "email": "136729116+TenEplaysOfficial@users.noreply.github.com",
+    "url": "https://tene.vercel.app"
+  },
+  "private": false,
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "types": "./dist/index.d.cts",
+  "engines": {
+    "node": ">=22"
+  },
+  "dependencies": {
+    "@js-utils-kit/fs": "1.5.0",
+    "@js-utils-kit/types": "1.4.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run"
+  }
+}