pluginclerk
Advanced tools
A clerk for retrieving compatible plugins from the npm database
npm install --save pluginclerkrequire('pluginclerk')npm install --save pluginclerkrequire('pluginclerk')//wzrd.in/bundle/pluginclerk@1.1.0ender add pluginclerkrequire('pluginclerk')This package is published with the following editions:
pluginclerk aliases pluginclerk/index.js which uses Editions to automatically select the correct edition for the consumers environmentpluginclerk/source/index.js is Source + ESNext + Requirepluginclerk/es2015/index.js is Babel Compiled + ES2015 + RequireOlder environments may need Babel's Polyfill or something similar.
const clerk = require('pluginclerk').create({
// 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 URL of the npm registry's byKeyword view that we should use for fetching the plugins
// Defaults to http://skimdb.npmjs.com/registry/_design/app/_view/byKeyword
registryKeywordUrl: 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'}, function (err, result) {
/* result will be an object like {
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', dependencies: {docpad: '6.78.0'}}, function (err, result) {
/* result will be an object like {
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', dependencies: {docpad: '5.0.0'}}, function (err, result) {
/* result will be an object like {
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({}, function (err, result) {
/* result will be an object like {
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({dependencies: {docpad: '5.0.0'}}, function (err, result) {
/* result will be an object like {
success: true,
message: 'Successfully fetched the plugins',
plugins: {
'docpad-plugin-eco': {
'description': '...',
'homepage': '...',
'version': '1.0.0',
'compatibility': {} // result of fetchPlugin
}
}
} */
})
Discover the release history by heading on over to the HISTORY.md file.
Discover how you can contribute by heading on over to the CONTRIBUTING.md file.
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:
Discover how you can contribute by heading on over to the CONTRIBUTING.md file.
Unless stated otherwise all works are:
and licensed under:
v1.1.0 2016 May 27
FAQs
A clerk for retrieving compatible plugins from the npm database
The npm package pluginclerk receives a total of 16 weekly downloads. As such, pluginclerk popularity was classified as not popular.
We found that pluginclerk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.