Asynchronous library with built-in caching to identify available package managers.
- [x] Defines the package manager that manages your application.
- [x] Identifies all available globally installed package managers and their versions.
- [x] Can detect package managers such as:
npm
,yarn
,pnpm
andbun
. - [x] Uses cache at all stages, which can be forcibly cleared.
npm install pubun
Pubun offers several import options - default import, or named import.
// default import
import pubun from 'pubun';
// or named import. Recommended!
import { defineManager, defineGlobalManagers } from 'pubun';
import { defineManager } from 'pubun';
async function demoFunction() {
const packageManager = await defineManager('/path/to/project');
console.log(packageManager); // npm | yarn | pnpm | bun
}
demoFunction();
import { defineGlobalManagers } from 'pubun';
async function demoFunction() {
const globalManagers = await defineGlobalManagers();
console.log(globalManagers);
// [
// {
// manager: 'pnpm';
// version: '8.11.0';
// },
// {
// manager: 'bun';
// version: '1.0.14';
// },
// ...
// ]
}
demoFunction();
Since all Pubun operations are cached in order to optimize speed, sometimes you may need to clear the cache manually.
import { clearCache } from 'pubun';
clearCache();
Defines the package manager used in a given directory.
Checks for the presence of characteristic files (e.g., package-lock.json for npm) for each known package manager.
Supported package managers: npm
, yarn
, pnpm
, bun
type PackageManager = 'npm' | 'yarn' | 'pnpm' | 'bun';
defineManager: (path?: string) => Promise<PackageManager | null>;
Argument | Type | Default value | Description |
---|---|---|---|
path |
string |
process.cwd() |
The path to the directory to check. If not provided, defaults to the current working directory. |
Return: A promise that resolves to the type of package manager used or null
if no package manager can be defined.
interface GlobalManagerData {
manager: PackageManager;
version: string;
}
defineGlobalManagers: () => Promise<GlobalManagerData[] | null>;
Return: A promise that resolves to an array of global manager data, including the name and version of each installed package manager, or null
if none is installed.
Clears the entire cache.
This function removes all cached data related to package manager checks.
Useful for resetting the state to ensure fresh data is fetched.
clearCache: () => void