Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bevry/pluginclerk
A clerk for retrieving compatible plugins from the npm database
https://github.com/bevry/pluginclerk
nodejs npm-client plugin-manager plugin-system
Last synced: 16 days ago
JSON representation
A clerk for retrieving compatible plugins from the npm database
- Host: GitHub
- URL: https://github.com/bevry/pluginclerk
- Owner: bevry
- License: other
- Created: 2015-09-04T14:21:21.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-12-30T16:23:41.000Z (11 months ago)
- Last Synced: 2024-04-14T09:45:20.371Z (7 months ago)
- Topics: nodejs, npm-client, plugin-manager, plugin-system
- Language: TypeScript
- Size: 715 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# pluginclerk
A clerk for retrieving compatible plugins from the npm database
## Usage
[Complete API Documentation.](http://master.pluginclerk.bevry.surge.sh/docs/)
```javascript
import PluginClerk from 'pluginclerk'
// Create the new clerk instance with our configuration
const clerk = new PluginClerk({
// Required: The keyword that must be specified inside the plugin's package.json:keywords property
keyword: 'docpad-plugin',
// Optional: A prefix that the name of the plugin must be prefixed by to be valid
// Defaults to nothing
prefix: 'docpad-plugin-',
// Optional: A function used for logging receives the arguments (logLevel, ...message)
// Defaults to nothing
log: console.log,
// Optional: The amount of milliseconds until we have to query the npm database again
// Defaults to one day
cacheDuration: null,
// Optional: The registry hostname we should use for the API calls
// Defaults to "https://registry.npmjs.org"
registryHostname: null,
})
// Fetch the latest version of a particular plugin
// Note the `installPeers` result,
// as `docpad-plugin-eco` has the peerDependency `docpad`,
// and no dependencies where supplied, it should be installed
clerk
.fetchPlugin({ name: 'docpad-plugin-eco' })
.then(console.log)
.catch(console.error)
/* {
success: true,
message: 'Successfully fetched the latest and compatible version of the plugin docpad-plugin-eco',
skippedVersions: {},
latestVersion: '2.1.0',
installVersion: '2.1.0',
installPeers: [ 'docpad' ]
} */
// Fetch the latest version of a particular plugin that is compatible with the specified dependencies
// Note the `installPeers` result,
// as `docpad-plugin-eco` has the peerDependency `docpad`,
// and we supplied it, there is no need to install it
clerk
.fetchPlugin({
name: 'docpad-plugin-eco',
requirements: { docpad: '6.78.0' },
})
.then(console.log)
.catch(console.error)
/* {
success: true,
message: 'Successfully fetched the latest and compatible version of the plugin docpad-plugin-eco',
skippedVersions: {},
latestVersion: '2.1.0',
installVersion: '2.1.0',
installPeers: [ ]
} */
// Fetch the latest version of a particular plugin that is compatible with the specified dependencies
// Note the `installVersion` and `skippedVersions` results,
// a few plugin versions where skipped because they required a `docpad` version range that our supplied `docpad` version didn't fulfill
// Note the `installPeers` result,
// as `docpad-plugin-eco` has the peerDependency `docpad`, and we supplied it, there is no need to install it
clerk
.fetchPlugin({
name: 'docpad-plugin-eco',
requirements: { docpad: '5.0.0' },
})
.then(console.log)
.catch(console.error)
/* ] {
success: true,
message: 'Successfully fetched an older and compatible version of the plugin docpad-plugin-eco',
skippedVersions: {
'2.1.0': { docpad: '^6.59.0' }
'2.0.0': { docpad: '^6.53.0' }
},
latestVersion: '2.1.0',
installVersion: '1.0.0',
installPeers: [] }
} */
// You can also fetch all plugins with some basic information
clerk.fetchPlugins({}).then(console.log).catch(console.error)
/* {
success: true,
message: 'Successfully fetched the plugins',
plugins: {
'docpad-plugin-eco': {
'description': '...',
'homepage': '...',
'version': '2.1.0'
}
}
} */
// You can also fetch all plugins with their compatibility information
clerk
.fetchPlugins({ requirements: { docpad: '5.0.0' } })
.then(console.log)
.catch(console.error)
/* {
success: true,
message: 'Successfully fetched the plugins',
plugins: {
'docpad-plugin-eco': {
'description': '...',
'homepage': '...',
'version': '1.0.0',
'compatibility': {} // result of fetchPlugin
}
}
} */
```
## Install
### [npm](https://npmjs.com "npm is a package manager for javascript")
- Install: `npm install --save pluginclerk`
- Import: `import pkg from ('pluginclerk')`
- Require: `const pkg = require('pluginclerk').default`
### [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative for Node.js")
``` typescript
import pkg from 'https://unpkg.com/pluginclerk@^6.5.0/edition-deno/index.ts'
```
### [Editions](https://editions.bevry.me "Editions are the best way to produce and consume packages you care about.")
This package is published with the following editions:
- `pluginclerk/source/index.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") source code with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
- `pluginclerk` aliases `pluginclerk/edition-es2022/index.js`
- `pluginclerk/edition-es2022/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2022](https://en.wikipedia.org/wiki/ES2022 "ECMAScript 2022") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules
- `pluginclerk/edition-es2022-esm/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2022](https://en.wikipedia.org/wiki/ES2022 "ECMAScript 2022") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 18 || 20 || 21 with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
- `pluginclerk/edition-types/index.d.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled Types with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
- `pluginclerk/edition-deno/index.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") source code made to be compatible with [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative to Node.js")
## History
[Discover the release history by heading on over to the `HISTORY.md` file.](https://github.com/bevry/pluginclerk/blob/HEAD/HISTORY.md#files)
## Backers
### Code
[Discover how to contribute via the `CONTRIBUTING.md` file.](https://github.com/bevry/pluginclerk/blob/HEAD/CONTRIBUTING.md#files)
#### Authors
- 2015+ [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.
#### Maintainers
- [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.
#### Contributors
- [Benjamin Lupton](https://github.com/balupton) — [view contributions](https://github.com/bevry/pluginclerk/commits?author=balupton "View the GitHub contributions of Benjamin Lupton on repository bevry/pluginclerk")
### Finances
#### Sponsors
- [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher
- [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders.
- [Codecov](https://codecov.io) — Empower developers with tools to improve code quality and testing.
- [Poonacha Medappa](https://poonachamedappa.com)
- [Rob Morris](https://github.com/Rob-Morris)
- [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games.
- [Syntax](https://syntax.fm) — Syntax Podcast
#### Donors
- [Andrew Nesbitt](https://nesbitt.io)
- [Armen Mkrtchian](https://mogoni.dev)
- [Balsa](https://balsa.com)
- [Chad](https://opencollective.com/chad8)
- [Codecov](https://codecov.io)
- [dr.dimitru](https://veliovgroup.com)
- [Elliott Ditman](https://elliottditman.com)
- [entroniq](https://gitlab.com/entroniq)
- [GitHub](https://github.com/about)
- [Hunter Beast](https://cryptoquick.com)
- [Jean-Luc Geering](https://github.com/jlgeering)
- [Michael Duane Mooring](https://mdm.cc)
- [Michael Harry Scepaniak](https://michaelscepaniak.com)
- [Mohammed Shah](https://github.com/smashah)
- [Mr. Henry](https://mrhenry.be)
- [Nermal](https://arjunaditya.vercel.app)
- [Pleo](https://pleo.io)
- [Poonacha Medappa](https://poonachamedappa.com)
- [Rob Morris](https://github.com/Rob-Morris)
- [Robert de Forest](https://github.com/rdeforest)
- [Sentry](https://sentry.io)
- [ServieJS](https://github.com/serviejs)
- [Skunk Team](https://skunk.team)
- [Syntax](https://syntax.fm)
- [WriterJohnBuck](https://github.com/WriterJohnBuck)
## License
Unless stated otherwise all works are:
- Copyright © 2015+ [Benjamin Lupton](https://balupton.com)
and licensed under:
- [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)