Pubun

Asynchronous library with built-in caching to identify available package managers.

Table of contents

• 📡 Features
• 🕹️ Install
• 🏄‍♀️ Usage
  • Example of defining a package manager for the current project
  • Example of detecting all globally installed package managers
  • Clearing Pubun cache
• 📜 API
  • defineManager()
  • defineGlobalManagers()
  • clearCache()

📡 Features

• [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 and bun.
• [x] Uses cache at all stages, which can be forcibly cleared.

🕹️ Install

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';

🏄‍♀️ Usage

Example of defining a package manager for the current project

import { defineManager } from 'pubun';

async function demoFunction() {
  const packageManager = await defineManager('/path/to/project');

  console.log(packageManager); // npm | yarn | pnpm | bun
}

demoFunction();

Example of detecting all globally installed package managers

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();

Clearing Pubun cache

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();

📜 API

defineManager()

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.

defineGlobalManagers()

interface IGlobalManagerData {
  manager: PackageManager;
  version: string;
}

defineGlobalManagers: () => Promise<IGlobalManagerData[] | 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.

clearCache()

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