# plucky-plugin-manager

> Manages loading and installing plugins for Plucky-CI

Latest version **0.0.1** (published 2016-10-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install plucky-plugin-manager
pnpm add plucky-plugin-manager
yarn add plucky-plugin-manager
bun add plucky-plugin-manager
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2016-10-20 |
| First published | 2016-10-20 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| Author | Jeremy Darling |
| Maintainers | jdarling |

## Links

- npm: https://www.npmjs.com/package/plucky-plugin-manager
- npm.io page: https://npm.io/package/plucky-plugin-manager

## Dependencies (3)

- [npm](https://npm.io/package/npm.md) ^3.10.8
- [async](https://npm.io/package/async.md) ^2.1.2
- [npmlog](https://npm.io/package/npmlog.md) ^4.0.0

## Recent versions

- 0.0.1 (latest) — 2016-10-20

## README

Plucky Pluin Manager
===

Manages plugins for Plucky-CI.  Thin wrapper over the top of the NPM API.

Thoughts
---

Given:

```javascript
{
  'async': 'async',
  'plucky-ssh': 'plucky-ssh@0.0.2'
}
```

Async will be installed and returned.  plucky-ssh will be installed at version 0.0.2 and returned.

API:
---

###Plugins.constructor({pluginsFolder = process.cwd()+'/plugins'})

###Plugins.get(pluginMap, callback)

 * pluginMap - is a JavaScript object (or hash) representing what NPM modules need to be installed and used
 * callback(err, pluginsHash) - err is present if there is an error, pluginsHash is a JavaScript object where each key maps to the plugin as loaded by require.

####Example:

```javascript
const {
  plugins
} = require('plucky-plugin-manager');

// assumes that the plugins folder contains a plucky-ssh folder with the plugin in it
plugins.get({
  'ssh': 'plucky-ssh' // Load plucky-ssh as ssh
}, (err, plugins)=>{
  if(err){
    console.error(err);
    return;
  }
  const {
    ssh
  } = plugins;
  // Here you can do something with ssh now
});
```

###Plugins.getPackageDetails(fromName) -> PackageDetails

PackageDetails
 * name - The name or scoped name of the package
 * version - Version identifier for the package if specified

---
_Source: https://npm.io/package/plucky-plugin-manager · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._