https://github.com/bevry/pluginloader
A class for loading, verifying, and creating plugins. Used by DocPad for years.
https://github.com/bevry/pluginloader
nodejs plugin-loader plugin-manager plugin-system
Last synced: 3 months ago
JSON representation
A class for loading, verifying, and creating plugins. Used by DocPad for years.
- Host: GitHub
- URL: https://github.com/bevry/pluginloader
- Owner: bevry
- License: other
- Created: 2018-09-03T17:54:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-12T16:08:16.000Z (about 1 year ago)
- Last Synced: 2024-10-30T00:55:57.027Z (about 1 year ago)
- Topics: nodejs, plugin-loader, plugin-manager, plugin-system
- Language: TypeScript
- Size: 641 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
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
# @bevry/pluginloader
A class for loading, verifying, and creating plugins. Used by DocPad for years.
## Usage
[Complete API Documentation.](http://master.pluginloader.bevry.surge.sh/docs/)
### Basics
Create your project:
1. `mkdir my-project`
1. `cd my-project`
Create your plugin:
1. `mkdir myplugin`
1. `cd myplugin`
1. `npm init`
1. `index.js` to:
```javascript
module.exports = function (BasePlugin) {
return class MyPlugin extends BasePlugin {
constructor(...args) {
super(...args)
console.log('hello from my plugin')
}
}
}
```
1. `cd ..`
Create your plugin loader:
1. `mkdir myapp`
1. `cd myapp`
1. `npm init`
1. `index.js` to:
```javascript
import PluginLoader from '@bevry/pluginloader'
class BasePlugin {
constructor() {
console.log('hello from base plugin')
}
}
const pluginLoader = new PluginLoader({
BasePlugin,
pluginPath: require('path').resolve(__dirname, '..', 'myplugin'),
})
```
1. `cd ..`
Run the project:
1. `node myapp/index.js`
### Ecosystem
- [pluginclerk](https://github.com/bevry/pluginclerk) a project for fetching compatible plugins from the npm registry
- [docpad-baseplugin](https://github.com/docpad/docpad-baseplugin) the BasePlugin class that DocPad uses
- [docpad-plugintester](https://github.com/docpad/docpad-plugintester) testing helpers for DocPad plugins
## Install
### [npm](https://npmjs.com "npm is a package manager for javascript")
- Install: `npm install --save @bevry/pluginloader`
- Import: `import * as pkg from ('@bevry/pluginloader')`
- Require: `const pkg = require('@bevry/pluginloader')`
### [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative for Node.js")
``` typescript
import * as pkg from 'https://unpkg.com/@bevry/pluginloader@^5.3.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:
- `@bevry/pluginloader` aliases `@bevry/pluginloader/index.cjs` which uses the [Editions Autoloader](https://github.com/bevry/editions "You can use the Editions Autoloader to autoload the appropriate edition for your consumers environment") to automatically select the correct edition for the consumer's environment
- `@bevry/pluginloader/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
- `@bevry/pluginloader/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") 12 || 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules
- `@bevry/pluginloader/edition-es2016/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2016](https://en.wikipedia.org/wiki/ES2016 "ECMAScript 2016") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules
- `@bevry/pluginloader/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
## History
[Discover the release history by heading on over to the `HISTORY.md` file.](https://github.com/bevry/pluginloader/blob/HEAD/HISTORY.md#files)
## Backers
### Code
[Discover how to contribute via the `CONTRIBUTING.md` file.](https://github.com/bevry/pluginloader/blob/HEAD/CONTRIBUTING.md#files)
#### Authors
- [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/pluginloader/commits?author=balupton "View the GitHub contributions of Benjamin Lupton on repository bevry/pluginloader")
### 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 © [Benjamin Lupton](https://balupton.com)
and licensed under:
- [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)