https://github.com/james-elicx/package-manager-manager

Utilities for managing package managers.
https://github.com/james-elicx/package-manager-manager

Last synced: 27 days ago
JSON representation

Utilities for managing package managers.

• Host: GitHub
• URL: https://github.com/james-elicx/package-manager-manager
• Owner: james-elicx
• License: mit
• Created: 2023-08-02T12:23:05.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-02T23:03:18.000Z (12 months ago)
• Last Synced: 2024-09-19T08:48:48.832Z (2 months ago)
• Language: TypeScript
• Size: 205 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  
package-manager-manager


  


    Utilities for managing package managers.

  


---



  

		

	

	



---

**package-manager-manager** is a library aimed at providing information regarding the package manager currently being used in a given project.

It can be used in CLIs or similar projects which may at some point need to know and adapt their behavior based on the package manager currently used by the developer (e.g. A project scaffolding tool, a bundling tool, etc...).

## Usage

To use the library first install it in your project, via:

```sh

npm i package-manager-manager

```

(or your package manager's equivalent)

Then simply import and use the `getPackageManager()` function to get an object containing all the information you need regarding the package manager currently being used:

```js

const packageManager = await getPackageManager();

console.log(packageManager.name);

// logs 'npm', 'yarn', 'pnpm' or 'bun'

console.log(packageManager.version);

// logs the version of the package manager e.g. '8.11.0'

```

> **Note**

> This library comes with properly defined and documented typescript types, meaning that once you obtain the `PackageManager` object you will be able to easily see what's available on it and get all necessary details directly in your IDE

### API

### getPackageInfo

`packageManager.getPackageInfo` allows you to get the information regarding a locally installed package that your client application is using, it can for example be used to make sure your user's application has a certain dependency or to gather and display the package version of such dependency.

For example:

```js

const zodPackage = await packageManager.getPackageInfo('zod');

if (zodPackage) {

	console.log(`starting validation using zod (version: ${zodPackage.version}`);

} else {

	throw new Error('Error: zod is not installed');

}

```

> **Note**

> This method only returns the information of a **locally installed package**, or _null_ in case the package is not installed, it does not return information of packages not locally installed (the API could be extended in the future to also include such use case)

### getRunScript

`packageManager.getRunScript` let's you create a command that can be used to run a script defined in the package.json file.

For example:

```js

const buildStr = packageManager.getRunScript('build', {

	args: ['./dist', '--verbose'],

});

console.log(`To build your application run: ${buildStr}`);

```

If you need more fine grained control over the command you can use its `packageManager.getRunScriptStruct` alternative to obtain an object representing the command.

For example:

```js

import { spawn } from 'child_process';

const buildCmd = packageManager.getRunScriptStruct('build', {

	args: ['./dist', '--verbose'],

});

// run the command for the user

spawn(buildCmd.cmd, buildCmd.cmdArgs);

```

### getRunExec

`packageManager.getRunExec` let's you create a command that can be used to execute a command from a target package (which may or may not be locally installed).

For example:

```js

const eslintStr = packageManager.getRunExec('eslint', {

	args: ['./src', '--quiet'],

});

console.log(`To run eslint on your application run: ${eslintStr}`);

```

If you need more fine grained control over the command you can use its `packageManager.getRunExecStruct` alternative to obtain an object representing the command.

For example:

```js

import { spawn } from 'child_process';

const eslintCmd = packageManager.getRunExec('eslint', {

	args: ['./src', '--quiet'],

});

// run the command for the user

spawn(eslintCmd.cmd, eslintCmd.cmdArgs);

```