https://github.com/bevry-archive/plugin-engine
Deprecated. Use https://github.com/bevry/pluginloader
https://github.com/bevry-archive/plugin-engine
plugin-system todo
Last synced: 9 months ago
JSON representation
Deprecated. Use https://github.com/bevry/pluginloader
- Host: GitHub
- URL: https://github.com/bevry-archive/plugin-engine
- Owner: bevry-archive
- License: mit
- Created: 2013-01-23T06:47:01.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2019-01-01T10:48:54.000Z (over 7 years ago)
- Last Synced: 2025-06-01T18:39:00.089Z (10 months ago)
- Topics: plugin-system, todo
- Language: CoffeeScript
- Homepage:
- Size: 6.84 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Plugin Engine
Currently under construction. The goal is to have an API like:
``` coffee
# Import
{PluginEngine} = require('plugin-engine')
# Create Plugin Engine Instance
pluginEngine = new PluginEngine({
# Where to load plugins from?
modulesPaths: [__dirname+'/node_modules']
# Loaded plugins must have this tag in their package.json file
tag: 'docpad-plugin'
# Ensure the plugin supports these engines
engines:
'docpad': '6.22.0'
# Pass these options over to our plugins during instantiation
instantiationOpts:
BasePlugin: require(__dirname+'/out/base-plugin')
}).loadPlugins()
```
With an example plugin looking like:
```
module.exports = (instantiationOpts) ->
{BasePlugin} = instantiationOpts
class Plugin extends BasePlugin
```
Things to still figure out:
1. How to handle plugin and parent events
1. How to expose the parent object to the plugins
1. Priorities for events
## History
[You can discover the history inside the `History.md` file](https://github.com/bevry/plugin-system/blob/master/History.md#files)
## License
Licensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT License](http://creativecommons.org/licenses/MIT/)
Copyright © 2012+ [Bevry Pty Ltd](http://bevry.me)
Copyright © 2011 [Benjamin Lupton](http://balupton.com)